Kieker 1.8

kieker.tools.traceAnalysis.filter.traceWriter
Class ExecutionTraceWriterFilter

java.lang.Object
  extended by kieker.analysis.analysisComponent.AbstractAnalysisComponent
      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.AbstractExecutionTraceProcessingFilter
                          extended by kieker.tools.traceAnalysis.filter.traceWriter.ExecutionTraceWriterFilter
All Implemented Interfaces:
IAnalysisComponent, IFilterPlugin, IPlugin

public class ExecutionTraceWriterFilter
extends AbstractExecutionTraceProcessingFilter

This class has exactly one input port named "in". The data which is send to this plugin is not delegated in any way.

Since:
1.2
Author:
Andre van Hoorn

Nested Class Summary
 
Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin
IPlugin.PluginInputPortReference, IPlugin.STATE
 
Field Summary
static String CONFIG_PROPERTY_NAME_OUTPUT_FN
          The name of the configuration determining the output file name.
static String INPUT_PORT_NAME_EXECUTION_TRACES
          This is the name of the input port receiving new execution traces.
 
Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
REPOSITORY_PORT_NAME_SYSTEM_MODEL
 
Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME
 
Constructor Summary
ExecutionTraceWriterFilter(Configuration configuration, IProjectContext projectContext)
          Creates a new instance of this class using the given parameters.
 
Method Summary
 Configuration getCurrentConfiguration()
          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.
 void newExecutionTrace(ExecutionTrace et)
          This method represents the input port of this filter.
 void printStatusMessage()
          Returns a user-addressed status message to be logged by the calling tool.
 void terminate(boolean error)
          Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.
 
Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter
getErrorCount, getLastTraceIdError, getLastTraceIdSuccess, getSuccessCount, getTotalCount
 
Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
createExecutionByEntityNames, createExecutionByEntityNames, getSystemEntityFactory, setErrStream, setOutStream
 
Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin
init
 
Methods inherited from class kieker.analysis.plugin.AbstractPlugin
areAllRepositoryPortsConnected, connect, connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getIncomingPlugins, getPluginDescription, getPluginName, getState, isConnectionAllowed, shutdown, start
 
Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
getName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface kieker.analysis.plugin.IPlugin
connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState
 

Field Detail

INPUT_PORT_NAME_EXECUTION_TRACES

public static final String INPUT_PORT_NAME_EXECUTION_TRACES
This is the name of the input port receiving new execution traces.

See Also:
Constant Field Values

CONFIG_PROPERTY_NAME_OUTPUT_FN

public static final String CONFIG_PROPERTY_NAME_OUTPUT_FN
The name of the configuration determining the output file name.

See Also:
Constant Field Values
Constructor Detail

ExecutionTraceWriterFilter

public ExecutionTraceWriterFilter(Configuration configuration,
                                  IProjectContext projectContext)
                           throws IOException
Creates a new instance of this class using the given parameters.

Parameters:
configuration - The configuration for this component.
projectContext - The project context for this component.
Throws:
IOException - If the write stream could not be prepared.
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

terminate

public void terminate(boolean error)
Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.

Specified by:
terminate in interface IPlugin
Overrides:
terminate in class AbstractFilterPlugin
Parameters:
error - Determines whether the plugin is terminated due to an error or not.

newExecutionTrace

public void newExecutionTrace(ExecutionTrace et)
This method represents the input port of this filter.

Parameters:
et - The next execution trace.

getCurrentConfiguration

public Configuration getCurrentConfiguration()
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.

Specified by:
getCurrentConfiguration in interface IAnalysisComponent
Specified by:
getCurrentConfiguration in interface IPlugin
Specified by:
getCurrentConfiguration in class AbstractAnalysisComponent
Returns:
A completely filled configuration object.

Kieker 1.8

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