kieker.analysis.plugin.filter.forward
Class CountingFilter

java.lang.Object
  kieker.analysis.plugin.AbstractPlugin
      kieker.analysis.plugin.filter.AbstractFilterPlugin
          kieker.analysis.plugin.filter.forward.CountingFilter

All Implemented Interfaces:

IFilterPlugin, IPlugin

public final class CountingFilter
extends AbstractFilterPlugin

An instance of this class receives any objects, increments an intern tread-safe counter without printing any message and delivers the unchanged objects to the output. The value of the counter can be retrieved by connected to the respective output port using a corresponding method.

Author:

Jan Waller

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

static String	INPUT_PORT_NAME_EVENTS
static String	OUTPUT_PORT_NAME_COUNT
static String	OUTPUT_PORT_NAME_RELAYED_EVENTS

Fields inherited from class kieker.analysis.plugin.AbstractPlugin

CONFIG_NAME

Constructor Summary

CountingFilter(Configuration configuration)
Constructs a CountingFilter.

Method Summary

void	countDisplay(PlainText plainText) This method is being used to display the currently stored value within this counter.
Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
long	getMessageCount() Returns the number of objects received until now.
void	inputEvent(Object event)

Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin

init, terminate

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getIncomingPlugins, getName, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface kieker.analysis.plugin.IPlugin

connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState

Field Detail

INPUT_PORT_NAME_EVENTS

public static final String INPUT_PORT_NAME_EVENTS

See Also:

Constant Field Values

OUTPUT_PORT_NAME_RELAYED_EVENTS

public static final String OUTPUT_PORT_NAME_RELAYED_EVENTS

See Also:

Constant Field Values

OUTPUT_PORT_NAME_COUNT

public static final String OUTPUT_PORT_NAME_COUNT

See Also:

Constant Field Values

Constructor Detail

CountingFilter

public CountingFilter(Configuration configuration)

Constructs a CountingFilter.

Method Detail

getCurrentConfiguration

public final Configuration getCurrentConfiguration()

Description copied from interface: IPlugin

This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.

Returns:

A completely filled configuration object.

getMessageCount

public final long getMessageCount()

Returns the number of objects received until now.

inputEvent

public final void inputEvent(Object event)

countDisplay

public final void countDisplay(PlainText plainText)

This method is being used to display the currently stored value within this counter. It sets the current text within the given instance of PlainText.