org.apache.uima.collection.impl.cpm

Class BaseCPMImpl

java.lang.Object

org.apache.uima.collection.impl.cpm.BaseCPMImpl

All Implemented Interfaces:

Runnable, org.apache.uima.collection.base_cpm.BaseCPM

Direct Known Subclasses:

CPMImpl

public class BaseCPMImpl
extends Object
implements org.apache.uima.collection.base_cpm.BaseCPM, Runnable

Main thread that launches CPE and manages it. An application interacts with the running CPE via this object. Through an API, an application may start, pause, resume, and stop a CPE.

Field Summary

Fields

Modifier and Type	Field and Description
CPMThreadGroup	cpmThreadGroup The cpm thread group.

Fields inherited from interface org.apache.uima.collection.base_cpm.BaseCPM

DOCUMENT_TEXT_FEATURE, DOCUMENT_TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
BaseCPMImpl(Boolean mode, String aDescriptor, org.apache.uima.resource.ResourceManager aResourceManager) Parses CPE descriptor.
BaseCPMImpl(org.apache.uima.collection.metadata.CpeDescription aDescriptor) Instantiates and initializes CPE Factory with a given CPE Descriptor and defaults.
BaseCPMImpl(org.apache.uima.collection.metadata.CpeDescription aDescriptor, org.apache.uima.resource.ResourceManager aResourceManager, boolean aDefaultProcessTrace, Properties aProps) Instantiates and initializes CPE Factory responsible for creating individual components that are part of the processing pipeline.

Method Summary

Modifier and Type	Method and Description
void	addCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor)
void	addCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor, int aIndex)
void	addStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener)
void	asynchStop() Asynch stop.
void	buildEventTree(org.apache.uima.util.ProcessTraceEvent aEvent, int aTotalTime) Helper method to help build the CPM report.
void	disableCasProcessor(String aCasProcessorName)
void	displayStats(org.apache.uima.util.ProcessTrace aProcessTrace, int aNumDocsProcessed) Helper method to display stats and totals.
void	enableCasProcessor(String aCasProcessorName) Enable cas processor.
void	finalizeIt() Called to cleanup CPE on shutdown.
org.apache.uima.collection.base_cpm.CasProcessor[]	getCasProcessors()
org.apache.uima.collection.base_cpm.BaseCollectionReader	getCollectionReader() Returns a Collection Reader for this CPE.
org.apache.uima.collection.metadata.CpeConfiguration	getCPEConfig() Returns CPEConfig object holding current CPE configuration.
String	getDescriptor(List aList) Returns a CPE descriptor as a String.
org.apache.uima.util.ProcessTrace	getPerformanceReport() Returns PerformanceReport for the CPM.
org.apache.uima.util.Progress[]	getProgress() Returns current CPE progress.
org.apache.uima.collection.base_cpm.SynchPoint	getSynchPoint() Returns a SynchPoint object initialized by the Collection Reader if the Collection Reader implements RecoverableCollectionReader.
void	init(boolean aDummyCasProcessor, Properties aProps) Instantiates and initializes a CPE.
boolean	isPaused()
boolean	isPauseOnException()
boolean	isProcessing()
boolean	isSerialProcessingRequired()
void	kill() Kills the CPM hard.
void	pause()
void	process()
void	process(org.apache.uima.collection.base_cpm.BaseCollectionReader aCollectionReader) Deprecated.
void	process(org.apache.uima.collection.base_cpm.BaseCollectionReader aCollectionReader, int aBatchSize) Deprecated.
void	removeCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor)
void	removeStatusCallbackListener(org.apache.uima.collection.base_cpm.BaseStatusCallbackListener aListener)
void	resume()
void	resume(boolean aRetryFailed)
void	run()
void	setCollectionReader(org.apache.uima.collection.base_cpm.BaseCollectionReader aCollectionReader) Sets the Collection Reader for this CPE.
void	setJediiReport(boolean aUseJediiReport) Sets Jedii-style reporting resources and sets the global flag to indicate what report-style to use at the end of processing.
void	setPauseOnException(boolean aPause)
void	setPerformanceTuningSettings(Properties aPerformanceTuningSettings) Plugs in custom perfomance tunning parameters.
void	setProcessControllerAdapter(ProcessControllerAdapter aPca) Plugs in a given ProcessControllerAdapter.
void	setSerialProcessingRequired(boolean aRequired)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

cpmThreadGroup

public CPMThreadGroup cpmThreadGroup

The cpm thread group.

Constructor Detail

BaseCPMImpl

public BaseCPMImpl(org.apache.uima.collection.metadata.CpeDescription aDescriptor)
            throws Exception

Instantiates and initializes CPE Factory with a given CPE Descriptor and defaults.

Parameters:

aDescriptor - - parsed CPE descriptor

Throws:

Exception - -

BaseCPMImpl

public BaseCPMImpl(org.apache.uima.collection.metadata.CpeDescription aDescriptor,
                   org.apache.uima.resource.ResourceManager aResourceManager,
                   boolean aDefaultProcessTrace,
                   Properties aProps)
            throws Exception

Instantiates and initializes CPE Factory responsible for creating individual components that are part of the processing pipeline.

Parameters:

aDescriptor - - parsed CPE descriptor

aResourceManager - - ResourceManager instance to be used by the CPE

aDefaultProcessTrace - - ProcessTrace instance to capture events and stats

aProps - the a props

Throws:

Exception - -

BaseCPMImpl

public BaseCPMImpl(Boolean mode,
                   String aDescriptor,
                   org.apache.uima.resource.ResourceManager aResourceManager)
            throws Exception

Parses CPE descriptor.

Parameters:

mode - - indicates if the CPM should use a static descriptor or one provided

aDescriptor - - provided descriptor path

aResourceManager - ResourceManager to be used by CPM

Throws:

Exception - -

Method Detail

setPerformanceTuningSettings

public void setPerformanceTuningSettings(Properties aPerformanceTuningSettings)

Plugs in custom perfomance tunning parameters.

Parameters:

aPerformanceTuningSettings - the new performance tuning settings

setProcessControllerAdapter

public void setProcessControllerAdapter(ProcessControllerAdapter aPca)

Plugs in a given ProcessControllerAdapter. The CPM uses this adapter to request Cas Processor restarts and shutdown.

Parameters:

aPca - - instance of the ProcessControllerAdapter

setJediiReport

public void setJediiReport(boolean aUseJediiReport)

Sets Jedii-style reporting resources and sets the global flag to indicate what report-style to use at the end of processing. Jedii-style reporting shows a summary for this run. The CPM default report shows more detail information.

Parameters:

aUseJediiReport - the new jedii report

init

public void init(boolean aDummyCasProcessor,
                 Properties aProps)
          throws Exception

Instantiates and initializes a CPE.

Parameters:

aDummyCasProcessor - -

aProps - the a props

Throws:

Exception - -

getCPEConfig

public org.apache.uima.collection.metadata.CpeConfiguration getCPEConfig()
                                                                  throws Exception

Returns CPEConfig object holding current CPE configuration.

Returns:

CPEConfig instance

Throws:

Exception - -

getCasProcessors

public org.apache.uima.collection.base_cpm.CasProcessor[] getCasProcessors()

Specified by:

getCasProcessors in interface org.apache.uima.collection.base_cpm.BaseCPM

addCasProcessor

public void addCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor)
                     throws org.apache.uima.resource.ResourceConfigurationException

Specified by:

addCasProcessor in interface org.apache.uima.collection.base_cpm.BaseCPM

Throws:

org.apache.uima.resource.ResourceConfigurationException

addCasProcessor

public void addCasProcessor(org.apache.uima.collection.base_cpm.CasProcessor aCasProcessor,
                            int aIndex)
                     throws org.apache.uima.resource.ResourceConfigurationException

Specified by:

addCasProcessor in interface org.apache.uima.collection.base_cpm.BaseCPM

Throws:

org.apache.uima.resource.ResourceConfigurationException

removeCasProcessor

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

Specified by:

removeCasProcessor in interface org.apache.uima.collection.base_cpm.BaseCPM

disableCasProcessor

public void disableCasProcessor(String aCasProcessorName)

Specified by:

disableCasProcessor in interface org.apache.uima.collection.base_cpm.BaseCPM

enableCasProcessor

public void enableCasProcessor(String aCasProcessorName)

Enable cas processor.

Parameters:

aCasProcessorName - the a cas processor name

isSerialProcessingRequired

public boolean isSerialProcessingRequired()

Specified by:

isSerialProcessingRequired in interface org.apache.uima.collection.base_cpm.BaseCPM

setSerialProcessingRequired

public void setSerialProcessingRequired(boolean aRequired)

Specified by:

setSerialProcessingRequired in interface org.apache.uima.collection.base_cpm.BaseCPM

isPauseOnException

public boolean isPauseOnException()

Specified by:

isPauseOnException in interface org.apache.uima.collection.base_cpm.BaseCPM

setPauseOnException

public void setPauseOnException(boolean aPause)

Specified by:

setPauseOnException in interface org.apache.uima.collection.base_cpm.BaseCPM

addStatusCallbackListener

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

Specified by:

addStatusCallbackListener in interface org.apache.uima.collection.base_cpm.BaseCPM

removeStatusCallbackListener

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

Specified by:

removeStatusCallbackListener in interface org.apache.uima.collection.base_cpm.BaseCPM

run

public void run()

Specified by:

run in interface Runnable

finalizeIt

public void finalizeIt()

Called to cleanup CPE on shutdown.

process

@Deprecated
public void process(org.apache.uima.collection.base_cpm.BaseCollectionReader aCollectionReader)
                          throws org.apache.uima.resource.ResourceInitializationException

Deprecated.

This method is called by an applications to begin CPM processing with a given Collection. It just creates a new thread and starts it.

Parameters:

aCollectionReader - the a collection reader

Throws:

org.apache.uima.resource.ResourceInitializationException - the resource initialization exception

See Also:

BaseCPM.process()

process

public void process()
             throws org.apache.uima.resource.ResourceInitializationException

Specified by:

process in interface org.apache.uima.collection.base_cpm.BaseCPM

Throws:

org.apache.uima.resource.ResourceInitializationException

process

@Deprecated
public void process(org.apache.uima.collection.base_cpm.BaseCollectionReader aCollectionReader,
                                 int aBatchSize)
                          throws org.apache.uima.resource.ResourceInitializationException

Deprecated.

This method is called by an applications to begin CPM processing with a given Collection. It just creates a new thread and starts it.

Parameters:

aCollectionReader - the a collection reader

aBatchSize - the a batch size

Throws:

org.apache.uima.resource.ResourceInitializationException - the resource initialization exception

See Also:

BaseCPM.process()

setCollectionReader

public void setCollectionReader(org.apache.uima.collection.base_cpm.BaseCollectionReader aCollectionReader)

Sets the Collection Reader for this CPE.

Specified by:

setCollectionReader in interface org.apache.uima.collection.base_cpm.BaseCPM

Parameters:

aCollectionReader - the collection reader

getCollectionReader

public org.apache.uima.collection.base_cpm.BaseCollectionReader getCollectionReader()

Returns a Collection Reader for this CPE.

Specified by:

getCollectionReader in interface org.apache.uima.collection.base_cpm.BaseCPM

Returns:

the collection reader

isProcessing

public boolean isProcessing()

Specified by:

isProcessing in interface org.apache.uima.collection.base_cpm.BaseCPM

pause

public void pause()

Specified by:

pause in interface org.apache.uima.collection.base_cpm.BaseCPM

isPaused

public boolean isPaused()

Specified by:

isPaused in interface org.apache.uima.collection.base_cpm.BaseCPM

resume

public void resume(boolean aRetryFailed)

Specified by:

resume in interface org.apache.uima.collection.base_cpm.BaseCPM

resume

public void resume()

Specified by:

resume in interface org.apache.uima.collection.base_cpm.BaseCPM

kill

public void kill()

Kills the CPM hard. CASes in transit are not processed.

stop

public void stop()

Specified by:

stop in interface org.apache.uima.collection.base_cpm.BaseCPM

asynchStop

public void asynchStop()

Asynch stop.

displayStats

public void displayStats(org.apache.uima.util.ProcessTrace aProcessTrace,
                         int aNumDocsProcessed)

Helper method to display stats and totals.

Parameters:

aProcessTrace - - trace containing stats

aNumDocsProcessed - - number of entities processed so far

buildEventTree

public void buildEventTree(org.apache.uima.util.ProcessTraceEvent aEvent,
                           int aTotalTime)

Helper method to help build the CPM report.

Parameters:

aEvent - the a event

aTotalTime - the a total time

getPerformanceReport

public org.apache.uima.util.ProcessTrace getPerformanceReport()

Returns PerformanceReport for the CPM. This report contains a snapshot of the CPM state.

Specified by:

getPerformanceReport in interface org.apache.uima.collection.base_cpm.BaseCPM

Returns:

the performance report

getProgress

public org.apache.uima.util.Progress[] getProgress()

Returns current CPE progress. How many entities processed and bytes processed.

Specified by:

getProgress in interface org.apache.uima.collection.base_cpm.BaseCPM

Returns:

the progress

getDescriptor

public String getDescriptor(List aList)
                     throws org.apache.uima.resource.ResourceConfigurationException

Returns a CPE descriptor as a String.

Parameters:

aList - - list of components

Returns:

- descriptor populated with a given components

Throws:

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

getSynchPoint

public org.apache.uima.collection.base_cpm.SynchPoint getSynchPoint()

Returns a SynchPoint object initialized by the Collection Reader if the Collection Reader implements RecoverableCollectionReader. The synchpoint object contains the current snapshot that includes the last document processed.

Returns:

- instance of SynchPoint if the Collection Reader is recoverable, null otherwise