Kieker 1.5

kieker.tools.traceAnalysis.filter.visualization.sequenceDiagram
Class SequenceDiagramFilter

java.lang.Object
  extended by kieker.analysis.plugin.AbstractPlugin
      extended by kieker.analysis.plugin.filter.AbstractFilterPlugin
          extended by kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
              extended by kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter
                  extended by kieker.tools.traceAnalysis.filter.AbstractMessageTraceProcessingFilter
                      extended by kieker.tools.traceAnalysis.filter.visualization.sequenceDiagram.SequenceDiagramFilter
All Implemented Interfaces:
IFilterPlugin, IPlugin

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.

Author:
Andre van Hoorn, Nils Sommer, Jan Waller

Nested Class Summary
static class SequenceDiagramFilter.SDModes
           
 
Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin
IPlugin.PluginInputPortReference
 
Field Summary
static String CONFIG_PROPERTY_NAME_OUTPUT_FN_BASE
           
static String CONFIG_PROPERTY_NAME_OUTPUT_SDMODE
           
static String CONFIG_PROPERTY_NAME_OUTPUT_SHORTLABES
           
static String CONFIG_PROPERTY_VALUE_OUTPUT_FN_BASE_DEFAULT
           
 
Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractMessageTraceProcessingFilter
INPUT_PORT_NAME_MESSAGE_TRACES
 
Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter
MAX_DURATION_MILLIS
 
Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
REPOSITORY_PORT_NAME_SYSTEM_MODEL
 
Fields inherited from class kieker.analysis.plugin.AbstractPlugin
CONFIG_NAME
 
Constructor Summary
SequenceDiagramFilter(Configuration configuration)
           
 
Method Summary
 Configuration getCurrentConfiguration()
          This method should deliver a Configuration object containing the current configuration of this instance.
 void inputMessageTraces(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)
           
 
Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter
getErrorCount, getLastTraceIdError, getLastTraceIdSuccess, getSuccessCount, getTotalCount
 
Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
createExecutionByEntityNames, setErrStream, setOutStream
 
Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin
init, terminate
 
Methods inherited from class kieker.analysis.plugin.AbstractPlugin
areAllRepositoryPortsConnected, connect, connect, getAllInputPortNames, getAllOutputPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, isConnectionAllowed
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONFIG_PROPERTY_NAME_OUTPUT_FN_BASE

public static final String CONFIG_PROPERTY_NAME_OUTPUT_FN_BASE
See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_OUTPUT_SHORTLABES

public static final String CONFIG_PROPERTY_NAME_OUTPUT_SHORTLABES
See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_OUTPUT_SDMODE

public static final String CONFIG_PROPERTY_NAME_OUTPUT_SDMODE
See Also:
Constant Field Values

CONFIG_PROPERTY_VALUE_OUTPUT_FN_BASE_DEFAULT

public static final String CONFIG_PROPERTY_VALUE_OUTPUT_FN_BASE_DEFAULT
See Also:
Constant Field Values
Constructor Detail

SequenceDiagramFilter

public SequenceDiagramFilter(Configuration configuration)
Method Detail

printStatusMessage

public void printStatusMessage()
Description copied from class: AbstractTraceProcessingFilter
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 AbstractTraceProcessingFilter

inputMessageTraces

public void inputMessageTraces(MessageTrace mt)
Specified by:
inputMessageTraces in class AbstractMessageTraceProcessingFilter

writePicForMessageTrace

public static void writePicForMessageTrace(MessageTrace msgTrace,
                                           SequenceDiagramFilter.SDModes sdMode,
                                           String outputFilename,
                                           boolean shortLabels)
                                    throws FileNotFoundException,
                                           UnsupportedEncodingException
Throws:
FileNotFoundException
UnsupportedEncodingException

getCurrentConfiguration

public Configuration getCurrentConfiguration()
Description copied from interface: IPlugin
This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.

Returns:
A completely filled configuration object.

Kieker 1.5

Copyright 2012 the Kieker Project, http://kieker-monitoring.net