kieker.analysis.plugin.filter.forward

Class AnalysisThroughputFilter

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.filter.AbstractFilterPlugin

kieker.analysis.plugin.filter.forward.AnalysisThroughputFilter

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin

public class AnalysisThroughputFilter
extends AbstractFilterPlugin

An instance of this class computes the throughput in terms of the number of objects received per time unit.

Since:

1.8

Author:

Jan Waller

Nested Class Summary

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

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INPUT_PORT_NAME_OBJECTS The name of the input port receiving other objects.
static java.lang.String	INPUT_PORT_NAME_TIME The name of the input port receiving timestamps.
static java.lang.String	OUTPUT_PORT_NAME_RELAYED_OBJECTS The name of the output port delivering the received objects.
static java.lang.String	OUTPUT_PORT_NAME_THROUGHPUT The name of the output port delivering the received objects.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, log, LOG, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors

Constructor and Description
AnalysisThroughputFilter(Configuration configuration, IProjectContext projectContext)

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
void	inputObjects(java.lang.Object object)
void	inputTime(java.lang.Long timestamp)
PlainText	plainTextDisplay()

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

init, terminate

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, deliver, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getDefaultConfiguration, getIncomingPlugins, getPluginDescription, getPluginName, getRepository, getState, isConnectionAllowed, notifyNewIncomingConnection, notifyNewOutgoingConnection, shutdown, start

Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface kieker.analysis.plugin.IPlugin

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

Field Detail

INPUT_PORT_NAME_OBJECTS

public static final java.lang.String INPUT_PORT_NAME_OBJECTS

The name of the input port receiving other objects.

See Also:

Constant Field Values

INPUT_PORT_NAME_TIME

public static final java.lang.String INPUT_PORT_NAME_TIME

The name of the input port receiving timestamps.

See Also:

Constant Field Values

OUTPUT_PORT_NAME_RELAYED_OBJECTS

public static final java.lang.String OUTPUT_PORT_NAME_RELAYED_OBJECTS

The name of the output port delivering the received objects.

See Also:

Constant Field Values

OUTPUT_PORT_NAME_THROUGHPUT

public static final java.lang.String OUTPUT_PORT_NAME_THROUGHPUT

The name of the output port delivering the received objects.

See Also:

Constant Field Values

Constructor Detail

AnalysisThroughputFilter

public AnalysisThroughputFilter(Configuration configuration,
                        IProjectContext projectContext)

Method Detail

getCurrentConfiguration

public Configuration getCurrentConfiguration()

Description copied from class: AbstractAnalysisComponent

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.

Specified by:

getCurrentConfiguration in interface IAnalysisComponent

Specified by:

getCurrentConfiguration in interface IPlugin

Specified by:

getCurrentConfiguration in class AbstractAnalysisComponent

Returns:

A completely filled configuration object.

inputObjects

public final void inputObjects(java.lang.Object object)

inputTime

public final void inputTime(java.lang.Long timestamp)

plainTextDisplay

public final PlainText plainTextDisplay()