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

Class NetworkCasProcessorImpl

java.lang.Object

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

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.CasDataProcessor, org.apache.uima.collection.base_cpm.CasProcessor

public class NetworkCasProcessorImpl
extends Object
implements org.apache.uima.collection.base_cpm.CasDataProcessor

Implementation of the CasDataProcessor interface used for both Local and Remote CasDataProcessors. The CPE delegates analysis of entities to this instance. Each instance of this class has a proxy to extenal service.

Constructor Summary

Constructors

Constructor and Description
NetworkCasProcessorImpl(org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessorType) Initializes this instance with configuration defined in the CPE descriptor.

Method Summary

Modifier and Type	Method and Description
void	batchProcessComplete(org.apache.uima.util.ProcessTrace aTrace) Notifies Network AE that end-of-batch marker has been reached.
void	collectionProcessComplete(org.apache.uima.util.ProcessTrace aTrace) This method gets called when the CPM completes processing the collection.
org.apache.uima.resource.metadata.ProcessingResourceMetaData	getProcessingResourceMetaData() Returns Remote AE metadata.
VinciTAP	getProxy() Returns proxy to the remote AE service
boolean	isReadOnly()
boolean	isStateless()
org.apache.uima.cas_data.CasData	process(org.apache.uima.cas_data.CasData aCas) Main method used during analysis.
org.apache.uima.cas_data.CasData[]	process(org.apache.uima.cas_data.CasData[] aCasList) Main method used during analysis.
void	setProxy(VinciTAP aTap) Associates a proxy to remote annotator service.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkCasProcessorImpl

public NetworkCasProcessorImpl(org.apache.uima.collection.metadata.CpeCasProcessor aCasProcessorType)

Initializes this instance with configuration defined in the CPE descriptor.

Parameters:

aCasProcessorType - -

Method Detail

setProxy

public void setProxy(VinciTAP aTap)

Associates a proxy to remote annotator service.

Parameters:

aTap - - proxy to remote service

getProxy

public VinciTAP getProxy()

Returns proxy to the remote AE service

Returns:

- proxy to remote service

process

public org.apache.uima.cas_data.CasData process(org.apache.uima.cas_data.CasData aCas)
                                         throws org.apache.uima.resource.ResourceProcessException

Main method used during analysis. The ProcessingUnit calls this method to initiate analysis of the content in the CasData instance. This handles one Cas at a time processing mode.

Specified by:

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

Parameters:

aCas - - instance of CasData to analyze

Returns:

instance containing result of the analysis

Throws:

org.apache.uima.resource.ResourceProcessException

process

public org.apache.uima.cas_data.CasData[] process(org.apache.uima.cas_data.CasData[] aCasList)
                                           throws org.apache.uima.resource.ResourceProcessException

Main method used during analysis. The ProcessingUnit calls this method to initiate analysis of the content in the CasData instance. This handles processing of multiple Cas'es at a time.

Specified by:

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

Parameters:

aCasList - - array of CasData instances to analyze

Returns:

CasData - array of CasData instances containing results of the analysis

Throws:

org.apache.uima.resource.ResourceProcessException

isStateless

public boolean isStateless()

Specified by:

isStateless in interface org.apache.uima.collection.base_cpm.CasProcessor

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface org.apache.uima.collection.base_cpm.CasProcessor

getProcessingResourceMetaData

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

Returns Remote AE metadata. This method returns the metadata associated with the annotator.

Specified by:

getProcessingResourceMetaData in interface org.apache.uima.collection.base_cpm.CasProcessor

batchProcessComplete

public void batchProcessComplete(org.apache.uima.util.ProcessTrace aTrace)
                          throws org.apache.uima.resource.ResourceProcessException,
                                 IOException

Notifies Network AE that end-of-batch marker has been reached. The notification can be disabled in the Cpe descriptor by setting batch=0 in the <checkpoint> element.

Specified by:

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

Throws:

org.apache.uima.resource.ResourceProcessException

IOException

See Also:

CasProcessor.batchProcessComplete(org.apache.uima.util.ProcessTrace)

collectionProcessComplete

public void collectionProcessComplete(org.apache.uima.util.ProcessTrace aTrace)
                               throws org.apache.uima.resource.ResourceProcessException,
                                      IOException

This method gets called when the CPM completes processing the collection. Depending on the type of deployment this routine may issue a shutdown command to the service.

Specified by:

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

Throws:

org.apache.uima.resource.ResourceProcessException

IOException

See Also:

CasProcessor.collectionProcessComplete(org.apache.uima.util.ProcessTrace)