org.apache.uima.collection.impl.cpm.container

Class ProcessingContainer_Impl

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.collection.impl.base_cpm.container.ProcessingContainer

org.apache.uima.collection.impl.cpm.container.ProcessingContainer_Impl

All Implemented Interfaces:

Runnable, CasProcessorController, RunnableContainer, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

public class ProcessingContainer_Impl
extends ProcessingContainer
implements RunnableContainer

Manages a pool of CasProcessor instances. Provides access to CasProcessor instance to Processing Thread. Processing threads check out an instance of Cas Processor and when done invoking its process() method return it back to pool. The container aggregates counts and totals on behalf of all instances of Cas Processor. It also manages error and restart thresholds for Cas Processors as a group. Errors are aggregated for all instances of Cas Processor as a group NOT individually. The container takes appropriate actions when threshold are exceeded. What action is taken depends on declaritive specification in the cpe descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
ServiceProxyPool	casProcessorPool The cas processor pool.
LinkedList	failedCasProcessorList The failed cas processor list.

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Fields inherited from interface org.apache.uima.collection.impl.base_cpm.container.CasProcessorController

DISABLED, INITIALIZED, KILLED, NOTINITIALIZED, RUNNING

Constructor Summary

Constructors

Constructor and Description
ProcessingContainer_Impl(CasProcessorConfiguration aCasProcessorConfig, org.apache.uima.resource.metadata.ProcessingResourceMetaData aMetaData, ServiceProxyPool aCasProcessorPool) Initialize container with CasProcessor configuration and pool containing instances of CasProcessor instances.

Method Summary

Modifier and Type	Method and Description
boolean	abortCPMOnError() Returns true if maximum threshold for errors has been exceeded and the CasProcessor is configured to force CPE shutdown.
void	addBytesIn(long aBytesIn) Aggregate total bytes ingested by the CasProcessor.
void	addBytesOut(long aBytesOut) Aggregate total bytes processed by this CasProcessor.
void	addStat(String aStatName, Object aStat) Add an arbitrary object and bind it to a given name.
void	destroy() Destroy instances of CasProcessors managed by this container.
int	getAbortCount() Return the up todate number of aborts recorded by the container.
HashMap	getAllStats() Returns all stats aggregate during the CPM run.
long	getBytesIn() Returns total number of bytes ingested so far by all CasProcessor instances managed by this container.
long	getBytesOut() Returns total number of bytes processed so far by all CasProcessor instances managed by this container.
org.apache.uima.collection.base_cpm.CasProcessor	getCasProcessor() Returns available instance of the CasProcessor from the instance pool.
CasProcessorConfiguration	getCasProcessorConfiguration() Returns CasProcessor configuration object.
Object	getConfigParameterValue(String aParamName)
Object	getConfigParameterValue(String aGroupName, String aParamName)
CasProcessorDeployer	getDeployer() Returns deployer object used to launch the CasProcessor.
long	getFetchTime() Gets the fetch time.
int	getFilteredCount() Returns number of filtered Cas'es.
Object	getLastCas() Deprecated.
String	getLastProcessedEntityId() Returns id of the last entity processed by the CasProcessor.
org.apache.uima.resource.metadata.ProcessingResourceMetaData	getMetadata() Returns component's input/output capabilities.
org.apache.uima.resource.metadata.ResourceMetaData	getMetaData()
String	getName() Returns the name of this container.
ServiceProxyPool	getPool()
long	getProcessed() Returns number of entities processed so far.
long	getRemaining() Returns number of entities still to be processed by the CasProcessor It is a delta of total number of entities to be processed by the CPE minus number of entities processed so far.
int	getRestartCount() Returns total number of all CasProcessor restarts.
int	getRetryCount() Return the up todate number of retries recorded by the container.
Object	getStat(String aStatName) Return an abject identified with a given name.
int	getStatus() Returns the current status of the CasProcessor.
long	getTotalTime() Returns total time spent in process().
void	incrementAbortCount(int aCount) Increment number of aborted Cas'es due to inability to process the Cas.
void	incrementCasProcessorErrors(Throwable aThrowable) This routine determines what to do with an exception thrown during the CasProcessor processing.
void	incrementFilteredCount(int aCount) Increments number of CAS'es filtered by the CasProcessor.
void	incrementProcessed(int aIncrement) Increment processed.
void	incrementRestartCount(int aCount) Increment number of times the casProcessor was restarted due to failures.
void	incrementRetryCount(int aCount) Increments number of times CasProceesor failed analyzing Cas'es due to timeout or some other problems.
void	incrementStat(String aStatName, Integer aStat) Increment a value of a given stat.
void	incrementTotalTime(long aTime) Increments total time spend in the process() method of the CasProcessor.
boolean	initialize(org.apache.uima.resource.ResourceSpecifier aSpecifier, Map aAdditionalParams)
boolean	isAbortable() Determines if instances of CasProcessor managed by this container are abortable.
boolean	isEndOfBatch(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor, int aProcessedSize)
boolean	isIntegrated() Deprecated.
boolean	isLocal() Deprecated.
boolean	isPaused()
boolean	isRemote() Deprecated.
boolean	isSingleFencedService()
void	logAbortedCases(Object[] abortedCasList) Logs Cas'es that could not be processed.
void	pause() Pauses the container until resumed.
boolean	processCas(Object[] aCasList) Returns true if the Cas bundles should be processed by the CasProcessor.
void	reconfigure()
void	releaseCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor) Returns a given casProcessor instance back to the pool.
void	resetRestartCount()
void	resume()
void	run()
void	setCasProcessorDeployer(CasProcessorDeployer aDeployer) Plug in deployer object used to launch/deploy the CasProcessor instance.
void	setConfigParameterValue(String aParamName, Object aValue)
void	setConfigParameterValue(String aGroupName, String aParamName, Object aValue)
void	setLastCas(Object aCasObject) Deprecated.
void	setLastProcessedEntityId(String aEntityId) Copies id of the last entity processed by the CasProcessor.
void	setMetadata(org.apache.uima.resource.metadata.ProcessingResourceMetaData aMetadata) Sets component's input/output capabilities.
void	setProcessed(long aProcessedCount) Used when recovering from checkpoint, sets the total number of entities before CPE stopped.
void	setRemaining(long aRemainingCount) Copies number of entities the CasProcessor has yet to process.
void	setSingleFencedService(boolean aSingleFencedInstance)
void	setStatus(int aStatus) Changes the status of the CasProcessor as a group.
void	start() Deprecated.
void	stop() Deprecated.

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

getCasManager, getLogger, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, loadUserClass, loadUserClassOrThrow, setContextHolder, setContextHolderX, setLogger, setMetaData, withContextHolder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.resource.Resource

getLogger, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

casProcessorPool

public ServiceProxyPool casProcessorPool

The cas processor pool.

failedCasProcessorList

public LinkedList failedCasProcessorList

The failed cas processor list.

Constructor Detail

ProcessingContainer_Impl

public ProcessingContainer_Impl(CasProcessorConfiguration aCasProcessorConfig,
                                org.apache.uima.resource.metadata.ProcessingResourceMetaData aMetaData,
                                ServiceProxyPool aCasProcessorPool)
                         throws org.apache.uima.resource.ResourceConfigurationException

Initialize container with CasProcessor configuration and pool containing instances of CasProcessor instances.

Parameters:

aCasProcessorConfig - - CasProcessor configuration as defined in cpe descriptor

aMetaData - the a meta data

aCasProcessorPool - - pool of CasProcessor instances

Throws:

org.apache.uima.resource.ResourceConfigurationException - the resource configuration exception

Method Detail

getMetadata

public org.apache.uima.resource.metadata.ProcessingResourceMetaData getMetadata()

Returns component's input/output capabilities.

Returns:

the metadata

setMetadata

public void setMetadata(org.apache.uima.resource.metadata.ProcessingResourceMetaData aMetadata)

Sets component's input/output capabilities.

Specified by:

setMetadata in class ProcessingContainer

Parameters:

aMetadata - component capabilities

setCasProcessorDeployer

public void setCasProcessorDeployer(CasProcessorDeployer aDeployer)

Plug in deployer object used to launch/deploy the CasProcessor instance. Used for restarts.

Specified by:

setCasProcessorDeployer in class ProcessingContainer

Parameters:

aDeployer - - object responsible for deploying/launching CasProcessor

getDeployer

public CasProcessorDeployer getDeployer()

Returns deployer object used to launch the CasProcessor.

Specified by:

getDeployer in class ProcessingContainer

Returns:

- CasProcessorDeployer - deployer object

logAbortedCases

public void logAbortedCases(Object[] abortedCasList)

Logs Cas'es that could not be processed.

Specified by:

logAbortedCases in class ProcessingContainer

Parameters:

abortedCasList - - an arrar of Cas'es that could not be processed by this CasProcessor

getBytesIn

public long getBytesIn()

Returns total number of bytes ingested so far by all CasProcessor instances managed by this container.

Specified by:

getBytesIn in class ProcessingContainer

Returns:

- bytes processed

addBytesIn

public void addBytesIn(long aBytesIn)

Aggregate total bytes ingested by the CasProcessor.

Specified by:

addBytesIn in class ProcessingContainer

Parameters:

aBytesIn - - number of ingested bytes

getBytesOut

public long getBytesOut()

Returns total number of bytes processed so far by all CasProcessor instances managed by this container.

Specified by:

getBytesOut in class ProcessingContainer

Returns:

- bytes processed

addBytesOut

public void addBytesOut(long aBytesOut)

Aggregate total bytes processed by this CasProcessor.

Specified by:

addBytesOut in class ProcessingContainer

Parameters:

aBytesOut - the a bytes out

incrementRestartCount

public void incrementRestartCount(int aCount)

Increment number of times the casProcessor was restarted due to failures.

Specified by:

incrementRestartCount in class ProcessingContainer

Parameters:

aCount - - restart count

getRestartCount

public int getRestartCount()

Returns total number of all CasProcessor restarts.

Specified by:

getRestartCount in class ProcessingContainer

Returns:

number of restarts

incrementRetryCount

public void incrementRetryCount(int aCount)

Increments number of times CasProceesor failed analyzing Cas'es due to timeout or some other problems.

Specified by:

incrementRetryCount in class ProcessingContainer

Parameters:

aCount - - failure count

getRetryCount

public int getRetryCount()

Return the up todate number of retries recorded by the container.

Specified by:

getRetryCount in class ProcessingContainer

Returns:

- retry count

incrementAbortCount

public void incrementAbortCount(int aCount)

Increment number of aborted Cas'es due to inability to process the Cas.

Specified by:

incrementAbortCount in class ProcessingContainer

Parameters:

aCount - - number of aborts while processing Cas'es

getAbortCount

public int getAbortCount()

Return the up todate number of aborts recorded by the container.

Specified by:

getAbortCount in class ProcessingContainer

Returns:

- number of failed attempts to analyze CAS'es

incrementFilteredCount

public void incrementFilteredCount(int aCount)

Increments number of CAS'es filtered by the CasProcessor. Filtered CAS'es dont contain required features. Features that are required by the Cas Processor to perform analysis. Dependant feateurs are defined in the filter expression in the CPE descriptor

Specified by:

incrementFilteredCount in class ProcessingContainer

Parameters:

aCount - - number of filtered Cas'es

getFilteredCount

public int getFilteredCount()

Returns number of filtered Cas'es.

Specified by:

getFilteredCount in class ProcessingContainer

Returns:

# of filtered Cas'es

getRemaining

public long getRemaining()

Returns number of entities still to be processed by the CasProcessor It is a delta of total number of entities to be processed by the CPE minus number of entities processed so far.

Specified by:

getRemaining in class ProcessingContainer

Returns:

Number of entities yet to be processed

setRemaining

public void setRemaining(long aRemainingCount)

Copies number of entities the CasProcessor has yet to process.

Specified by:

setRemaining in class ProcessingContainer

Parameters:

aRemainingCount - - number of entities to process

setLastProcessedEntityId

public void setLastProcessedEntityId(String aEntityId)

Copies id of the last entity processed by the CasProcessor.

Specified by:

setLastProcessedEntityId in class ProcessingContainer

Parameters:

aEntityId - - id of the entity

getLastProcessedEntityId

public String getLastProcessedEntityId()

Returns id of the last entity processed by the CasProcessor.

Specified by:

getLastProcessedEntityId in class ProcessingContainer

Returns:

- id of entity

setLastCas

@Deprecated
public void setLastCas(Object aCasObject)

Deprecated.

Copies the last Cas Processed.

Specified by:

setLastCas in class ProcessingContainer

Parameters:

aCasObject - the new last cas

getLastCas

@Deprecated
public Object getLastCas()

Deprecated.

Returns the last Cas processed.

Specified by:

getLastCas in class ProcessingContainer

Returns:

the last cas

incrementProcessed

public void incrementProcessed(int aIncrement)

Increment processed.

Parameters:

aIncrement - the a increment

setProcessed

public void setProcessed(long aProcessedCount)

Used when recovering from checkpoint, sets the total number of entities before CPE stopped.

Specified by:

setProcessed in class ProcessingContainer

Parameters:

aProcessedCount - - number of entities processed before CPE stopped

getProcessed

public long getProcessed()

Returns number of entities processed so far.

Specified by:

getProcessed in class ProcessingContainer

Returns:

- processed - number of entities processed

resetRestartCount

public void resetRestartCount()

Specified by:

resetRestartCount in class ProcessingContainer

incrementTotalTime

public void incrementTotalTime(long aTime)

Increments total time spend in the process() method of the CasProcessor.

Specified by:

incrementTotalTime in class ProcessingContainer

Parameters:

aTime - - total time in process()

getTotalTime

public long getTotalTime()

Returns total time spent in process().

Specified by:

getTotalTime in class ProcessingContainer

Returns:

- number of millis spent in process()

abortCPMOnError

public boolean abortCPMOnError()

Returns true if maximum threshold for errors has been exceeded and the CasProcessor is configured to force CPE shutdown. It looks at the value of the action attribute of the <errorRateThreshold> element in the cpe descriptor.

Specified by:

abortCPMOnError in class ProcessingContainer

Returns:

- true if the CPE should stop processing, false otherwise

incrementCasProcessorErrors

public void incrementCasProcessorErrors(Throwable aThrowable)
                                 throws Exception

This routine determines what to do with an exception thrown during the CasProcessor processing. It interprets given exception and throws a new one according to configuration specified in the CPE descriptor. It examines provided thresholds and determines if the CPE should continue to run, if it should disable the CasProcessor (and all its instances), or disregard the error and continue.

Specified by:

incrementCasProcessorErrors in class ProcessingContainer

Parameters:

aThrowable - - exception to examine

Throws:

Exception - the exception

isEndOfBatch

public boolean isEndOfBatch(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor,
                            int aProcessedSize)
                     throws org.apache.uima.resource.ResourceProcessException,
                            IOException

Specified by:

isEndOfBatch in class ProcessingContainer

Throws:

org.apache.uima.resource.ResourceProcessException

IOException

processCas

public boolean processCas(Object[] aCasList)

Returns true if the Cas bundles should be processed by the CasProcessor. This routine checks for existance of dependent featues defined in the filter expression defined for the CasProcessor in the cpe descriptor. Currently this is done on per bundle basis. Meaning that all Cas'es must contain required features. If even one Cas does not have them, the entire bundle is skipped.

Specified by:

processCas in class ProcessingContainer

Parameters:

aCasList - - bundle containing instances of CAS

Returns:

true, if successful

getCasProcessorConfiguration

public CasProcessorConfiguration getCasProcessorConfiguration()

Returns CasProcessor configuration object. This object represents xml configuration defined in the <casProcessor> section of the cpe descriptor.

Specified by:

getCasProcessorConfiguration in class ProcessingContainer

Returns:

CasProcessorConfiguration instance

start

@Deprecated
public void start()

Deprecated.

Start.

Specified by:

start in interface RunnableContainer

stop

@Deprecated
public void stop()

Deprecated.

Stop.

Specified by:

stop in interface RunnableContainer

getCasProcessor

public org.apache.uima.collection.base_cpm.CasProcessor getCasProcessor()

Returns available instance of the CasProcessor from the instance pool. It will wait indefinitely until an instance is available.

Specified by:

getCasProcessor in interface CasProcessorController

Returns:

the cas processor

releaseCasProcessor

public void releaseCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor)

Returns a given casProcessor instance back to the pool.

Specified by:

releaseCasProcessor in class ProcessingContainer

Parameters:

aCasProcessor - - an instance of CasProcessor to return back to the pool

See Also:

ProcessingContainer.releaseCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor)

getStatus

public int getStatus()

Returns the current status of the CasProcessor.

Specified by:

getStatus in interface CasProcessorController

Returns:

the status

setStatus

public void setStatus(int aStatus)

Changes the status of the CasProcessor as a group.

Specified by:

setStatus in interface CasProcessorController

Parameters:

aStatus - - new status

isLocal

@Deprecated
public boolean isLocal()

Deprecated.

Checks if is local.

Specified by:

isLocal in interface CasProcessorController

Returns:

true, if is local

isRemote

@Deprecated
public boolean isRemote()

Deprecated.

Checks if is remote.

Specified by:

isRemote in interface CasProcessorController

Returns:

true, if is remote

isIntegrated

@Deprecated
public boolean isIntegrated()

Deprecated.

Checks if is integrated.

Specified by:

isIntegrated in interface CasProcessorController

Returns:

true, if is integrated

isAbortable

public boolean isAbortable()

Determines if instances of CasProcessor managed by this container are abortable. Abortable CasProcessor's action attribute in the <errorRateThreshold> element has a value of 'disable'.

Specified by:

isAbortable in interface CasProcessorController

Returns:

true if CasProcessor can be disabled

initialize

public boolean initialize(org.apache.uima.resource.ResourceSpecifier aSpecifier,
                          Map aAdditionalParams)
                   throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.resource.Resource

Overrides:

initialize in class org.apache.uima.resource.Resource_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

destroy

public void destroy()

Destroy instances of CasProcessors managed by this container. Before destroying the instance, this method notifies it with CollectionProcessComplete so that the component finalizes its logic and does appropriate cleanup before shutdown.

Specified by:

destroy in interface org.apache.uima.resource.Resource

Overrides:

destroy in class org.apache.uima.resource.Resource_ImplBase

run

public void run()

Specified by:

run in interface Runnable

getConfigParameterValue

public Object getConfigParameterValue(String aParamName)

Specified by:

getConfigParameterValue in interface org.apache.uima.resource.ConfigurableResource

getConfigParameterValue

public Object getConfigParameterValue(String aGroupName,
                                      String aParamName)

Specified by:

getConfigParameterValue in interface org.apache.uima.resource.ConfigurableResource

setConfigParameterValue

public void setConfigParameterValue(String aParamName,
                                    Object aValue)

Specified by:

setConfigParameterValue in interface org.apache.uima.resource.ConfigurableResource

setConfigParameterValue

public void setConfigParameterValue(String aGroupName,
                                    String aParamName,
                                    Object aValue)

Specified by:

setConfigParameterValue in interface org.apache.uima.resource.ConfigurableResource

reconfigure

public void reconfigure()
                 throws org.apache.uima.resource.ResourceConfigurationException

Specified by:

reconfigure in interface org.apache.uima.resource.ConfigurableResource

Throws:

org.apache.uima.resource.ResourceConfigurationException

getName

public String getName()

Returns the name of this container. It is the name of the Cas Processor.

Specified by:

getName in class ProcessingContainer

Returns:

the name

getMetaData

public org.apache.uima.resource.metadata.ResourceMetaData getMetaData()

Specified by:

getMetaData in interface org.apache.uima.resource.Resource

Overrides:

getMetaData in class org.apache.uima.resource.Resource_ImplBase

incrementStat

public void incrementStat(String aStatName,
                          Integer aStat)

Increment a value of a given stat.

Specified by:

incrementStat in class ProcessingContainer

Parameters:

aStatName - the a stat name

aStat - the a stat

addStat

public void addStat(String aStatName,
                    Object aStat)

Add an arbitrary object and bind it to a given name.

Specified by:

addStat in class ProcessingContainer

Parameters:

aStatName - the a stat name

aStat - the a stat

getStat

public Object getStat(String aStatName)

Return an abject identified with a given name.

Specified by:

getStat in class ProcessingContainer

Parameters:

aStatName - the a stat name

Returns:

the stat

getAllStats

public HashMap getAllStats()

Returns all stats aggregate during the CPM run.

Specified by:

getAllStats in class ProcessingContainer

Returns:

a map of all stats aggregated during the CPM run

pause

public void pause()

Pauses the container until resumed. The CPM will pause to the Container while it is trying to re-connect to a shared remote service. While the Container is paused getCasProcessor() will not be allowed to return a new CasProcessor. All other methods are accessible and will function fine.

Specified by:

pause in class ProcessingContainer

resume

public void resume()

Specified by:

resume in class ProcessingContainer

isPaused

public boolean isPaused()

Specified by:

isPaused in class ProcessingContainer

getPool

public ServiceProxyPool getPool()

Specified by:

getPool in class ProcessingContainer

setSingleFencedService

public void setSingleFencedService(boolean aSingleFencedInstance)

Specified by:

setSingleFencedService in class ProcessingContainer

isSingleFencedService

public boolean isSingleFencedService()

Specified by:

isSingleFencedService in class ProcessingContainer

getFetchTime

public long getFetchTime()

Gets the fetch time.

Returns:

the fetch time