Package org.apache.uima.collection

Interface CasConsumer

All Superinterfaces:
CasObjectProcessor, CasProcessor, ConfigurableResource, Resource
All Known Implementing Classes:
AnalysisEngineProcessorAdapter, AnalysisEngineServiceAdapter, CasConsumer_ImplBase, CasProcessorAnnotator, JCasProcessorAnnotator
public interface CasConsumer extends ConfigurableResource, CasObjectProcessor
Any component that operates on analysis results produced by a UIMA analysis engine. CAS Consumers read analysis results from the CAS but may not modify the CAS. (They are read-only CAS Processors.)

CAS Consumers may be registered with a CollectionProcessingManager (CPM). During collection processing, the CPM will pass each CAS from its Analysis Engine to each CAS consumer's process method. The CAS consumer can extract information from the CAS and do anything it wants with that information; commonly CAS consumers will build aggregate data structures such as search engine indexes or glossaries.

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

  • Method Details

    • isReadOnly

      boolean isReadOnly()
      Must return true. By contract, CAS Consumers must be read only.
      Specified by:
      isReadOnly in interface CasProcessor
      Returns:
      true if this CAS processor does not modify the CAS, false if it does.
      See Also: