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

Public Member Functions

org::apache::uima::collection::CollectionProcessingEngine Interface Reference

Inheritance diagram for org::apache::uima::collection::CollectionProcessingEngine:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void addStatusCallbackListener (StatusCallbackListener aListener)
CasProcessor[] getCasProcessors ()
BaseCollectionReader getCollectionReader ()
ProcessTrace getPerformanceReport ()
Progress[] getProgress ()
void initialize (CpeDescription aCpeDescription, Map< String, Object > aAdditionalParams) throws ResourceInitializationException
boolean isPaused ()
boolean isProcessing ()
void kill ()
void pause ()
void process () throws ResourceInitializationException
void removeStatusCallbackListener (StatusCallbackListener aListener)
void resume ()
void stop ()

Detailed Description

A CollectionProcessingEngine (CPE) processes a collection of artifacts (for text analysis applications, this will be a collection of documents) and produces collection-level results.

A CPE consists of a org.apache.uima.collection.CollectionReader, zero or more org.apache.uima.analysis_engine.AnalysisEngines and zero or more org.apache.uima.collection.CasConsumers. The Collection Reader is responsible for reading artifacts from a collection and setting up the CAS. The AnalysisEngines analyze each CAS and the results are passed on to the CAS Consumers. CAS Consumers perform analysis over multiple CASes and generally produce collection-level results in some application-specific data structure.

Processing is started by calling the process() method. Processing can be controlled via thepause(), resume(), and stop() methods.

Listeners can register with the CPE by calling the addStatusCallbackListener(StatusCallbackListener) method. These listeners receive status callbacks during the processing. At any time, performance and progress reports are available from the getPerformanceReport() and getProgress() methods.

A CPE implementation may choose to implement parallelization of the processing, but this is not a requirement of the architecture.

Note that a CPE only supports processing one collection at a time. Attempting to start a new processing job while a previous processing job is running will result in an exception. Processing multiple collections simultaneously is done by instantiating and configuring multiple instances of the CPE.

A CollectionProcessingEngine instance can be obtained by calling org.apache.uima.UIMAFramework#produceCollectionProcessingEngine(CpeDescription).

Definition at line 65 of file CollectionProcessingEngine.java.


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

Generated by  Doxygen 1.6.0   Back to index