etm.core.aggregation
Class NotifyingAggregator

java.lang.Object
  etm.core.aggregation.NotifyingAggregator

All Implemented Interfaces:

Aggregator

public class NotifyingAggregator
extends java.lang.Object
implements Aggregator

An aggregator that creates CollectEvents for every new collected EtmPoint. Always use in conjunction with a buffering aggregator such as BufferedThresholdAggregator or BufferedTimedAggregator. We recommend using the interval based BufferedTimedAggregator.

Since:

1.2.0

Version:

$Revision: 170 $

Author:

void.fm

Constructor Summary

NotifyingAggregator(Aggregator aDelegate)

Method Summary

void	add(EtmPoint point) Adds a new EtmPoint to the aggregator.
void	flush() Flushes the current aggregation details.
AggregatorMetaData	getMetaData() Returns detailed information about the aggregator chain.
void	init(EtmMonitorContext aCtx) Lifecycle Method, will be called before Aggregator.start(), after initalization of the current EtmMonitor runtime.
void	render(MeasurementRenderer renderer) Renders the current state of the aggregator using the provided renderer instance.
void	reset() Resets the internal aggregator state.
void	reset(java.lang.String symbolicName) Resets the internal aggregator state for a etm point.
void	setFilterPattern(java.lang.String pattern)
void	setRootOnly(boolean aRootOnly) If rootOnly is enabled, only measurement roots will create an event.
void	start() Lifecycle method, will be called after all Aggregator instances are initialized by calling Aggregator.init(etm.core.monitor.EtmMonitorContext) and before the EtmMonitor instance will becomes available.
void	stop() Lifecycle method, will be called after the EtmMonitor instance was shutdown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotifyingAggregator

public NotifyingAggregator(Aggregator aDelegate)

Method Detail

setRootOnly

public void setRootOnly(boolean aRootOnly)

If rootOnly is enabled, only measurement roots will create an event.

Parameters:

aRootOnly - True to notify on root collections only. Default is false.

setFilterPattern

public void setFilterPattern(java.lang.String pattern)

add

public void add(EtmPoint point)

Description copied from interface: Aggregator

Adds a new EtmPoint to the aggregator.

Specified by:

add in interface Aggregator

Parameters:

point - A new collected EtmPoint.

flush

public void flush()

Description copied from interface: Aggregator

Flushes the current aggregation details. Buffering Aggragetors should clean up their process buffer.

Specified by:

flush in interface Aggregator

reset

public void reset()

Description copied from interface: Aggregator

Resets the internal aggregator state. Persistent states usually aren't affected.

Specified by:

reset in interface Aggregator

reset

public void reset(java.lang.String symbolicName)

Description copied from interface: Aggregator

Resets the internal aggregator state for a etm point. Persistent states usually aren't affected.

Specified by:

reset in interface Aggregator

Parameters:

symbolicName - The name of the etm point to be resetted.

render

public void render(MeasurementRenderer renderer)

Description copied from interface: Aggregator

Renders the current state of the aggregator using the provided renderer instance.

Specified by:

render in interface Aggregator

Parameters:

renderer - The renderer.

getMetaData

public AggregatorMetaData getMetaData()

Description copied from interface: Aggregator

Returns detailed information about the aggregator chain.

Specified by:

getMetaData in interface Aggregator

Returns:

The AggregatorMetaData.

init

public void init(EtmMonitorContext aCtx)

Description copied from interface: Aggregator

Lifecycle Method, will be called before Aggregator.start(), after initalization of the current EtmMonitor runtime. Be aware that Plugins are instantiated, but not started at this point.

Specified by:

init in interface Aggregator

Parameters:

aCtx - The current EtmMonitor Context.

start

public void start()

Description copied from interface: Aggregator

Lifecycle method, will be called after all Aggregator instances are initialized by calling Aggregator.init(etm.core.monitor.EtmMonitorContext) and before the EtmMonitor instance will becomes available.

Specified by:

start in interface Aggregator

stop

public void stop()

Description copied from interface: Aggregator

Lifecycle method, will be called after the EtmMonitor instance was shutdown.

Specified by:

stop in interface Aggregator