KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > instrument > manager > AbstractValueInstrumentSample


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;
51
52 import org.apache.avalon.framework.configuration.Configuration;
53 import org.apache.avalon.framework.configuration.ConfigurationException;
54 import org.apache.avalon.framework.configuration.DefaultConfiguration;
55 import org.apache.excalibur.instrument.manager.interfaces.InstrumentManagerClient;
56
57 /**
58  * An AbstractValueInstrumentSample contains all of the functionality common
59  * to all InstrumentSamples which represent a fixed value.
60  *
61  * @author <a HREF="mailto:leif@tanukisoftware.com">Leif Mortenson</a>
62  * @version CVS $Revision: 1.3 $ $Date: 2003/02/25 16:28:16 $
63  * @since 4.1
64  */
65 abstract class AbstractValueInstrumentSample
66     extends AbstractInstrumentSample
67     implements ValueInstrumentListener
68 {
69     /** The sample value. */
70     protected int m_value;
71     
72     /** The number of times that the value has been changed in this sample period. */
73     protected int m_valueCount;
74     
75     /*---------------------------------------------------------------
76      * Constructors
77      *-------------------------------------------------------------*/
78     /**
79      * Creates a new AbstractValueInstrumentSample
80      *
81      * @param instrumentProxy The InstrumentProxy which owns the
82      * InstrumentSample.
83      * @param name The name of the new InstrumentSample.
84      * @param interval The sample interval of the new InstrumentSample.
85      * @param size The number of samples to store as history. Assumes that size is at least 1.
86      * @param description The description of the new InstrumentSample.
87      * @param lease The length of the lease in milliseconds.
88      */
89     protected AbstractValueInstrumentSample( InstrumentProxy instrumentProxy,
90                                              String JavaDoc name,
91                                              long interval,
92                                              int size,
93                                              String JavaDoc description,
94                                              long lease )
95     {
96         super( instrumentProxy, name, interval, size, description, lease );
97         
98         // Set the current value to 0 initially.
99 m_value = 0;
100     }
101     
102     /*---------------------------------------------------------------
103      * InstrumentSample Methods
104      *-------------------------------------------------------------*/
105     /**
106      * Returns the Type of the Instrument which can use the sample. This
107      * should be the same for all instances of a class.
108      * <p>
109      * This InstrumentSample returns InstrumentManager.PROFILE_POINT_TYPE_VALUE
110      *
111      * @return The Type of the Instrument which can use the sample.
112      */
113     public final int getInstrumentType()
114     {
115         return InstrumentManagerClient.INSTRUMENT_TYPE_VALUE;
116     }
117     
118     /**
119      * Obtain the value of the sample. All samples are integers, so the profiled
120      * objects must measure quantity (numbers of items), rate (items/period), time in
121      * milliseconds, etc.
122      * <p>
123      * Should only be called when synchronized.
124      *
125      * @return The sample value.
126      */
127     public int getValueInner()
128     {
129         return m_value;
130     }
131
132     /*---------------------------------------------------------------
133      * AbstractInstrumentSample Methods
134      *-------------------------------------------------------------*/
135     /**
136      * Allow subclasses to add information into the saved state.
137      *
138      * @param state State configuration.
139      */
140     protected void saveState( DefaultConfiguration state )
141     {
142         super.saveState( state );
143         
144         state.setAttribute( "value-count", Integer.toString( m_valueCount ) );
145     }
146     
147     /**
148      * Used to load the state, called from AbstractInstrumentSample.loadState();
149      * <p>
150      * Should only be called when synchronized.
151      *
152      * @param value Current value loaded from the state.
153      * @param state Configuration object to load state from.
154      *
155      * @throws ConfigurationException If there were any problems loading the
156      * state.
157      */
158     protected void loadState( int value, Configuration state )
159         throws ConfigurationException
160     {
161         m_value = value;
162         m_valueCount = state.getAttributeAsInteger( "value-count" );
163     }
164     
165     /**
166      * Called after a state is loaded if the sample period is not the same
167      * as the last period saved.
168      */
169     protected void postSaveNeedsReset()
170     {
171         m_value = 0;
172         m_valueCount = 0;
173     }
174     
175     /*---------------------------------------------------------------
176      * ValueInstrumentListener Methods
177      *-------------------------------------------------------------*/
178     /**
179      * Called by a ValueInstrument whenever its value is set.
180      *
181      * @param instrumentName The key of Instrument whose value was set.
182      * @param value Value that was set.
183      * @param time The time that the Instrument was incremented.
184      *
185      * ValueInstrument
186      */
187     public void setValue( String JavaDoc instrumentName, int value, long time )
188     {
189         //System.out.println("AbstractValueInstrumentSample.setValue(" + instrumentName + ", "
190 // + value + ", " + time + ") : " + getName());
191 setValueInner( value, time );
192     }
193     
194     
195     /*---------------------------------------------------------------
196      * Methods
197      *-------------------------------------------------------------*/
198     /**
199      * Sets the current value of the sample.
200      *
201      * @param value New sample value.
202      * @param time Time that the new sample arrives.
203      */
204     protected abstract void setValueInner( int value, long time );
205 }
206
Popular Tags