com.endeca.cas.extension

Class PipelineComponent<R extends PipelineComponentRuntime,C extends PipelineComponentConfiguration<C>>

java.lang.Object

com.endeca.cas.extension.PipelineComponent<R,C>

Direct Known Subclasses:

DataSource, Manipulator

public abstract class PipelineComponent<R extends PipelineComponentRuntime,C extends PipelineComponentConfiguration<C>>
extends Object

Base class for any CAS pipeline components.

Constructor Summary

Constructors

Constructor and Description
PipelineComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteInstance(C config, File stateDir) Deletes an instance of this PipelineComponent.
protected PipelineComponentContext	getComponentContext() Gets the PipelineComponentContext for this instance of the component.
abstract Class<C>	getConfigurationClass() Returns the configuration Class.
abstract Class<R>	getRuntimeClass()
void	setComponentContext(PipelineComponentContext componentContext) Called immediately after the PipelineComponent is instantiated to set up the context for this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineComponent

public PipelineComponent()

Method Detail

getConfigurationClass

public abstract Class<C> getConfigurationClass()

Returns the configuration Class.

Returns:

the configuration class

getRuntimeClass

public abstract Class<R> getRuntimeClass()

Returns:

the Class of the PipelineComponentRuntime that will be created by the PipelineComponent's DataSource.createDataSourceRuntime(PipelineComponentConfiguration, PipelineComponentRuntimeContext) or Manipulator.createManipulatorRuntime(PipelineComponentConfiguration, PipelineComponentRuntimeContext)

setComponentContext

public final void setComponentContext(PipelineComponentContext componentContext)

Called immediately after the PipelineComponent is instantiated to set up the context for this component.

Parameters:

componentContext - context for the PipelineComponent

getComponentContext

protected final PipelineComponentContext getComponentContext()

Gets the PipelineComponentContext for this instance of the component.

Returns:

the PipelineComponentContext for this instance of the component.

deleteInstance

public void deleteInstance(C config,
                  File stateDir)

Deletes an instance of this PipelineComponent.

Parameters:

config - The configuration of the instance to delete

stateDir - the state directory for this instance