kieker.tools.traceAnalysis.plugins.visualization.sequenceDiagram
Class SequenceDiagramPlugin

java.lang.Object
  kieker.tools.traceAnalysis.plugins.AbstractTraceAnalysisPlugin
      kieker.tools.traceAnalysis.plugins.AbstractTraceProcessingPlugin
          kieker.tools.traceAnalysis.plugins.AbstractMessageTraceProcessingPlugin
              kieker.tools.traceAnalysis.plugins.visualization.sequenceDiagram.SequenceDiagramPlugin

All Implemented Interfaces:

IAnalysisPlugin

public class SequenceDiagramPlugin
extends AbstractMessageTraceProcessingPlugin

Refactored copy from LogAnalysis-legacy tool

Author:

Andre van Hoorn, Nils Sommer

Nested Class Summary

static class

SequenceDiagramPlugin.SDModes

Constructor Summary

SequenceDiagramPlugin(String name, SystemModelRepository systemEntityFactory, SequenceDiagramPlugin.SDModes sdmode, String outputFnBase, boolean shortLabels)

Method Summary

boolean	execute() Initiates the start of a component.
IInputPort<MessageTrace>	getMessageTraceInputPort()
void	printStatusMessage()
void	terminate(boolean error) Initiates a termination of the component.
static void	writePicForMessageTrace(SystemModelRepository systemEntityFactory, MessageTrace msgTrace, SequenceDiagramPlugin.SDModes sdMode, String outputFilename, boolean shortLabels)

Methods inherited from class kieker.tools.traceAnalysis.plugins.AbstractTraceProcessingPlugin

getErrorCount, getLastTraceIdError, getLastTraceIdSuccess, getSuccessCount, getTotalCount

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SequenceDiagramPlugin

public SequenceDiagramPlugin(String name,
                             SystemModelRepository systemEntityFactory,
                             SequenceDiagramPlugin.SDModes sdmode,
                             String outputFnBase,
                             boolean shortLabels)

Method Detail

printStatusMessage

public void printStatusMessage()

Overrides:

printStatusMessage in class AbstractTraceProcessingPlugin

execute

public boolean execute()

Description copied from interface: IAnalysisPlugin

Initiates the start of a component. This method is called once when a TpanInstance's run() method is called. This implementation must not be blocking! Asynchronous consumers would spawn (an) asynchronous thread(s) in this method.

Returns:

true on success; false otherwise.

terminate

public void terminate(boolean error)

Description copied from interface: IAnalysisPlugin

Initiates a termination of the component. The value of the parameter error indicates whether an error occured.

Parameters:

error - true iff an error occured.

getMessageTraceInputPort

public IInputPort<MessageTrace> getMessageTraceInputPort()

Specified by:

getMessageTraceInputPort in class AbstractMessageTraceProcessingPlugin

writePicForMessageTrace

public static void writePicForMessageTrace(SystemModelRepository systemEntityFactory,
                                           MessageTrace msgTrace,
                                           SequenceDiagramPlugin.SDModes sdMode,
                                           String outputFilename,
                                           boolean shortLabels)
                                    throws FileNotFoundException

Throws:

FileNotFoundException