etm.core.monitor
Interface EtmMonitor

All Known Implementing Classes:
EtmMonitorSupport, FlatMonitor, NestedMonitor, NullMonitor

public interface EtmMonitor

An EtmMonitor is responsible for collecting and aggregating Measurements Point information. Currently JETM provides three different EtmMonitor types: The FlatMonitor for flat collection, the NestedMonitor for nested collection and the NullMonitor for no collection at all. See EtmPoint for EtmMonitor usage.

EtmMonitor implementations have to provide at least one of the following constructors

Version:
$Revision: 112 $
Author:
void.fm
See Also:
EtmPoint

Method Summary
 void addPlugin(EtmPlugin aEtmPlugin)
          Adds a new plugin which is part of the EtmMonitor lifecycle.
 void aggregate()
          Aggregates the current measurement details.
 EtmPoint createPoint(java.lang.String symbolicName)
          Creates a new EtmPoint with the given name.
 void disableCollection()
          Disables result collection.
 void enableCollection()
          Enables result collection.
 EtmMonitorMetaData getMetaData()
          Returns metadata for the monitor.
 boolean isCollecting()
          Returns whether the given monitor instance is collecting results right now.
 boolean isStarted()
          Returns wether the monitor is started or not.
 void render(MeasurementRenderer renderer)
          Renders the current measurement results.
 void reset()
          Resets all available measurements.
 void reset(java.lang.String symbolicName)
          Resets a specific measurement.
 void setPlugins(java.util.List plugins)
          Adds a list of plugins.
 void start()
          Starts the EtmMonitor.
 void stop()
          Stops the EtmMonitor.
 

Method Detail

createPoint

EtmPoint createPoint(java.lang.String symbolicName)
Creates a new EtmPoint with the given name. The name may be null until EtmMonitor#collect is called.

Parameters:
symbolicName - The symbolic name or null. Ensure to call EtmPoint.alterName(String) before collection if symbolic name was null.
Returns:
A new EtmMpoint
Since:
1.2.0

aggregate

void aggregate()
Aggregates the current measurement details.


render

void render(MeasurementRenderer renderer)
Renders the current measurement results.

Parameters:
renderer - A measurement renderer.

reset

void reset()
Resets all available measurements.


reset

void reset(java.lang.String symbolicName)
Resets a specific measurement.

Parameters:
symbolicName - The symbolic name of the measurement to reset.

getMetaData

EtmMonitorMetaData getMetaData()
Returns metadata for the monitor.

Returns:
The monitor meta data.

start

void start()
Starts the EtmMonitor.


stop

void stop()
Stops the EtmMonitor.


isStarted

boolean isStarted()
Returns wether the monitor is started or not.

Returns:
True if started, otherwhise false.

enableCollection

void enableCollection()
Enables result collection.


disableCollection

void disableCollection()
Disables result collection.


isCollecting

boolean isCollecting()
Returns whether the given monitor instance is collecting results right now.

Returns:
True for enabled collection, otherwhise false.

addPlugin

void addPlugin(EtmPlugin aEtmPlugin)
Adds a new plugin which is part of the EtmMonitor lifecycle.

Parameters:
aEtmPlugin - The new EtmPlugin.

setPlugins

void setPlugins(java.util.List plugins)
Adds a list of plugins.

Parameters:
plugins - A list of EtmPlugin.
Since:
1.2.0


Copyright © 2004,2005, 2006, 2007 void.fm. All Rights Reserved.