Package kieker.visualization.trace

Class GraphWriterPlugin

java.lang.Object
teetime.framework.AbstractStage
teetime.framework.AbstractConsumerStage<AbstractGraph<?,​?,​?>>
kieker.visualization.trace.GraphWriterPlugin
public class GraphWriterPlugin
extends teetime.framework.AbstractConsumerStage<AbstractGraph<?,​?,​?>>
Generic graph writer plugin to generate graph specifications and save them to disk. This plugin uses a formatter registry (see FORMATTER_REGISTRY) to determine the appropriate formatter for a given graph.
Since:
1.6
Author:
Holger Knoche

  • Field Summary

    Fields inherited from class teetime.framework.AbstractConsumerStage

    inputPort

    Fields inherited from class teetime.framework.AbstractStage

    logger

  • Constructor Summary

    Constructors 
    Constructor Description
    GraphWriterPlugin​(java.lang.String outputPathName, java.lang.String outputFileName, boolean includeWeights, boolean useShortLabels, boolean plotLoops)
    Creates a new instance of this class using the given parameters.

  • Method Summary

    Modifier and Type Method Description
    protected void execute​(AbstractGraph<?,​?,​?> graph)
    Formats a given graph and saves the generated specification to disk.

    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

    • GraphWriterPlugin

      public GraphWriterPlugin​(java.lang.String outputPathName, java.lang.String outputFileName, boolean includeWeights, boolean useShortLabels, boolean plotLoops)
      Creates a new instance of this class using the given parameters.
      Parameters:
      outputPathName - base path name for the output directory
      outputFileName - filename to be used within the directory
      includeWeights - include weights in plotting
      useShortLabels - use short labels
      plotLoops - plot loops

  • Method Details

    • execute

      protected void execute​(AbstractGraph<?,​?,​?> graph) throws java.lang.Exception
      Formats a given graph and saves the generated specification to disk. The file name to save the output to is specified by a the configuration options #CONFIG_PROPERTY_NAME_OUTPUT_PATH_NAME and #CONFIG_PROPERTY_NAME_OUTPUT_FILE_NAME.
      Specified by:
      execute in class teetime.framework.AbstractConsumerStage<AbstractGraph<?,​?,​?>>
      Parameters:
      graph - The graph to save
      Throws:
      java.lang.Exception