public abstract class CasConsumer_ImplBase extends ConfigurableResource_ImplBase implements CasConsumer
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 and Description |
|---|
CasConsumer_ImplBase() |
| Modifier and Type | Method and Description |
|---|---|
void |
batchProcessComplete(ProcessTrace arg0)
Completes the processing of a batch.
|
void |
collectionProcessComplete(ProcessTrace arg0)
Completes the processing of an entire collection.
|
void |
destroy()
Releases all resources held by this
Resource. |
ProcessingResourceMetaData |
getProcessingResourceMetaData()
Gets the metadata that describes this
CasProcesor. |
void |
initialize()
This method is called during initialization, and does nothing by default.
|
boolean |
initialize(ResourceSpecifier aSpecifier,
Map<String,Object> aAdditionalParams)
Called by the framework to initialize this CAS Consumer.
|
boolean |
isReadOnly()
Returns true.
|
boolean |
isStateless()
Gets whether this is a stateless CAS Processor.
|
void |
processCas(CAS[] aCASes)
Processes multiple CASes.
|
void |
reconfigure()
Notifies this CAS Consumer that its configuration parameter settings have been changed.
|
void |
typeSystemInit(TypeSystem arg0)
Informs this CasConsumer that the CAS TypeSystem has changed.
|
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValuegetCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaDataclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValuegetLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLoggerprocessCaspublic boolean initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams) throws ResourceInitializationException
initialize() method and access
metadata via the getProcessingResourceMetaData() method. This method is non-final only
for legacy reasons.initialize in interface Resourceinitialize in class Resource_ImplBaseaSpecifier - specifies how to create a resource or locate an existing resource service.aAdditionalParams - a Map containing additional parameters. May be null if there are no
parameters. Each class that implements this interface can decide what additional
parameters it supports.ResourceSpecifier is not of an appropriate type for this Resource. If
the ResourceSpecifier is of an appropriate type but is invalid or if
some other failure occurs, an exception should be thrown.ResourceInitializationException - if a failure occurs during initialization.Resource.initialize(org.apache.uima.resource.ResourceSpecifier,
java.util.Map)public void initialize()
throws ResourceInitializationException
ResourceInitializationException - if a failure occurs during initialization.public void destroy()
ResourceResource.destroy in interface Resourcedestroy in class Resource_ImplBaseResource.destroy()public void typeSystemInit(TypeSystem arg0) throws ResourceInitializationException
CasObjectProcessor
In this method, the CasConsumer should use the TypeSystem to resolve the names of Type
and Features to the actual Type and
Feature objects, which can then be used during processing.
typeSystemInit in interface CasObjectProcessorarg0 - the type system to useResourceInitializationException - if the type system is not compatible with this Cas ConsumerCasObjectProcessor.typeSystemInit(org.apache.uima.cas.TypeSystem)public void processCas(CAS[] aCASes) throws ResourceProcessException
CasObjectProcessorprocessCas in interface CasObjectProcessoraCASes - an array of CASes to be processed. Additional information may be added to these CASes
(if this CAS processor is not read-only).ResourceProcessException - if processing fails for any of the CASesCasObjectProcessor.processCas(org.apache.uima.cas.CAS[])public boolean isStateless()
CasProcessorisStateless in interface CasProcessorCasProcessor.isStateless()public final boolean isReadOnly()
isReadOnly in interface CasProcessorisReadOnly in interface CasConsumerCasProcessor.isReadOnly()public ProcessingResourceMetaData getProcessingResourceMetaData()
CasProcessorCasProcesor.getProcessingResourceMetaData in interface CasProcessorCasProcessor.getProcessingResourceMetaData()public void batchProcessComplete(ProcessTrace arg0) throws ResourceProcessException, IOException
CasProcessorbatchProcessComplete in interface CasProcessorarg0 - an object that records information, such as timing, about this method's execution.ResourceProcessException - if an exception occurs during processingIOException - if an I/O failure occursCasProcessor.batchProcessComplete(org.apache.uima.util.ProcessTrace)public void collectionProcessComplete(ProcessTrace arg0) throws ResourceProcessException, IOException
CasProcessorcollectionProcessComplete in interface CasProcessorarg0 - an object that records information, such as timing, about this method's execution.ResourceProcessException - if an exception occurs during processingIOException - if an I/O failure occursCasProcessor.collectionProcessComplete(org.apache.uima.util.ProcessTrace)public void reconfigure()
throws ResourceConfigurationException
destroy() followed by 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.reconfigure in interface ConfigurableResourcereconfigure in class ConfigurableResource_ImplBaseResourceConfigurationException - if the configuration is not validConfigurableResource_ImplBase.reconfigure()Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.