mx4j.tools.stats

Interface StatisticsRecorderMBean

public interface StatisticsRecorderMBean

Management interface to be implemented by recorder MBeans. RecorderMBeans store a value and also keep statistics about the given value. Different implementations can determine how to acquire and calculate the value.

The MBean doesn't starts automatically. It has to wait for a StatisticsRecorderMBean call

Version: $Revision: 1.4 $

See Also: PointTime

Method Summary
NumbergetAverage()
Returns the Average Value
SortedMapgetEntries()
Returs a sorted map of the recorded values indexed by PointTime
NumbergetMax()
Returns the Maximum Value
intgetMaxEntries()
Returns how many entries may be recorded.
NumbergetMin()
Returns the Minimum Value
DategetRecordingStart()
Returns the date when it started recording
booleanisActive()
Indicates whether the MBean is recording values
voidsetMaxEntries(int maxEntries)
Sets the maximum entries stored in this recorder
voidstart()
Starts recording a variable
voidstop()
Stops recording a variable

Method Detail

getAverage

public Number getAverage()
Returns the Average Value

getEntries

public SortedMap getEntries()
Returs a sorted map of the recorded values indexed by PointTime

getMax

public Number getMax()
Returns the Maximum Value

getMaxEntries

public int getMaxEntries()
Returns how many entries may be recorded. When the maximum amount is reached the default behaviour is to forget the oldest one

getMin

public Number getMin()
Returns the Minimum Value

getRecordingStart

public Date getRecordingStart()
Returns the date when it started recording

isActive

public boolean isActive()
Indicates whether the MBean is recording values

setMaxEntries

public void setMaxEntries(int maxEntries)
Sets the maximum entries stored in this recorder

start

public void start()
Starts recording a variable

stop

public void stop()
Stops recording a variable
Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.