org.apache.uima.collection.impl.cpm.engine

Class ProcessingUnit

java.lang.Object

java.lang.Thread

org.apache.uima.collection.impl.cpm.engine.ProcessingUnit

All Implemented Interfaces:

Runnable

public class ProcessingUnit
extends Thread

This component executes the processing pipeline. Running in a seperate thread it continuously reads bundles of Cas from the Work Queue filled by ArtifactProducer and sends it through configured CasProcessors. The sequence in which CasProcessors are invoked is defined by the order of Cas Processor listing in the cpe descriptor. The results of analysis produced be Cas Processors is enqueued onto an output queue that is shared with Cas Consumers.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	artifact The artifact.
protected org.apache.uima.cas.CAS[]	casList The cas list.
protected CPECasPool	casPool The cas pool.
protected org.apache.uima.cas.CAS	conversionCas The conversion cas.
protected org.apache.uima.cas.CAS[]	conversionCasArray The conversion cas array.
protected org.apache.uima.collection.metadata.CpeConfiguration	cpeConfiguration The cpe configuration.
protected CPMEngine	cpm The cpm.
protected CasConverter	mConverter The m converter.
protected boolean	notifyListeners The notify listeners.
protected long	numToProcess The num to process.
protected BoundedWorkQueue	outputQueue The output queue.
protected LinkedList	processContainers The process containers.
protected org.apache.uima.util.ProcessTrace	processingUnitProcessTrace The processing unit process trace.
protected boolean	releaseCAS The release CAS.
protected ArrayList	statusCbL The status cb L.
protected String	threadId The thread id.
int	threadState The thread state.
protected org.apache.uima.util.UimaTimer	timer The timer.
long	timer01 The timer 01.
long	timer02 The timer 02.
long	timer03 The timer 03.
long	timer04 The timer 04.
long	timer05 The timer 05.
long	timer06 The timer 06.
protected BoundedWorkQueue	workQueue The work queue.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ProcessingUnit() Instantiates a new processing unit.
ProcessingUnit(CPMEngine acpm) Instantiates a new processing unit.
ProcessingUnit(CPMEngine acpm, BoundedWorkQueue aInputQueue, BoundedWorkQueue aOutputQueue) Initialize the PU.

Method Summary

Modifier and Type	Method and Description
void	addStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener) Plugs in Listener object used for notifications.
protected boolean	analyze(Object[] aCasObjectList, org.apache.uima.util.ProcessTrace pTrTemp) An alternate processing loop designed for the single-threaded CPM.
void	cleanup() Null out fields of this object.
boolean	consumeQueue() Consumes the input queue to make sure all bundles still there get processede before CPE terminates.
void	disableCasProcessor(int aCasProcessorIndex) Disable a CASProcessor in the processing pipeline.
void	disableCasProcessor(String aCasProcessorName) Alternative method to disable Cas Processor.
protected void	doNotifyListeners(Object aCas, boolean isCasObject, org.apache.uima.collection.EntityProcessStatus aEntityProcStatus) Notifies all configured listeners.
void	enableCasProcessor(String aCasProcessorName) Enables Cas Processor with a given name.
protected boolean	endOfProcessingReached(long aCount) Returns true if the CPM has finished analyzing the collection.
protected long	getBytes(Object aCas) Returns the size of the CAS object.
ArrayList	getCallbackListeners() Returns list of listeners used by this PU for callbacks.
boolean	isCasConsumerPipeline() Checks if is cas consumer pipeline.
protected boolean	isProcessorReady(int aStatus) Check if the CASProcessor status is available for processing.
boolean	isRunning() Returns true if this component is in running state.
protected void	notifyListeners(Object aCas, boolean isCasObject, org.apache.uima.collection.EntityProcessStatus aEntityProcStatus) Notifies Listeners of the fact that the pipeline has finished processing the current set Cas'es.
protected void	process(Object anArtifact) Process.
protected boolean	processNext(Object[] aCasObjectList, org.apache.uima.util.ProcessTrace pTrTemp) Executes the processing pipeline.
void	removeStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener) Removes given listener from the list of listeners.
void	run() Starts the Processing Pipeline thread.
void	setCasConsumerPipelineIdentity() Define a CasConsumer Pipeline identity for this instance.
void	setCasPool(CPECasPool aPool) Sets the cas pool.
void	setContainers(LinkedList processorList) Plugs in a list of Cas Processor containers.
void	setCPMEngine(CPMEngine acpm) Alternative method of providing the reference to the component managing the lifecycle of the CPE.
void	setInputQueue(BoundedWorkQueue aInputQueue) Alternative method of providing a queue from which this PU will read bundle of Cas.
void	setNotifyListeners(boolean aDoNotify) Set a flag indicating if notifications should be made via configured Listeners.
void	setOutputQueue(BoundedWorkQueue aOutputQueue) Alternative method of providing a queue where this PU will deposit results of analysis.
void	setProcessingUnitProcessTrace(org.apache.uima.util.ProcessTrace aProcessingUnitProcessTrace) Plugs in ProcessTrace object used to collect statistics.
void	setReleaseCASFlag(boolean aFlag) Called by the CPMEngine during setup to indicate that this thread is supposed to release a CAS at the end of processing.
void	setUimaTimer(org.apache.uima.util.UimaTimer aTimer) Plugs in custom timer used by the PU for getting time.
protected void	showMetadata(Object[] aCasList) Show metadata.
void	stopCasProcessors(boolean kill) Stops all Cas Processors that are part of this PU.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

threadState

public int threadState

The thread state.

casPool

protected CPECasPool casPool

The cas pool.

releaseCAS

protected boolean releaseCAS

The release CAS.

cpm

protected CPMEngine cpm

The cpm.

workQueue

protected BoundedWorkQueue workQueue

The work queue.

outputQueue

protected BoundedWorkQueue outputQueue

The output queue.

mConverter

protected CasConverter mConverter

The m converter.

processingUnitProcessTrace

protected org.apache.uima.util.ProcessTrace processingUnitProcessTrace

The processing unit process trace.

processContainers

protected LinkedList processContainers

The process containers.

numToProcess

protected long numToProcess

The num to process.

casList

protected org.apache.uima.cas.CAS[] casList

The cas list.

statusCbL

protected ArrayList statusCbL

The status cb L.

notifyListeners

protected boolean notifyListeners

The notify listeners.

conversionCas

protected org.apache.uima.cas.CAS conversionCas

The conversion cas.

artifact

protected Object[] artifact

The artifact.

conversionCasArray

protected org.apache.uima.cas.CAS[] conversionCasArray

The conversion cas array.

timer

protected org.apache.uima.util.UimaTimer timer

The timer.

threadId

protected String threadId

The thread id.

cpeConfiguration

protected org.apache.uima.collection.metadata.CpeConfiguration cpeConfiguration

The cpe configuration.

timer01

public long timer01

The timer 01.

timer02

public long timer02

The timer 02.

timer03

public long timer03

The timer 03.

timer04

public long timer04

The timer 04.

timer05

public long timer05

The timer 05.

timer06

public long timer06

The timer 06.

Constructor Detail

ProcessingUnit

public ProcessingUnit()

Instantiates a new processing unit.

ProcessingUnit

public ProcessingUnit(CPMEngine acpm,
                      BoundedWorkQueue aInputQueue,
                      BoundedWorkQueue aOutputQueue)

Initialize the PU.

Parameters:

acpm - - component managing life cycle of the CPE

aInputQueue - - queue to read from

aOutputQueue - - queue to write to

ProcessingUnit

public ProcessingUnit(CPMEngine acpm)

Instantiates a new processing unit.

Parameters:

acpm - the acpm

Method Detail

isRunning

public boolean isRunning()

Returns true if this component is in running state.

Returns:

- true if running, false otherwise

setCasConsumerPipelineIdentity

public void setCasConsumerPipelineIdentity()

Define a CasConsumer Pipeline identity for this instance.

isCasConsumerPipeline

public boolean isCasConsumerPipeline()

Checks if is cas consumer pipeline.

Returns:

true, if is cas consumer pipeline

setInputQueue

public void setInputQueue(BoundedWorkQueue aInputQueue)

Alternative method of providing a queue from which this PU will read bundle of Cas.

Parameters:

aInputQueue - - read queue

setOutputQueue

public void setOutputQueue(BoundedWorkQueue aOutputQueue)

Alternative method of providing a queue where this PU will deposit results of analysis.

Parameters:

aOutputQueue - - queue to write to

setCPMEngine

public void setCPMEngine(CPMEngine acpm)

Alternative method of providing the reference to the component managing the lifecycle of the CPE.

Parameters:

acpm - - reference to the contrlling engine

cleanup

public void cleanup()

Null out fields of this object. Call this only when this object is no longer needed.

setNotifyListeners

public void setNotifyListeners(boolean aDoNotify)

Set a flag indicating if notifications should be made via configured Listeners.

Parameters:

aDoNotify - - true if notification is required, false otherwise

addStatusCallbackListener

public void addStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener)

Plugs in Listener object used for notifications.

Parameters:

aListener - - BaseStatusCallbackListener instance

getCallbackListeners

public ArrayList getCallbackListeners()

Returns list of listeners used by this PU for callbacks.

Returns:

- lif of BaseStatusCallbackListener instances

removeStatusCallbackListener

public void removeStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener)

Removes given listener from the list of listeners.

Parameters:

aListener - - object to remove from the list

setProcessingUnitProcessTrace

public void setProcessingUnitProcessTrace(org.apache.uima.util.ProcessTrace aProcessingUnitProcessTrace)

Plugs in ProcessTrace object used to collect statistics.

Parameters:

aProcessingUnitProcessTrace - - object to compile stats

setUimaTimer

public void setUimaTimer(org.apache.uima.util.UimaTimer aTimer)

Plugs in custom timer used by the PU for getting time.

Parameters:

aTimer - - custom timer to use

setContainers

public void setContainers(LinkedList processorList)

Plugs in a list of Cas Processor containers. During processing Cas Processors in this list are called sequentially. Each Cas Processor is contained in the container that is managing errors, counts and totals, and restarts.

Parameters:

processorList - CASProcessor to be added to the processing pipeline

disableCasProcessor

public void disableCasProcessor(int aCasProcessorIndex)

Disable a CASProcessor in the processing pipeline. Locate it by provided index. The disabled Cas Processor remains in the Processing Pipeline, however it is not used furing processing.

Parameters:

aCasProcessorIndex - - location in the pipeline of the Cas Processor to delete

disableCasProcessor

public void disableCasProcessor(String aCasProcessorName)

Alternative method to disable Cas Processor. Uses a name to locate it.

Parameters:

aCasProcessorName - - a name of the Cas Processor to disable

enableCasProcessor

public void enableCasProcessor(String aCasProcessorName)

Enables Cas Processor with a given name. Enabled Cas Processor will immediately begin to receive bundles of Cas.

Parameters:

aCasProcessorName - - name of the Cas Processor to enable

run

public void run()

Starts the Processing Pipeline thread. This thread waits for an artifact to arrive on configured Work Queue. Once the CAS arrives, it is removed from the queue and sent through the analysis pipeline.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

consumeQueue

public boolean consumeQueue()

Consumes the input queue to make sure all bundles still there get processede before CPE terminates.

Returns:

true, if successful

processNext

protected boolean processNext(Object[] aCasObjectList,
                              org.apache.uima.util.ProcessTrace pTrTemp)
                       throws org.apache.uima.resource.ResourceProcessException,
                              IOException,
                              org.apache.uima.collection.CollectionException,
                              org.apache.uima.collection.base_cpm.AbortCPMException,
                              KillPipelineException

Executes the processing pipeline. Given bundle of Cas instances is processed by each Cas Processor in the pipeline. Conversions between different types of Cas Processors is done on the fly. Two types of Cas Processors are currently supported:

• CasDataProcessor
• CasObjectProcessor

The first operates on instances of CasData the latter operates on instances of CAS. The results produced by Cas Processors are added to the output queue.

Parameters:

aCasObjectList - - bundle of Cas to analyze

pTrTemp - - object used to aggregate stats

Returns:

true, if successful

Throws:

org.apache.uima.resource.ResourceProcessException - the resource process exception

IOException - Signals that an I/O exception has occurred.

org.apache.uima.collection.CollectionException - the collection exception

org.apache.uima.collection.base_cpm.AbortCPMException - the abort CPM exception

KillPipelineException - the kill pipeline exception

notifyListeners

protected void notifyListeners(Object aCas,
                               boolean isCasObject,
                               org.apache.uima.collection.EntityProcessStatus aEntityProcStatus)

Notifies Listeners of the fact that the pipeline has finished processing the current set Cas'es.

Parameters:

aCas - - object containing an array of OR a single instance of Cas

isCasObject - - true if instance of Cas is of type Cas, false otherwise

aEntityProcStatus - - status object that may contain exceptions and trace

doNotifyListeners

protected void doNotifyListeners(Object aCas,
                                 boolean isCasObject,
                                 org.apache.uima.collection.EntityProcessStatus aEntityProcStatus)

Notifies all configured listeners. Makes sure that appropriate type of Cas is sent to the listener. Convertions take place to ensure compatibility.

Parameters:

aCas - - Cas to pass to listener

isCasObject - - true is Cas is of type CAS

aEntityProcStatus - - status object containing exceptions and trace info

setReleaseCASFlag

public void setReleaseCASFlag(boolean aFlag)

Called by the CPMEngine during setup to indicate that this thread is supposed to release a CAS at the end of processing. This is typically done for Cas Consumer thread, but in configurations not using Cas Consumers The processing pipeline may also release the CAS.

Parameters:

aFlag - - true if this thread should release a CAS when analysis is complete

stopCasProcessors

public void stopCasProcessors(boolean kill)

Stops all Cas Processors that are part of this PU.

Parameters:

kill - - true if CPE has been stopped before finishing processing during external stop

endOfProcessingReached

protected boolean endOfProcessingReached(long aCount)

Returns true if the CPM has finished analyzing the collection.

Parameters:

aCount - - running total of documents processed so far

Returns:

- true if CPM has processed all docs, false otherwise

process

protected void process(Object anArtifact)

Process.

Parameters:

anArtifact - the an artifact

showMetadata

protected void showMetadata(Object[] aCasList)

Show metadata.

Parameters:

aCasList - the a cas list

isProcessorReady

protected boolean isProcessorReady(int aStatus)

Check if the CASProcessor status is available for processing.

Parameters:

aStatus - the a status

Returns:

true, if is processor ready

getBytes

protected long getBytes(Object aCas)

Returns the size of the CAS object. Currently only CASData is supported.

Parameters:

aCas - - Cas to get the size for

Returns:

the size of the CAS object. Currently only CASData is supported.

setCasPool

public void setCasPool(CPECasPool aPool)

Sets the cas pool.

Parameters:

aPool - the new cas pool

analyze

protected boolean analyze(Object[] aCasObjectList,
                          org.apache.uima.util.ProcessTrace pTrTemp)
                   throws Exception

An alternate processing loop designed for the single-threaded CPM.

Parameters:

aCasObjectList - - a list of CASes to analyze

pTrTemp - - process trace where statistics are added during analysis

Returns:

true, if successful

Throws:

Exception - the exception