kieker.analysis.analysisComponent

Class AbstractAnalysisComponent

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

All Implemented Interfaces:

IAnalysisComponent

Direct Known Subclasses:

AbstractPlugin, AbstractRepository

public abstract class AbstractAnalysisComponent
extends java.lang.Object
implements IAnalysisComponent

Do not inherit directly from this class! Instead inherit from the class AbstractFilterPlugin, AbstractReaderPlugin or AbstractRepository. This is the base class for all other analysis components within Kieker, like repositories or plugins. It should therefore only be used by the Kieker components itself as a base.

Since:

1.7

Author:

Nils Christian Ehmke

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_NAME The name of the property for the name.
protected Configuration	configuration The current configuration of this component.
protected org.slf4j.Logger	logger The log for this component.
protected IProjectContext	projectContext The project context (usually the analysis controller) of this component.
protected java.util.concurrent.TimeUnit	recordsTimeUnitFromProjectContext The record time unit as provided by the project context.

Constructor Summary

Constructors

Constructor and Description
AbstractAnalysisComponent(Configuration configuration, IProjectContext projectContext) Each AnalysisComponent requires a constructor with a Configuration object and a IProjectContext.

Method Summary

Modifier and Type	Method and Description
abstract Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
protected abstract Configuration	getDefaultConfiguration() This method delivers an instance of Configuration containing the default properties for this class.
java.lang.String	getName() This method delivers the current name of this component instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_NAME

public static final java.lang.String CONFIG_NAME

The name of the property for the name. This should normally only be used by Kieker.

See Also:

Constant Field Values

projectContext

protected final IProjectContext projectContext

The project context (usually the analysis controller) of this component.

configuration

protected final Configuration configuration

The current configuration of this component.

logger

protected final org.slf4j.Logger logger

The log for this component.

recordsTimeUnitFromProjectContext

protected final java.util.concurrent.TimeUnit recordsTimeUnitFromProjectContext

The record time unit as provided by the project context.

Constructor Detail

AbstractAnalysisComponent

public AbstractAnalysisComponent(Configuration configuration,
                                 IProjectContext projectContext)
                          throws java.lang.NullPointerException

Each AnalysisComponent 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.

Throws:

java.lang.NullPointerException - If configuration or projectContext null

Method Detail

getDefaultConfiguration

protected abstract Configuration getDefaultConfiguration()

This method delivers an instance of Configuration containing the default properties for this class.

Returns:

The default properties.

getCurrentConfiguration

public abstract 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

Returns:

A completely filled configuration object.

getName

public final java.lang.String getName()

This method delivers the current name of this component instance. The name does not have to be unique.

Specified by:

getName in interface IAnalysisComponent

Returns:

The current name of the component instance.