Package kieker.visualization.trace

Class SequenceDiagramFilter

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.SequenceDiagramFilter

public class SequenceDiagramFilter
extends AbstractMessageTraceProcessingFilter

Refactored copy from LogAnalysis-legacy tool
This class has exactly one input port named "in". The data which is send to this plugin is not delegated in any way.

Since:

0.95a

Author:

Andre van Hoorn, Nils Sommer, Jan Waller

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SequenceDiagramFilter.SDModes

Field Summary

Fields inherited from class teetime.framework.AbstractConsumerStage

inputPort

Fields inherited from class teetime.framework.AbstractStage

logger

Constructor Summary

Constructors

Constructor	Description
SequenceDiagramFilter(SystemModelRepository repository, SequenceDiagramFilter.SDModes sdmode, String outputFnBase, boolean shortLabels)	Creates a new instance of this class using the given parameters.

Method Summary

Modifier and Type	Method	Description
protected void	execute(MessageTrace mt)
void	printStatusMessage()	Returns a user-addressed status message to be logged by the calling tool.
static void	writePicForMessageTrace(MessageTrace msgTrace, SequenceDiagramFilter.SDModes sdMode, String outputFilename, boolean shortLabels)	This method writes the pic code for the given message trace into the given file.

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

SequenceDiagramFilter

public SequenceDiagramFilter(SystemModelRepository repository,
 SequenceDiagramFilter.SDModes sdmode,
 String outputFnBase,
 boolean shortLabels)

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

Parameters:

configuration - The configuration to use for this filter.

projectContext - The project context to use for this filter.

Method Details

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.

Overrides:

printStatusMessage in class AbstractTraceProcessingStage<MessageTrace>

execute

protected void execute(MessageTrace mt)
                throws Exception

Specified by:

execute in class AbstractMessageTraceProcessingFilter

Throws:

Exception

writePicForMessageTrace

public static void writePicForMessageTrace(MessageTrace msgTrace,
 SequenceDiagramFilter.SDModes sdMode,
 String outputFilename,
 boolean shortLabels)
                                    throws IOException

This method writes the pic code for the given message trace into the given file.

Parameters:

msgTrace - The message trace to convert.

sdMode - The mode of the sequence diagram (allocation, assembly).

shortLabels - Determines whether to use short labels or not.

outputFilename - The name of the file in which the code will be written.

Throws:

IOException - on io errors