com.endeca.cas.extension

Interface PipelineComponentRuntimeContext

public interface PipelineComponentRuntimeContext

The PipelineComponentRuntimeContext provides interfaces for outputting records, logging, and obtaining additional information about the context in which the associated PipelineComponentRuntime is running.

Method Summary

Methods

Modifier and Type	Method and Description
PipelineComponentContext	getComponentContext() Returns the PipelineComponentContext.
ErrorChannel	getErrorChannel() Returns an interface for discarding invalid records.
OutputChannel	getOutputChannel() Returns an interface for outputting created or processed records.
String	getRecordIdProperty() Gets the name of the property that is unique per record.
File	getStateDir() Returns the directory that the associated PipelineComponentRuntime can use to store state.
boolean	isStopped() Returns true if the pipeline should stop processing records because a stop has been requested.

Method Detail

getOutputChannel

OutputChannel getOutputChannel()

Returns an interface for outputting created or processed records.

Returns:

an OutputChannel to use for outputting records

getErrorChannel

ErrorChannel getErrorChannel()

Returns an interface for discarding invalid records.

Returns:

an ErrorChannel to use for discarding records

getStateDir

File getStateDir()

Returns the directory that the associated PipelineComponentRuntime can use to store state.

Returns:

the state directory

getRecordIdProperty

String getRecordIdProperty()

Gets the name of the property that is unique per record.

Returns:

name of the record id property

getComponentContext

PipelineComponentContext getComponentContext()

Returns the PipelineComponentContext.

Returns:

the PipelineComponentContext

isStopped

boolean isStopped()

Returns true if the pipeline should stop processing records because a stop has been requested.

Returns:

true if a stop has been requested

See Also:

PipelineComponentRuntime.stop(), PipelineStoppedException