Kieker 1.12

kieker.tools.traceAnalysis.filter.traceWriter
Class MessageTraceWriterFilter

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.AbstractMessageTraceProcessingFilter
                          extended by kieker.tools.traceAnalysis.filter.traceWriter.MessageTraceWriterFilter
All Implemented Interfaces:
IAnalysisComponent, IFilterPlugin, IPlugin

public class MessageTraceWriterFilter
extends AbstractMessageTraceProcessingFilter

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 java.lang.String CONFIG_PROPERTY_NAME_OUTPUT_FN
          The name of the configuration determining the output file name.
 
Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractMessageTraceProcessingFilter
INPUT_PORT_NAME_MESSAGE_TRACES
 
Fields inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
CONFIG_PROPERTY_VALUE_VERBOSE, LOG, REPOSITORY_PORT_NAME_SYSTEM_MODEL
 
Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME, configuration, log, projectContext, recordsTimeUnitFromProjectContext
 
Constructor Summary
MessageTraceWriterFilter(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.
 void inputMessageTraces(MessageTrace mt)
          This is the (abstract) input port for the incoming message traces.
 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.
 
Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceProcessingFilter
getErrorCount, getLastTraceIdError, getLastTraceIdSuccess, getSuccessCount, getTotalCount, reportError, reportSuccess
 
Methods inherited from class kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter
createExecutionByEntityNames, createExecutionByEntityNames, createExecutionByEntityNames, createExecutionByEntityNames, getSystemEntityFactory, printDebugLogMessage, printErrorLogMessage
 
Methods inherited from class kieker.analysis.plugin.filter.AbstractFilterPlugin
init
 
Methods inherited from class kieker.analysis.plugin.AbstractPlugin
areAllRepositoryPortsConnected, connect, connect, deliver, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getDefaultConfiguration, getIncomingPlugins, getPluginDescription, getPluginName, getRepository, getState, isConnectionAllowed, notifyNewIncomingConnection, notifyNewOutgoingConnection, shutdown, start
 
Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, 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

CONFIG_PROPERTY_NAME_OUTPUT_FN

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

See Also:
Constant Field Values
Constructor Detail

MessageTraceWriterFilter

public MessageTraceWriterFilter(Configuration configuration,
                                IProjectContext projectContext)
                         throws java.io.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:
java.io.IOException - If either the default encoding is not supported or the given file is somehow invalid.
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.

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
Overrides:
getCurrentConfiguration in class AbstractTraceAnalysisFilter
Returns:
A completely filled configuration object.

inputMessageTraces

public void inputMessageTraces(MessageTrace mt)
This is the (abstract) input port for the incoming message traces.

Specified by:
inputMessageTraces in class AbstractMessageTraceProcessingFilter
Parameters:
mt - The incoming message trace.

Kieker 1.12

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