Kieker 1.3

kieker.tools.traceAnalysis.plugins.visualization.callTree
Class TraceCallTreePlugin

java.lang.Object
  extended by kieker.tools.traceAnalysis.plugins.AbstractTraceAnalysisPlugin
      extended by kieker.tools.traceAnalysis.plugins.AbstractTraceProcessingPlugin
          extended by kieker.tools.traceAnalysis.plugins.AbstractMessageTraceProcessingPlugin
              extended by kieker.tools.traceAnalysis.plugins.visualization.callTree.TraceCallTreePlugin
All Implemented Interfaces:
IAnalysisPlugin

public class TraceCallTreePlugin
extends AbstractMessageTraceProcessingPlugin

Plugin providing the creation of calling trees both for individual traces and an aggregated form mulitple traces.

Author:
Andre van Hoorn

Constructor Summary
TraceCallTreePlugin(String name, AllocationComponentOperationPairFactory allocationComponentOperationPairFactory, SystemModelRepository systemEntityFactory, String outputFnBase, boolean shortLabels)
           
 
Method Summary
 boolean execute()
          Initiates the start of a component.
 IInputPort<MessageTrace> getMessageTraceInputPort()
           
 void printStatusMessage()
           
 void saveTreeToDotFile(String outputFnBase, boolean includeWeights, boolean shortLabels)
           
 void terminate(boolean error)
          Initiates a termination of the component.
static void writeDotForMessageTrace(SystemModelRepository systemEntityFactory, MessageTrace msgTrace, String outputFilename, boolean includeWeights, 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

TraceCallTreePlugin

public TraceCallTreePlugin(String name,
                           AllocationComponentOperationPairFactory allocationComponentOperationPairFactory,
                           SystemModelRepository systemEntityFactory,
                           String outputFnBase,
                           boolean shortLabels)
Method Detail

saveTreeToDotFile

public void saveTreeToDotFile(String outputFnBase,
                              boolean includeWeights,
                              boolean shortLabels)
                       throws FileNotFoundException
Throws:
FileNotFoundException

writeDotForMessageTrace

public static void writeDotForMessageTrace(SystemModelRepository systemEntityFactory,
                                           MessageTrace msgTrace,
                                           String outputFilename,
                                           boolean includeWeights,
                                           boolean shortLabels)
                                    throws FileNotFoundException,
                                           TraceProcessingException
Throws:
FileNotFoundException
TraceProcessingException

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) aynchronous 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

Kieker 1.3

Copyright 2011 the Kieker Project, http://kieker.sourceforge.net