kieker.tools.trace.analysis.filter

Class AbstractTraceProcessingFilter

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.filter.AbstractFilterPlugin

kieker.tools.trace.analysis.filter.AbstractTraceAnalysisFilter

kieker.tools.trace.analysis.filter.AbstractTraceProcessingFilter

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin

Direct Known Subclasses:

AbstractExecutionTraceProcessingFilter, AbstractInvalidExecutionTraceProcessingFilter, AbstractMessageTraceProcessingFilter, EventRecordTraceCounter, TraceEventRecords2ExecutionAndMessageTraceFilter, TraceReconstructionFilter

public abstract class AbstractTraceProcessingFilter
extends AbstractTraceAnalysisFilter

This is an abstract base for filters processing traces.

Since:

1.1

Author:

Andre van Hoorn

Nested Class Summary

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

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

Fields inherited from class kieker.tools.trace.analysis.filter.AbstractTraceAnalysisFilter

CONFIG_PROPERTY_VALUE_VERBOSE, LOGGER, REPOSITORY_PORT_NAME_SYSTEM_MODEL

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors

Constructor and Description
AbstractTraceProcessingFilter(Configuration configuration, IProjectContext projectContext) Creates a new instance of this class using the given parameters.

Method Summary

Modifier and Type	Method and Description
int	getErrorCount() Delivers the number of traces which have not been processed successfully.
long	getLastTraceIdError() Delivers the ID of the last trace which has not been processed successfully.
long	getLastTraceIdSuccess() Delivers the ID of the last trace which has been processed successfully.
int	getSuccessCount() Delivers the number of traces which have been processed successfully.
int	getTotalCount() Delivers the total number of traces which have been processed.
void	printStatusMessage() Returns a user-addressed status message to be logged by the calling tool.
protected void	reportError(long traceId) This method can be used to report a trace which has not been processed successfully.
protected void	reportSuccess(long traceId) This method can be used to report a trace which has been processed successfully.

Methods inherited from class kieker.tools.trace.analysis.filter.AbstractTraceAnalysisFilter

createExecutionByEntityNames, createExecutionByEntityNames, createExecutionByEntityNames, createExecutionByEntityNames, getCurrentConfiguration, getSystemEntityFactory, printDebugLogMessage, printErrorLogMessage

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

Constructor Detail

AbstractTraceProcessingFilter

public AbstractTraceProcessingFilter(Configuration configuration,
                                     IProjectContext projectContext)

Creates a new instance of this class using the given parameters.

Parameters:

configuration - The configuration for this component.

projectContext - The project context for this component.

Method Detail

reportSuccess

protected final void reportSuccess(long traceId)

This method can be used to report a trace which has been processed successfully.

Parameters:

traceId - The ID of the processed trace.

reportError

protected final void reportError(long traceId)

This method can be used to report a trace which has not been processed successfully.

Parameters:

traceId - The ID of the processed trace.

getSuccessCount

public final int getSuccessCount()

Delivers the number of traces which have been processed successfully.

Returns:

The number of traces.

getErrorCount

public final int getErrorCount()

Delivers the number of traces which have not been processed successfully.

Returns:

The number of traces.

getTotalCount

public final int getTotalCount()

Delivers the total number of traces which have been processed.

Returns:

The number of traces.

getLastTraceIdError

public final long getLastTraceIdError()

Delivers the ID of the last trace which has not been processed successfully.

Returns:

The trace ID.

getLastTraceIdSuccess

public final long getLastTraceIdSuccess()

Delivers the ID of the last trace which has been processed successfully.

Returns:

The trace ID.

printStatusMessage

public void printStatusMessage()

Returns a user-addressed status message to be logged by the calling tool. Extending classes may override this method but should call the then-inherited method first.