Class AnnotationWriter
- java.lang.Object
-
- org.apache.uima.resource.Resource_ImplBase
-
- org.apache.uima.resource.ConfigurableResource_ImplBase
-
- org.apache.uima.collection.CasConsumer_ImplBase
-
- org.apache.uima.test.junit_extension.AnnotationWriter
-
- All Implemented Interfaces:
CasObjectProcessor
,CasProcessor
,CasConsumer
,ConfigurableResource
,Resource
public class AnnotationWriter extends CasConsumer_ImplBase implements CasConsumer
The AnnotationWriter class writes specified annotations to an output file. The encoding of the output file is UTF-8
-
-
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 Description AnnotationWriter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
batchProcessComplete(ProcessTrace aTrace)
Completes the processing of a batch.void
collectionProcessComplete(ProcessTrace aTrace)
Completes the processing of an entire collection.void
destroy()
Releases all resources held by thisResource
.void
initialize()
Initializes this CAS Consumer with the parameters specified in the descriptor.void
processCas(CAS aCAS)
Process a single CAS.void
reconfigure()
Notifies this CAS Consumer that its configuration parameter settings have been changed.-
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.CasConsumer
isReadOnly
-
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, 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, initialize, setLogger
-
-
-
-
Method Detail
-
initialize
public void initialize() throws ResourceInitializationException
Initializes this CAS Consumer with the parameters specified in the descriptor.- Overrides:
initialize
in classCasConsumer_ImplBase
- Throws:
ResourceInitializationException
- if there is error in initializing the resources
-
processCas
public void processCas(CAS aCAS) throws ResourceProcessException
Description copied from interface:CasObjectProcessor
Process a single CAS.- Specified by:
processCas
in interfaceCasObjectProcessor
- Parameters:
aCAS
- the CAS to be processed. Additional information may be added to this CAS (if this CAS processor is notread-only
).- Throws:
ResourceProcessException
- if processing fails
-
batchProcessComplete
public void batchProcessComplete(ProcessTrace aTrace) throws ResourceProcessException, IOException
Description copied from interface:CasProcessor
Completes the processing of a batch. A collection may be divided into one or more batches - it is up to the CollectionProcessingManager or the application to determine the number and size of batches.- Specified by:
batchProcessComplete
in interfaceCasProcessor
- Overrides:
batchProcessComplete
in classCasConsumer_ImplBase
- Parameters:
aTrace
- an object that records information, such as timing, about this method's execution.- Throws:
ResourceProcessException
- if an exception occurs during processingIOException
- if an I/O failure occurs- See Also:
CasProcessor.batchProcessComplete(org.apache.uima.util.ProcessTrace)
-
collectionProcessComplete
public void collectionProcessComplete(ProcessTrace aTrace) throws ResourceProcessException, IOException
Description copied from interface:CasProcessor
Completes the processing of an entire collection.- Specified by:
collectionProcessComplete
in interfaceCasProcessor
- Overrides:
collectionProcessComplete
in classCasConsumer_ImplBase
- Parameters:
aTrace
- an object that records information, such as timing, about this method's execution.- Throws:
ResourceProcessException
- if an exception occurs during processingIOException
- if an I/O failure occurs- See Also:
CasProcessor.collectionProcessComplete(org.apache.uima.util.ProcessTrace)
-
reconfigure
public void reconfigure() throws ResourceConfigurationException
Description copied from class:CasConsumer_ImplBase
Notifies this CAS Consumer that its configuration parameter settings have been changed. By default this method just callsCasConsumer_ImplBase.destroy()
followed byCasConsumer_ImplBase.initialize()
. CAS Consumers that have expensive initialization that does not need to be redone whenever configuration parameters change may wish to override this method to provide a more efficient implementation.- Specified by:
reconfigure
in interfaceConfigurableResource
- Overrides:
reconfigure
in classCasConsumer_ImplBase
- Throws:
ResourceConfigurationException
- if the configuration is not valid- See Also:
ConfigurableResource_ImplBase.reconfigure()
-
destroy
public void destroy()
Description copied from interface:Resource
Releases all resources held by thisResource
.- Specified by:
destroy
in interfaceResource
- Overrides:
destroy
in classCasConsumer_ImplBase
- See Also:
Resource.destroy()
-
-