kieker.tools.trace.analysis.filter.visualization.descriptions

Class DescriptionDecoratorFilter<V extends AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>,O>

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,O>,V,E,O>

kieker.tools.trace.analysis.filter.visualization.descriptions.DescriptionDecoratorFilter<V,E,O>

Type Parameters:

V - The type of the graph's vertices

E - The type of the graph's edges

O - The type of the origin of the graph's elements

All Implemented Interfaces:

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

public class DescriptionDecoratorFilter<V extends AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>,O>
extends AbstractGraphFilter<AbstractGraph<V,E,O>,V,E,O>
implements AbstractGraph.IGraphVisitor<V,E>

A filter which attaches decorations from a repository to graph entities.

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	DESCRIPTION_REPOSITORY_PORT_NAME Port name at which the description 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
DescriptionDecoratorFilter(Configuration configuration, IProjectContext projectContext) Creates a new description decorator filter using the given configuration.

Method Summary

Modifier and Type	Method and Description
protected IOriginRetentionPolicy	getDesiredOriginRetentionPolicy()
protected AbstractGraph<V,E,O>	performConcreteGraphProcessing(AbstractGraph<V,E,O> 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

DESCRIPTION_REPOSITORY_PORT_NAME

public static final java.lang.String DESCRIPTION_REPOSITORY_PORT_NAME

Port name at which the description repository must be connected.

See Also:

Constant Field Values

Constructor Detail

DescriptionDecoratorFilter

public DescriptionDecoratorFilter(Configuration configuration,
                                  IProjectContext projectContext)

Creates a new description decorator 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 AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>>

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 AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>>

Parameters:

edge - The encountered edge

performConcreteGraphProcessing

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

Description copied from class: AbstractGraphFilter

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

Specified by:

performConcreteGraphProcessing in class AbstractGraphFilter<AbstractGraph<V extends AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>,O>,V extends AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>,O>

Parameters:

graph - The graph to process

Returns:

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

getDesiredOriginRetentionPolicy

protected IOriginRetentionPolicy getDesiredOriginRetentionPolicy()

Specified by:

getDesiredOriginRetentionPolicy in class AbstractGraphFilter<AbstractGraph<V extends AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>,O>,V extends AbstractPayloadedVertex<V,E,O,ISystemModelElement>,E extends AbstractEdge<V,E,O>,O>