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

static String

CONFIG_NAME The name of the property for the name.

Constructor Summary

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

Method Summary

abstract Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
String	getName() This method delivers the current name of this component instance.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_NAME

public static final String CONFIG_NAME

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

See Also:

Constant Field Values

Constructor Detail

AbstractAnalysisComponent

public AbstractAnalysisComponent(Configuration configuration,
                                 IProjectContext projectContext)

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:

NullPointerException - If configuration or projectContext null

Method Detail

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