KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > interfaces > InstrumentSampleUtils


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.excalibur.instrument.manager.interfaces;
51
52 import org.apache.avalon.framework.configuration.ConfigurationException;
53
54 /**
55  * A series of methods which are useful when working with InstrumentSamples.
56  * These methods can be used on the server as well as the client.
57  *
58  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
59  * @version CVS $Revision: 1.3 $ $Date: 2003/02/20 17:08:19 $
60  * @since 4.1
61  */
62 public class InstrumentSampleUtils
63 {
64     /**
65      * Resolves an instrument sample type based on a name.
66      *
67      * @param type Type of the InstrumentSample to resolve. Accepted values are:
68      * "max", "maximum", "min", "minimum", "mean",
69      * "ctr", and "counter".
70      *
71      * @throws ConfigurationException if the specified sample type is unknown.
72      */
73     public static int resolveInstrumentSampleType( String JavaDoc type )
74         throws ConfigurationException {
75         
76         if ( type.equalsIgnoreCase( "max" ) || type.equalsIgnoreCase( "maximum" ) )
77         {
78             return InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM;
79         }
80         else if ( type.equalsIgnoreCase( "min" ) || type.equalsIgnoreCase( "minimum" ) )
81         {
82             return InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM;
83         }
84         else if ( type.equalsIgnoreCase( "mean" ) )
85         {
86             return InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN;
87         }
88         else if ( type.equalsIgnoreCase( "ctr" ) || type.equalsIgnoreCase( "counter" ) )
89         {
90             return InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER;
91         }
92         else
93         {
94             throw new ConfigurationException( "'" + type + "' is not a valid sample type." );
95         }
96     }
97     
98     public static String JavaDoc getInstrumentSampleTypeName( int type )
99     {
100         switch ( type )
101         {
102         case InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM:
103             return "maximum";
104             
105         case InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM:
106             return "minimum";
107         
108         case InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN:
109             return "mean";
110             
111         case InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER:
112             return "counter";
113             
114         default:
115             return "unknown-" + type;
116         }
117     }
118     
119     /**
120      * Generates a sample name given its parameters.
121      *
122      * @param sampleType Type of the sample.
123      * @param sampleInterval Interval of the sample.
124      * @param sampleSize Size of the sample.
125      *
126      * @return A sample name.
127      */
128     public static String JavaDoc generateInstrumentSampleName( int sampleType,
129                                                        long sampleInterval,
130                                                        int sampleSize )
131     {
132         return getInstrumentSampleTypeName( sampleType ) + "_" +
133             sampleInterval + "_" + sampleSize;
134     }
135     
136     /**
137      * Generates a fully qualified sample name given its parameters.
138      *
139      * @param instrumentName Name of the instrument which owns the sample.
140      * @param sampleType Type of the sample.
141      * @param sampleInterval Interval of the sample.
142      * @param sampleSize Size of the sample.
143      *
144      * @return A fully qualified sample name.
145      */
146     public static String JavaDoc generateFullInstrumentSampleName( String JavaDoc instrumentName,
147                                                            int sampleType,
148                                                            long sampleInterval,
149                                                            int sampleSize )
150     {
151         return instrumentName + "." +
152             generateInstrumentSampleName( sampleType, sampleInterval, sampleSize );
153     }
154 }
155
Popular Tags