Kieker 1.10

kieker.analysis.plugin.filter
Class AbstractFilterPlugin

java.lang.Object
  extended by kieker.analysis.analysisComponent.AbstractAnalysisComponent
      extended by kieker.analysis.plugin.AbstractPlugin
          extended by kieker.analysis.plugin.filter.AbstractFilterPlugin
All Implemented Interfaces:
IAnalysisComponent, IFilterPlugin, IPlugin
Direct Known Subclasses:
AbstractGraphFilter, AbstractTraceAnalysisFilter, AbstractUpdateableFilterPlugin, AbstractWebVisualizationFilterPlugin, AnalysisThroughputFilter, AnomalyScoreCalculationFilter, AnomalyScoreVisualizationFilter, CountingFilter, CPUUtilizationDisplayFilter, CurrentTimeEventGenerationFilter, EventRecordTraceReconstructionFilter, ExtractionFilter, GCDisplayFilter, GraphWriterPlugin, ListCollectionFilter, MemSwapUtilizationDisplayFilter, MethodAndComponentFlowDisplayFilter, MonitoringRecordLoggerFilter, MonitoringThroughputFilter, RealtimeRecordDelayFilter, RecordConverter, SessionReconstructionFilter, StringBufferFilter, TeeFilter, ThreadsStatusDisplayFilter, TimeSeriesPointAggregatorFilter, TimestampFilter, TraceAggregationFilter, TraceIdFilter, TypeFilter, UniteMeasurementPairFilter

public abstract class AbstractFilterPlugin
extends AbstractPlugin
implements IFilterPlugin

This class should be used as a base for every analysis plugin used within Kieker. For reader plugins, the class AbstractReaderPlugin should be used instead.

Since:
1.5
Author:
Nils Christian Ehmke

Nested Class Summary
 
Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin
IPlugin.PluginInputPortReference, IPlugin.STATE
 
Field Summary
 
Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent
CONFIG_NAME
 
Constructor Summary
AbstractFilterPlugin(Configuration configuration, IProjectContext projectContext)
          Each Plugin requires a constructor with a Configuration object and a IProjectContext.
 
Method Summary
 boolean init()
          Initiates the start of a component.
 void terminate(boolean error)
          Initiates a termination of the plugin.
 
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
getCurrentConfiguration, 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, getCurrentConfiguration, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState
 

Constructor Detail

AbstractFilterPlugin

public AbstractFilterPlugin(Configuration configuration,
                            IProjectContext projectContext)
Each Plugin requires a constructor with a Configuration object and a IProjectContext.

Parameters:
configuration - The configuration for this component.
projectContext - The project context for this component. The component will be registered.
Method Detail

init

public boolean init()
Initiates the start of a component. This method is called once when a AnalysisController's run() method is called. This implementation must not be blocking! Asynchronous consumers would spawn (an) asynchronous thread(s) in this method.

Specified by:
init in interface IPlugin
Returns:
true on success; false otherwise.

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
Parameters:
error - Determines whether the plugin is terminated due to an error or not.

Kieker 1.10

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