Logo Search packages:      
Sourcecode: uimaj version File versions  Download package

Public Member Functions | Static Public Attributes

org::apache::uima::collection::base_cpm::CasDataConsumer Interface Reference

Inheritance diagram for org::apache::uima::collection::base_cpm::CasDataConsumer:
Inheritance graph
[legend]
Collaboration diagram for org::apache::uima::collection::base_cpm::CasDataConsumer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void batchProcessComplete (ProcessTrace aTrace) throws ResourceProcessException, IOException
void collectionProcessComplete (ProcessTrace aTrace) throws ResourceProcessException, IOException
void destroy ()
Object getConfigParameterValue (String aGroupName, String aParamName)
Object getConfigParameterValue (String aParamName)
Logger getLogger ()
ResourceMetaData getMetaData ()
ProcessingResourceMetaData getProcessingResourceMetaData ()
ResourceManager getResourceManager ()
UimaContext getUimaContext ()
UimaContextAdmin getUimaContextAdmin ()
boolean initialize (ResourceSpecifier aSpecifier, Map< String, Object > aAdditionalParams) throws ResourceInitializationException
boolean isReadOnly ()
boolean isStateless ()
CasData process (CasData aCAS) throws ResourceProcessException
CasData[] process (CasData[] aCASes) throws ResourceProcessException
void reconfigure () throws ResourceConfigurationException
void setConfigParameterValue (String aGroupName, String aParamName, Object aValue)
void setConfigParameterValue (String aParamName, Object aValue)
void setLogger (Logger aLogger)

Static Public Attributes

static final String PARAM_AGGREGATE_SOFA_MAPPINGS = "AGGREGATE_SOFA_MAPPINGS"
static final String PARAM_CONFIG_PARAM_SETTINGS = "CONFIG_PARAM_SETTINGS"
static final String PARAM_PERFORMANCE_TUNING_SETTINGS = "PERFORMANCE_TUNING_SETTINGS"
static final String PARAM_RESOURCE_MANAGER = "RESOURCE_MANAGER"
static final String PARAM_UIMA_CONTEXT = "UIMA_CONTEXT"

Detailed Description

Any component that operates on analysis results produced by a UIMA CasDataProcessor. CASDataConsumers may be registered with a org.apache.uima.collection.CollectionProcessingManager (CPM). During collection processing, the CPM will pass each CasData from CasProcessor to each consumer's process method. The CAS consumer can do anything it wants with the CASes it receives; commonly CAS consumers will build aggregate data structures such as search engine indices or glossaries.

The CPM will also call each CAS Consumer's batchProcessComplete(ProcessTrace) method at the end of each batch and their collectionProcessComplete(ProcessTrace) method called at the end of the collection.

CasConsumers are also ConfigurableResources, and can be instantiated from descriptors. See org.apache.uima.util.XMLParser#parseCasConsumerDescription(XMLInputSource) and org.apache.uima.UIMAFramework#produceCasConsumer(ResourceSpecifier,Map) for more information.

Definition at line 48 of file CasDataConsumer.java.


The documentation for this interface was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index