Interface BaseCPM
CollectionProcessingEngine
and CpeDescription interfaces instead.
The CPM is configured with a list of CasProcessors by calling its
addCasProcessor(CasProcessor) method. A single BaseCollectionReader must be
provided, via the setCollectionReader(BaseCollectionReader) method. Collection
processing is then initiated by calling the process() method.
Listeners can register with the CPM by calling the
addStatusCallbackListener(BaseStatusCallbackListener) 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 CPM implementation may choose to implement parallelization of the processing, but this is not a requirement of the architecture.
Note that a CPM only supports processing one collection at a time. Attempting to reconfigure a
CPM or start a new processing job while a previous processing job is occurring will result in a
UIMA_IllegalStateException. Processing multiple collections
simultaneously is done by instantiating and configuring multiple instances of the CPM.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCasProcessor(CasProcessor aCasProcessor) Adds aCasProcessorto this CPM's list of consumers.voidaddCasProcessor(CasProcessor aCasProcessor, int aIndex) Adds aCasProcessorto this CPM's list of consumers.voidRegisters a listsner to receive status callbacks.voiddisableCasProcessor(String aCasProcessorName) Disables aCasProcessorin this CPM's list of CasProcessors.Gets theCasProcessorss assigned to this CPM, in the order in which they will be called by the CPM.Gets the Collection Reader for this CPM.Gets a performance report for the processing that is currently occurring or has just completed.Progress[]Gets a progress report for the processing that is currently occurring or has just completed.booleanisPaused()Determines whether this CPM's processing is currently paused.booleanGets whether this CPM will automatically pause processing if an exception occurs.booleanDetermines whether this CPM is currently processing.booleanGets whether this CPM is required to process the collection's elements serially (as opposed to performing parallelization).voidpause()Pauses processing.voidprocess()Initiates processing of a collection.voidremoveCasProcessor(CasProcessor aCasProcessor) Removes aCasProcessorto this CPM's list of consumers.voidUnregisters a status callback listener.voidresume()Resumes processing that has been paused.voidresume(boolean aRetryFailed) Resumes processing that has been paused.voidsetCollectionReader(BaseCollectionReader aCollectionReader) Sets the Collection Reader for this CPM.voidsetPauseOnException(boolean aPause) Sets whether this CPM will automatically pause processing if an exception occurs.voidsetSerialProcessingRequired(boolean aRequired) Sets whether this CPM is required to process the collection's elements serially (as opposed to performing parallelization).voidstop()Stops processing.
-
Field Details
-
DOCUMENT_TEXT_TYPE
Only used for alternate CasData forms of the CAS (not used in this UIMA SDK release). Name of CasData CAS type that holds document text. When creating CasData forms of the CAS, a feature structure of this type must be created by the collection reader.- See Also:
-
DOCUMENT_TEXT_FEATURE
Only used for alternate CasData forms of the CAS (not used in this UIMA SDK release). Name of CAS feature (on DOCUMENT_TEXT_TYPE feature structure) that holds document text. When creating CasDta forms of the CAS, this feature must be set by the collection reader.- See Also:
-
-
Method Details
-
getCollectionReader
BaseCollectionReader getCollectionReader()Gets the Collection Reader for this CPM.- Returns:
- the collection reader
-
setCollectionReader
Sets the Collection Reader for this CPM.- Parameters:
aCollectionReader- the collection reader
-
getCasProcessors
CasProcessor[] getCasProcessors()Gets theCasProcessorss assigned to this CPM, in the order in which they will be called by the CPM.- Returns:
- an array of
CasProcessors
-
addCasProcessor
Adds aCasProcessorto this CPM's list of consumers. The new CasProcessor will be added to the end of the list of CAS Processors.- Parameters:
aCasProcessor- aCasProcessorto add- Throws:
ResourceConfigurationException- if this CPM is currently processing
-
addCasProcessor
Adds aCasProcessorto this CPM's list of consumers. The new CasProcessor will be added at the specified index.- Parameters:
aCasProcessor- the CasProcessor to addaIndex- the index at which to add the CasProcessor- Throws:
ResourceConfigurationException- if this CPM is currently processing
-
removeCasProcessor
Removes aCasProcessorto this CPM's list of consumers.- Parameters:
aCasProcessor- theCasProcessorto remove
-
disableCasProcessor
Disables aCasProcessorin this CPM's list of CasProcessors.- Parameters:
aCasProcessorName- the name of theCasProcessorto disable
-
isSerialProcessingRequired
boolean isSerialProcessingRequired()Gets whether this CPM is required to process the collection's elements serially (as opposed to performing parallelization). Note that a value offalsedoes not guarantee that parallelization is performed; this is left up to the CPM implementation.- Returns:
- true if and only if serial processing is required
-
setSerialProcessingRequired
void setSerialProcessingRequired(boolean aRequired) Sets whether this CPM is required to process the collection's elements serially (as opposed to performing parallelization). If this method is not called, the default isfalse. Note that a value offalsedoes not guarantee that parallelization is performed; this is left up to the CPM implementation.- Parameters:
aRequired- true if and only if serial processing is required
-
isPauseOnException
boolean isPauseOnException()Gets whether this CPM will automatically pause processing if an exception occurs. If processing is paused it can be resumed by calling theresume(boolean)method.- Returns:
- true if and only if this CPM will pause on exception
-
setPauseOnException
void setPauseOnException(boolean aPause) Sets whether this CPM will automatically pause processing if an exception occurs. If processing is paused it can be resumed by calling theresume(boolean)method.- Parameters:
aPause- true if and only if this CPM should pause on exception
-
addStatusCallbackListener
Registers a listsner to receive status callbacks.- Parameters:
aListener- the listener to add
-
removeStatusCallbackListener
Unregisters a status callback listener.- Parameters:
aListener- the listener to remove
-
process
Initiates processing of a collection. This method starts the processing in another thread and returns immediately. Status of the processing can be obtained by registering a listener with theaddStatusCallbackListener(BaseStatusCallbackListener)method.A CPM can only process one collection at a time. If this method is called while a previous processing request has not yet completed, a
UIMA_IllegalStateExceptionwill result. To find out whether a CPM is free to begin another processing request, call theisProcessing()method.- Throws:
ResourceInitializationException- if an error occurs during initialization
-
isProcessing
boolean isProcessing()Determines whether this CPM is currently processing. This means that a processing request has been submitted and has not yet completed or beenstop()ped. If processing is paused, this method will still returntrue.- Returns:
- true if and only if this CPM is currently processing.
-
pause
void pause()Pauses processing. Processing can later be resumed by calling theresume(boolean)method. -
isPaused
boolean isPaused()Determines whether this CPM's processing is currently paused.- Returns:
- true if and only if this CPM's processing is currently paused.
-
resume
void resume(boolean aRetryFailed) Resumes processing that has been paused.- Parameters:
aRetryFailed- if processing was paused because an exception occurred (seesetPauseOnException(boolean)), setting a value oftruefor this parameter will cause the failed entity to be retried. A value offalse(the default) will cause processing to continue with the next entity after the failure.
-
resume
void resume()Resumes processing that has been paused. -
stop
void stop()Stops processing. -
getPerformanceReport
ProcessTrace getPerformanceReport()Gets a performance report for the processing that is currently occurring or has just completed.- Returns:
- an object containing performance statistics
-
getProgress
Progress[] getProgress()Gets a progress report for the processing that is currently occurring or has just completed.- Returns:
- an array of
Progressobjects, each of which represents the progress in a different set of units (for example number of entities or bytes)
-