kieker.tools.trace.analysis.filter.visualization.traceColoring

Class TraceColoringFilter<V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>>

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.filter.AbstractFilterPlugin

kieker.tools.trace.analysis.filter.visualization.AbstractGraphFilter<AbstractGraph<V,E,TraceInformation>,V,E,TraceInformation>

kieker.tools.trace.analysis.filter.visualization.traceColoring.TraceColoringFilter<V,E>

Type Parameters:

V - The type of the graph's vertices

E - The type of the graph's edges

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin, IGraphOutputtingFilter<AbstractGraph<V,E,TraceInformation>>, AbstractGraph.IGraphVisitor<V,E>

public class TraceColoringFilter<V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>>
extends AbstractGraphFilter<AbstractGraph<V,E,TraceInformation>,V,E,TraceInformation>
implements AbstractGraph.IGraphVisitor<V,E>

This filter sets the color of nodes and edges which belong to a single trace according to a trace coloring schema defined in a color repository (see TraceColorRepository). Element that belong to multiple traces get the collision color defined in the repository.

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

Modifier and Type	Field and Description
static java.lang.String	COLOR_REPOSITORY_PORT_NAME Port name at which the color repository must be connected.

Fields inherited from class kieker.tools.trace.analysis.filter.visualization.AbstractGraphFilter

INPUT_PORT_NAME_GRAPH

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, logger, projectContext, recordsTimeUnitFromProjectContext

Fields inherited from interface kieker.tools.trace.analysis.filter.IGraphOutputtingFilter

OUTPUT_PORT_NAME_GRAPH

Constructor Summary

Constructors

Constructor and Description
TraceColoringFilter(Configuration configuration, IProjectContext projectContext) Creates a new filter using the given configuration.

Method Summary

Modifier and Type	Method and Description
protected IOriginRetentionPolicy	getDesiredOriginRetentionPolicy()
protected AbstractGraph<V,E,TraceInformation>	performConcreteGraphProcessing(AbstractGraph<V,E,TraceInformation> graph) This method encapsulates the concrete graph processing performed by the concrete filters.
void	visitEdge(E edge) Call-back operation that is invoked when an edge is encountered during graph traversal.
void	visitVertex(V vertex) Call-back operation that is invoked when a vertex is encountered during graph traversal.

Methods inherited from class kieker.tools.trace.analysis.filter.visualization.AbstractGraphFilter

getCurrentConfiguration, getGraphInputPortName, getGraphOutputPortName, init, notifyNewIncomingConnection, processGraph

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

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, 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

COLOR_REPOSITORY_PORT_NAME

public static final java.lang.String COLOR_REPOSITORY_PORT_NAME

Port name at which the color repository must be connected.

See Also:

Constant Field Values

Constructor Detail

TraceColoringFilter

public TraceColoringFilter(Configuration configuration,
                           IProjectContext projectContext)

Creates a new filter using the given configuration.

Parameters:

configuration - The configuration to use for this filter.

projectContext - The project context to use for this filter.

Method Detail

visitVertex

public void visitVertex(V vertex)

Call-back operation that is invoked when a vertex is encountered during graph traversal.

Specified by:

visitVertex in interface AbstractGraph.IGraphVisitor<V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>>

Parameters:

vertex - The encountered vertex

visitEdge

public void visitEdge(E edge)

Call-back operation that is invoked when an edge is encountered during graph traversal.

Specified by:

visitEdge in interface AbstractGraph.IGraphVisitor<V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>>

Parameters:

edge - The encountered edge

performConcreteGraphProcessing

protected AbstractGraph<V,E,TraceInformation> performConcreteGraphProcessing(AbstractGraph<V,E,TraceInformation> graph)

This method encapsulates the concrete graph processing performed by the concrete filters.

Specified by:

performConcreteGraphProcessing in class AbstractGraphFilter<AbstractGraph<V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>,TraceInformation>,V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>,TraceInformation>

Parameters:

graph - The graph to process

Returns:

The processed graph, which may be the same as the input graph

getDesiredOriginRetentionPolicy

protected IOriginRetentionPolicy getDesiredOriginRetentionPolicy()
                                                          throws AnalysisConfigurationException

Specified by:

getDesiredOriginRetentionPolicy in class AbstractGraphFilter<AbstractGraph<V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>,TraceInformation>,V extends AbstractVertex<V,E,TraceInformation>,E extends AbstractEdge<V,E,TraceInformation>,TraceInformation>

Throws:

AnalysisConfigurationException