kieker.tools.traceAnalysis.filter

Class AbstractGraphProducingFilter<G extends AbstractGraph<?,?,?>>

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.filter.AbstractFilterPlugin

kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter

kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter

kieker.tools.traceAnalysis.filter.AbstractMessageTraceProcessingFilter

kieker.tools.traceAnalysis.filter.AbstractGraphProducingFilter<G>

Type Parameters:

G - The graph type created by this filter

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin, IGraphOutputtingFilter<G>, IGraphProducingFilter<G>

Direct Known Subclasses:

AbstractDependencyGraphFilter

public abstract class AbstractGraphProducingFilter<G extends AbstractGraph<?,?,?>>
extends AbstractMessageTraceProcessingFilter
implements IGraphProducingFilter<G>

Abstract superclass for graph-producing filters.

Since:

1.6

Author:

Holger Knoche

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.traceAnalysis.filter.AbstractMessageTraceProcessingFilter

INPUT_PORT_NAME_MESSAGE_TRACES

Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter

CONFIG_PROPERTY_VALUE_VERBOSE, LOG, REPOSITORY_PORT_NAME_SYSTEM_MODEL

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, log, projectContext, recordsTimeUnitFromProjectContext

Fields inherited from interface kieker.tools.traceAnalysis.filter.IGraphOutputtingFilter

OUTPUT_PORT_NAME_GRAPH

Constructor Summary

Constructors

Constructor and Description
AbstractGraphProducingFilter(Configuration configuration, IProjectContext projectContext, G graph) Creates a new graph-producing filter using the given configuration and the given graph.

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getConfigurationName() Returns this filter's configuration name.
protected G	getGraph() Delivers the graph stored in this filter.
java.lang.String	getGraphOutputPortName() Returns the name of the port this filter uses to emit the graph.
protected IOriginRetentionPolicy	getOriginRetentionPolicy()
protected <T> void	handleOrigin(AbstractGraphElement<T> element, T origin)
void	requestOriginRetentionPolicy(IOriginRetentionPolicy policy) Requests that the given retention policy is used by this graph producer.
void	terminate(boolean error) Initiates a termination of the plugin.

Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractMessageTraceProcessingFilter

inputMessageTraces

Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter

getErrorCount, getLastTraceIdError, getLastTraceIdSuccess, getSuccessCount, getTotalCount, printStatusMessage, reportError, reportSuccess

Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter

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

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

init

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

AbstractGraphProducingFilter

public AbstractGraphProducingFilter(Configuration configuration,
                            IProjectContext projectContext,
                            G graph)

Creates a new graph-producing filter using the given configuration and the given graph.

Parameters:

configuration - The configuration to use

projectContext - The project context to use.

graph - The (usually empty) graph to produce / extend

Method Detail

getConfigurationName

public abstract java.lang.String getConfigurationName()

Returns this filter's configuration name.

Returns:

See above

terminate

public void terminate(boolean error)

Description copied from class: AbstractFilterPlugin

Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.

Specified by:

terminate in interface IPlugin

Overrides:

terminate in class AbstractFilterPlugin

Parameters:

error - Determines whether the plugin is terminated due to an error or not.

getGraphOutputPortName

public java.lang.String getGraphOutputPortName()

Description copied from interface: IGraphOutputtingFilter

Returns the name of the port this filter uses to emit the graph.

Specified by:

getGraphOutputPortName in interface IGraphOutputtingFilter<G extends AbstractGraph<?,?,?>>

Returns:

See above

getGraph

protected G getGraph()

Delivers the graph stored in this filter.

Returns:

The graph.

getOriginRetentionPolicy

protected IOriginRetentionPolicy getOriginRetentionPolicy()

requestOriginRetentionPolicy

public void requestOriginRetentionPolicy(IOriginRetentionPolicy policy)
                                  throws AnalysisConfigurationException

Description copied from interface: IGraphProducingFilter

Requests that the given retention policy is used by this graph producer. Note that the producer may choose to use a more liberal, compatible retention policy to satisfy the needs of other graph consumers (see IOriginRetentionPolicy.isCompatibleWith(IOriginRetentionPolicy)).

Specified by:

requestOriginRetentionPolicy in interface IGraphProducingFilter<G extends AbstractGraph<?,?,?>>

Parameters:

policy - The requested policy

Throws:

AnalysisConfigurationException - If an error occurs during the request

handleOrigin

protected <T> void handleOrigin(AbstractGraphElement<T> element,
                    T origin)