com.endeca.cas.extension
Class Manipulator<R extends ManipulatorRuntime,C extends PipelineComponentConfiguration<C>>

java.lang.Object
  com.endeca.cas.extension.PipelineComponent<R,C>
      com.endeca.cas.extension.Manipulator<R,C>

public abstract class Manipulator<R extends ManipulatorRuntime,C extends PipelineComponentConfiguration<C>>
extends PipelineComponent<R,C>

A CAS extension for manipulating data during the acquisition process. Implementations must be annotated with the CasManipulator annotation and have a zero argument constructor.

CAS creates exactly one instance of the Manipulator at start-up time and will call createManipulatorRuntime to create a runtime object each time a crawl is started for each occurance of the manipulator in the data source configuration.

See Also:

CasManipulator, ManipulatorRuntime, PipelineComponentConfiguration

Constructor Summary

Manipulator()

Method Summary

abstract R

createManipulatorRuntime(C configuration, PipelineComponentRuntimeContext context) Creates a new runtime instance of this manipulator.

Methods inherited from class com.endeca.cas.extension.PipelineComponent

deleteInstance, getComponentContext, getConfigurationClass, getRuntimeClass, setComponentContext

Methods inherited from class java.lang.Object

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

Constructor Detail

Manipulator

public Manipulator()

Method Detail

createManipulatorRuntime

public abstract R createManipulatorRuntime(C configuration,
                                           PipelineComponentRuntimeContext context)
                                                               throws PipelineInitializationException

Creates a new runtime instance of this manipulator.

Parameters:

configuration - the configuration to be used by the new ManipulatorRuntime

context - the context to be used by the new ManipulatorRuntime

Returns:

a new instance of a ManipulatorRuntime

Throws:

PipelineInitializationException - if creation of the ManipulatorRuntime failed.