public interface CasDataConsumer extends ConfigurableResource, CasDataProcessor
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 indexes 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
XMLParser.parseCasConsumerDescription(XMLInputSource) and
UIMAFramework.produceCasConsumer(ResourceSpecifier,Map) for more
information.
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT| Modifier and Type | Method and Description |
|---|---|
void |
batchProcessComplete(ProcessTrace aTrace)
Completes the processing of a batch.
|
void |
collectionProcessComplete(ProcessTrace aTrace)
Completes the processing of an entire collection.
|
getConfigParameterValue, getConfigParameterValue, reconfigure, setConfigParameterValue, setConfigParameterValuedestroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLoggerprocess, processgetProcessingResourceMetaData, isReadOnly, isStatelessvoid batchProcessComplete(ProcessTrace aTrace) throws ResourceProcessException, IOException
batchProcessComplete in interface CasProcessoraTrace - an object that records information, such as timing, about this method's execution.ResourceProcessException - if an exception occurs during processingIOException - if an I/O failure occursvoid collectionProcessComplete(ProcessTrace aTrace) throws ResourceProcessException, IOException
collectionProcessComplete in interface CasProcessoraTrace - an object that records information, such as timing, about this method's execution.ResourceProcessException - if an exception occurs during processingIOException - if an I/O failure occursCopyright © 2006–2017 The Apache Software Foundation. All rights reserved.