de.julielab.jcore.pipeline.runner.cpe

Class StatusCallbackListener

java.lang.Object

de.julielab.jcore.pipeline.runner.cpe.StatusCallbackListener

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.BaseStatusCallbackListener, org.apache.uima.collection.StatusCallbackListener

public class StatusCallbackListener
extends Object
implements org.apache.uima.collection.StatusCallbackListener

Constructor Summary

Constructors

Constructor and Description
StatusCallbackListener(org.apache.uima.collection.CollectionProcessingEngine cpe, Integer batchSize)

Method Summary

Modifier and Type	Method and Description
void	aborted() Called when the CPM is stopped abruptly due to errors.
void	batchProcessComplete() Called when the batchProcessing is completed.
void	collectionProcessComplete() Called when the collection processing is completed.
String	createLog(org.apache.uima.collection.EntityProcessStatus status) Create log entry for an exception that occured during the processing of a document
void	entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus) Called when the processing of a document is completed.
org.apache.uima.collection.CollectionProcessingEngine	getCpe()
void	initializationComplete() Called when the initialization is completed.
void	paused() Called when the CPM is paused.
void	resumed() Called when the CPM is resumed after a pause.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatusCallbackListener

public StatusCallbackListener(org.apache.uima.collection.CollectionProcessingEngine cpe,
                              Integer batchSize)

Method Detail

initializationComplete

public void initializationComplete()

Called when the initialization is completed.

Specified by:

initializationComplete in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

org.apache.uima.collection.processing.StatusCallbackListener#initializationComplete()

batchProcessComplete

public void batchProcessComplete()

Called when the batchProcessing is completed.

Specified by:

batchProcessComplete in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

org.apache.uima.collection.processing.StatusCallbackListener#batchProcessComplete()

collectionProcessComplete

public void collectionProcessComplete()

Called when the collection processing is completed. Exits the application in case it doesn't exit on itself (happens e.g. with JREX because of the ExecutorService; we have problems to shut all of them down).

Specified by:

collectionProcessComplete in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

org.apache.uima.collection.processing.StatusCallbackListener#collectionProcessComplete()

paused

public void paused()

Called when the CPM is paused.

Specified by:

paused in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

org.apache.uima.collection.processing.StatusCallbackListener#paused()

resumed

public void resumed()

Called when the CPM is resumed after a pause.

Specified by:

resumed in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

org.apache.uima.collection.processing.StatusCallbackListener#resumed()

aborted

public void aborted()

Called when the CPM is stopped abruptly due to errors.

Specified by:

aborted in interface org.apache.uima.collection.base_cpm.BaseStatusCallbackListener

See Also:

org.apache.uima.collection.processing.StatusCallbackListener#aborted()

entityProcessComplete

public void entityProcessComplete(org.apache.uima.cas.CAS aCas,
                                  org.apache.uima.collection.EntityProcessStatus aStatus)

Called when the processing of a document is completed.
The process status can be looked at and corresponding actions taken.

Specified by:

entityProcessComplete in interface org.apache.uima.collection.StatusCallbackListener

Parameters:

aCas - CAS corresponding to the completed processing

aStatus - EntityProcessStatus that holds the status of all the events for an entity

createLog

public String createLog(org.apache.uima.collection.EntityProcessStatus status)

Create log entry for an exception that occured during the processing of a document

Parameters:

status - the status that is an exception

getCpe

public org.apache.uima.collection.CollectionProcessingEngine getCpe()