org.apache.uima.examples.cpe

Class AnnotationPrinter

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CasConsumer_ImplBase

org.apache.uima.examples.cpe.AnnotationPrinter

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.CasObjectProcessor, org.apache.uima.collection.base_cpm.CasProcessor, org.apache.uima.collection.CasConsumer, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

public class AnnotationPrinter
extends org.apache.uima.collection.CasConsumer_ImplBase
implements org.apache.uima.collection.base_cpm.CasObjectProcessor

An example of CAS Consumer.
AnnotationPrinter prints to an output file all annotations in the CAS.
Parameters needed by the AnnotationPrinter are

1. "outputFile" : file to which the output files should be written.

These parameters are set in the initialize method to the values specified in the descriptor file.
These may also be set by the application by using the setConfigParameterValue methods.

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
AnnotationPrinter()

Method Summary

Modifier and Type	Method and Description
void	batchProcessComplete(org.apache.uima.util.ProcessTrace aTrace) Called when a batch of processing is completed.
void	collectionProcessComplete(org.apache.uima.util.ProcessTrace aTrace) Called when the entire collection is completed.
void	destroy() Called if clean up is needed in case of exit under error conditions.
void	initialize() Initializes this CAS Consumer with the parameters specified in the descriptor.
void	processCas(org.apache.uima.cas.CAS aCAS) Processes the CasContainer which was populated by the TextAnalysisEngines.
void	reconfigure() Reconfigures the parameters of this Consumer.

Methods inherited from class org.apache.uima.collection.CasConsumer_ImplBase

getProcessingResourceMetaData, initialize, isReadOnly, isStateless, processCas, typeSystemInit

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

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

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

getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

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.collection.base_cpm.CasObjectProcessor

processCas, typeSystemInit

Methods inherited from interface org.apache.uima.collection.base_cpm.CasProcessor

getProcessingResourceMetaData, isReadOnly, isStateless

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

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

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

getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Constructor Detail

AnnotationPrinter

public AnnotationPrinter()

Method Detail

initialize

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

Initializes this CAS Consumer with the parameters specified in the descriptor.

Overrides:

initialize in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException - if there is error in initializing the resources

processCas

public void processCas(org.apache.uima.cas.CAS aCAS)
                throws org.apache.uima.resource.ResourceProcessException

Processes the CasContainer which was populated by the TextAnalysisEngines.
In this case, the CAS index is iterated over selected annotations and printed out into an output file

Specified by:

processCas in interface org.apache.uima.collection.base_cpm.CasObjectProcessor

Parameters:

aCAS - CasContainer which has been populated by the TAEs

Throws:

org.apache.uima.resource.ResourceProcessException - if there is an error in processing the Resource

See Also:

CasObjectProcessor.processCas(CAS)

batchProcessComplete

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

Called when a batch of processing is completed.

Specified by:

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

Overrides:

batchProcessComplete in class org.apache.uima.collection.CasConsumer_ImplBase

Parameters:

aTrace - ProcessTrace object that will log events in this method.

Throws:

org.apache.uima.resource.ResourceProcessException - if there is an error in processing the Resource

IOException - if there is an IO Error

See Also:

CasProcessor.batchProcessComplete(ProcessTrace)

collectionProcessComplete

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

Called when the entire collection is completed.

Specified by:

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

Overrides:

collectionProcessComplete in class org.apache.uima.collection.CasConsumer_ImplBase

Parameters:

aTrace - ProcessTrace object that will log events in this method.

Throws:

org.apache.uima.resource.ResourceProcessException - if there is an error in processing the Resource

IOException - if there is an IO Error

See Also:

CasProcessor.collectionProcessComplete(ProcessTrace)

reconfigure

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

Reconfigures the parameters of this Consumer.
This is used in conjunction with the setConfigurationParameterValue to set the configuration parameter values to values other than the ones specified in the descriptor.

Specified by:

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

Overrides:

reconfigure in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceConfigurationException - if the configuration parameter settings are invalid

See Also:

ConfigurableResource.reconfigure()

destroy

public void destroy()

Called if clean up is needed in case of exit under error conditions.

Specified by:

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

Overrides:

destroy in class org.apache.uima.collection.CasConsumer_ImplBase

See Also:

Resource.destroy()