kieker.tools.traceAnalysis.filter.systemModel

Class SystemModel2FileFilter

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.filter.AbstractFilterPlugin

kieker.tools.traceAnalysis.filter.AbstractTraceAnalysisFilter

kieker.tools.traceAnalysis.filter.systemModel.SystemModel2FileFilter

All Implemented Interfaces:

IAnalysisComponent, IFilterPlugin, IPlugin

public class SystemModel2FileFilter
extends AbstractTraceAnalysisFilter

Writes the contents of a connected SystemModelRepository to files. Currently, only HTML output is supported.

Since:

1.5

Author:

Andre van Hoorn

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_PROPERTY_NAME_HTML_OUTPUT_FN Name of the configuration property to pass the filename of the HTML output.
protected static java.lang.String	DEFAULT_HTML_OUTPUT_FN By default, writes HTML output file to this file in the working directory.

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

Constructors

Constructor and Description
SystemModel2FileFilter(Configuration configuration, IProjectContext projectContext) Creates a new instance of this class using the given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
void	terminate(boolean errorBeforeTermination) Initiates a termination of the plugin.

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_HTML_OUTPUT_FN

public static final java.lang.String CONFIG_PROPERTY_NAME_HTML_OUTPUT_FN

Name of the configuration property to pass the filename of the HTML output.

See Also:

Constant Field Values

DEFAULT_HTML_OUTPUT_FN

protected static final java.lang.String DEFAULT_HTML_OUTPUT_FN

By default, writes HTML output file to this file in the working directory.

See Also:

Constant Field Values

Constructor Detail

SystemModel2FileFilter

public SystemModel2FileFilter(Configuration configuration,
                      IProjectContext projectContext)

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.

Method Detail

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.

terminate

public void terminate(boolean errorBeforeTermination)

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:

errorBeforeTermination - Determines whether the plugin is terminated due to an error or not.