mx4j.tools.stats

Interface StatisticsRecorderMBean

Known Subinterfaces:
ObserverStatisticsRecorderMBean, TimedStatisticsRecorderMBean, ValueStatisticsRecorderMBean
Known Implementing Classes:
AbstractStatisticsRecorder, NotificationStatisticsRecorder, ObserverStatisticsRecorder, TimedStatisticsRecorder, ValueStatisticsRecorder

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 start() call

Version:
$Revision: 1.4 $

See Also:
PointTime

Method Summary

Number
getAverage()
Returns the Average Value
SortedMap
getEntries()
Returs a sorted map of the recorded values indexed by PointTime
Number
getMax()
Returns the Maximum Value
int
getMaxEntries()
Returns how many entries may be recorded.
Number
getMin()
Returns the Minimum Value
Date
getRecordingStart()
Returns the date when it started recording
boolean
isActive()
Indicates whether the MBean is recording values
void
setMaxEntries(int maxEntries)
Sets the maximum entries stored in this recorder
void
start()
Starts recording a variable
void
stop()
Stops recording a variable

Method Details

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-2003 MX4J Team. All Rights Reserved.