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

Class NonThreadedProcessingUnit

java.lang.Object

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

public class NonThreadedProcessingUnit
extends Object

The Class NonThreadedProcessingUnit.

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	relaseCAS The relase 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.
protected BoundedWorkQueue	workQueue The work queue.

Constructor Summary

Constructors

Constructor and Description
NonThreadedProcessingUnit(CPMEngine acpm) Instantiates a new non threaded processing unit.
NonThreadedProcessingUnit(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) Analyze.
void	cleanup() Null out fields of this object.
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 long	getBytes(Object aCas) Returns the size of the CAS object.
ArrayList	getCallbackListeners() Returns list of listeners used by this PU for callbacks.
protected boolean	isProcessorReady(int aStatus) Check if the CASProcessor status is available for processing.
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.
void	removeStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener) Removes given listener from the list of listeners.
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) Sets the release CAS flag.
void	setUimaTimer(org.apache.uima.util.UimaTimer aTimer) Plugs in custom timer used by the PU for getting time.
void	stopCasProcessors(boolean kill) Stops all Cas Processors that are part of this PU.

Methods inherited from class java.lang.Object

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

Field Detail

threadState

public int threadState

The thread state.

casPool

protected CPECasPool casPool

The cas pool.

relaseCAS

protected boolean relaseCAS

The relase 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.

Constructor Detail

NonThreadedProcessingUnit

public NonThreadedProcessingUnit(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

NonThreadedProcessingUnit

public NonThreadedProcessingUnit(CPMEngine acpm)

Instantiates a new non threaded processing unit.

Parameters:

acpm - the acpm

Method Detail

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

analyze

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

Analyze.

Parameters:

aCasObjectList - the a cas object list

pTrTemp - the tr temp

Returns:

true, if successful

Throws:

Exception - the exception

setReleaseCASFlag

public void setReleaseCASFlag(boolean aFlag)

Sets the release CAS flag.

Parameters:

aFlag - the new release CAS flag

setCasPool

public void setCasPool(CPECasPool aPool)

Sets the cas pool.

Parameters:

aPool - the new cas pool

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

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

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.

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