com.endeca.cas.extension
Class DataSource<R extends DataSourceRuntime,C extends PipelineComponentConfiguration<C>>

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

public abstract class DataSource<R extends DataSourceRuntime,C extends PipelineComponentConfiguration<C>>
extends PipelineComponent<R,C>

A CAS extension for acquiring data from a data source. Implementations must be annotated with the CasDataSource annotation and have a zero argument constructor.

CAS creates exactly one instance of the DataSource at start-up time and will call createDataSourceRuntime to create a runtime object each time an acquisition is started.

See Also:

CasDataSource, DataSourceRuntime, PipelineComponentConfiguration

Constructor Summary

DataSource()

Method Summary

abstract R

createDataSourceRuntime(C configuration, PipelineComponentRuntimeContext context) Creates a runtime instance of this extension.

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

DataSource

public DataSource()

Method Detail

createDataSourceRuntime

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

Creates a runtime instance of this extension.

Parameters:

configuration - the configuration to be used in the new runtime

context - the context to use in the new runtime

Returns:

a new instance of a DataSourceRuntime

Throws:

PipelineInitializationException - if creation of the DataSourceRuntime failed.