Package kieker.visualization.trace.call.tree

Class AbstractAggregatedCallTreeFilter<T>

java.lang.Object

teetime.framework.AbstractStage

teetime.framework.AbstractConsumerStage<T>

kieker.analysis.architecture.trace.AbstractTraceAnalysisStage<T>

kieker.analysis.architecture.trace.AbstractTraceProcessingStage<MessageTrace>

kieker.analysis.plugin.trace.AbstractMessageTraceProcessingFilter

kieker.visualization.trace.call.tree.AbstractCallTreeFilter<T>

kieker.visualization.trace.call.tree.AbstractAggregatedCallTreeFilter<T>

Type Parameters:

T -

Direct Known Subclasses:

AggregatedAllocationComponentOperationCallTreeFilter, AggregatedAssemblyComponentOperationCallTreeFilter

public abstract class AbstractAggregatedCallTreeFilter<T>
extends AbstractCallTreeFilter<T>

This class has exactly one input port named "in". The data which is send to this plugin is not delegated in any way.

Since:

1.1

Author:

Andre van Hoorn

Nested Class Summary

Nested classes/interfaces inherited from class kieker.visualization.trace.call.tree.AbstractCallTreeFilter

AbstractCallTreeFilter.IPairFactory<T>

Field Summary

Fields inherited from class teetime.framework.AbstractConsumerStage

inputPort

Fields inherited from class teetime.framework.AbstractStage

logger

Constructor Summary

Constructors

Constructor	Description
AbstractAggregatedCallTreeFilter(SystemModelRepository repository, boolean includeWeights, boolean shortLabels, java.lang.String dotOutputFile)	Creates a new instance of this class using the given parameters.

Method Summary

Modifier and Type	Method	Description
protected abstract T	concreteCreatePair(SynchronousCallMessage callMsg)	HACK.
protected void	execute(MessageTrace trace)
void	onTerminating()	Saves the call tree to the dot file if error is not true.
void	printStatusMessage()	Returns a user-addressed status message to be logged by the calling tool.
void	saveTreeToDotFile()	This method tries to convert the current tree into the specified file as a valid dot file, which can later be transformed into a visual representation by dot itself.
protected void	setRoot(AbstractAggregatedCallTreeNode<T> root)	Sets the root of the call tree.

Methods inherited from class kieker.visualization.trace.call.tree.AbstractCallTreeFilter

addTraceToTree, nodeLabel, saveTreeToDotFile, writeDotForMessageTrace

Methods inherited from class kieker.analysis.architecture.trace.AbstractTraceProcessingStage

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

Methods inherited from class kieker.analysis.architecture.trace.AbstractTraceAnalysisStage

createExecutionByEntityNames, createExecutionByEntityNames, createExecutionByEntityNames, createExecutionByEntityNames, getSystemModelRepository, printDebugLogMessage, printErrorLogMessage

Methods inherited from class teetime.framework.AbstractConsumerStage

createInputPort, execute, getInputPort

Methods inherited from class teetime.framework.AbstractStage

abort, addInputPortRemovedListener, addOutputPortRemovedListener, compareAndSetBeingExecuted, createInputPort, createInputPort, createInputPort, createOutputPort, createOutputPort, createOutputPort, createOutputPort, declareActive, declarePassive, executeByFramework, getCurrentState, getId, getInputPorts, getOutputPorts, getOwningThread, getTerminationStrategy, isActive, isBeingExecuted, isPaused, isProducer, isStateless, onSignal, onStarting, onValidating, removeDynamicPort, removeDynamicPort, setPaused, setStateless, shouldBeTerminated, signalAlreadyReceived, terminateStage, toString, workCompleted

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractAggregatedCallTreeFilter

public AbstractAggregatedCallTreeFilter(SystemModelRepository repository, boolean includeWeights, boolean shortLabels, java.lang.String dotOutputFile)

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

Parameters:

repository - system model repository

includeWeights - include weights ingraph

shortLabels - use short labels

dotOutputFile - output file name

Method Details

setRoot

protected void setRoot(AbstractAggregatedCallTreeNode<T> root)

Sets the root of the call tree.

Parameters:

root - The new root.

saveTreeToDotFile

public void saveTreeToDotFile() throws java.io.IOException

This method tries to convert the current tree into the specified file as a valid dot file, which can later be transformed into a visual representation by dot itself.

Throws:

java.io.IOException - If something went wrong during the converting.

printStatusMessage

public void printStatusMessage()

Description copied from class: AbstractTraceProcessingStage

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.

Overrides:

printStatusMessage in class AbstractTraceProcessingStage<MessageTrace>

onTerminating

public void onTerminating()

Saves the call tree to the dot file if error is not true.

Overrides:

onTerminating in class teetime.framework.AbstractStage

execute

protected void execute(MessageTrace trace) throws java.lang.Exception

Specified by:

execute in class AbstractMessageTraceProcessingFilter

Throws:

java.lang.Exception

concreteCreatePair

protected abstract T concreteCreatePair(SynchronousCallMessage callMsg)

HACK. Inheriting classes should implement this method to deliver the actual pair.

Parameters:

callMsg - The call message which contains the information necessary to create the pair.

Returns:

The actual pair.