Package org.apache.uima.collection
Class CasConsumer_ImplBase
java.lang.Object
org.apache.uima.resource.Resource_ImplBase
org.apache.uima.resource.ConfigurableResource_ImplBase
org.apache.uima.collection.CasConsumer_ImplBase
- All Implemented Interfaces:
CasObjectProcessor,CasProcessor,CasConsumer,ConfigurableResource,Resource
public abstract class CasConsumer_ImplBase
extends ConfigurableResource_ImplBase
implements CasConsumer
Base class for CAS Consumers in UIMA SDK v1.x, which developers should extend with their own CAS
Consumer implementation classes.
As of v2.0, there is no difference in capability between CAS Consumers and ordinary Analysis
Engines, except for the default setting of the XML parameters for multipleDeploymentAllowed and
modifiesCas. We recommend for future work that users implement and use Analysis Engine components
instead of CAS Consumers.
-
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 -
Method Summary
Modifier and TypeMethodDescriptionvoidCompletes the processing of a batch.voidCompletes the processing of an entire collection.voiddestroy()Releases all resources held by thisResource.Gets the metadata that describes thisCasProcesor.voidThis method is called during initialization, and does nothing by default.booleaninitialize(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) Called by the framework to initialize this CAS Consumer.final booleanReturns true.booleanGets whether this is a stateless CAS Processor.voidprocessCas(CAS[] aCASes) Processes multiple CASes.voidNotifies this CAS Consumer that its configuration parameter settings have been changed.voidtypeSystemInit(TypeSystem arg0) Informs this CasConsumer that the CAS TypeSystem has changed.Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValueMethods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, loadUserClass, loadUserClassOrThrow, setContextHolder, setContextHolderX, setLogger, setMetaData, withContextHolderMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.uima.collection.base_cpm.CasObjectProcessor
processCasMethods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValueMethods inherited from interface org.apache.uima.resource.Resource
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
-
Constructor Details
-
CasConsumer_ImplBase
public CasConsumer_ImplBase()
-
-
Method Details
-
initialize
public boolean initialize(ResourceSpecifier aSpecifier, Map<String, Object> aAdditionalParams) throws ResourceInitializationExceptionCalled by the framework to initialize this CAS Consumer. Subclasses should NOT override this method; instead they should override the zero-argumentinitialize()method and access metadata via thegetProcessingResourceMetaData()method. This method is non-final only for legacy reasons.- Specified by:
initializein interfaceResource- Overrides:
initializein classResource_ImplBase- Parameters:
aSpecifier- specifies how to create a resource or locate an existing resource service.aAdditionalParams- a Map containing additional parameters. May benullif there are no parameters. Each class that implements this interface can decide what additional parameters it supports.- Returns:
- true if and only if initialization completed successfully. Returns false if the given
ResourceSpecifieris not of an appropriate type for this Resource. If theResourceSpecifieris of an appropriate type but is invalid or if some other failure occurs, an exception should be thrown. - Throws:
ResourceInitializationException- if a failure occurs during initialization.- See Also:
-
initialize
This method is called during initialization, and does nothing by default. Subclasses should override it to perform one-time startup logic.- Throws:
ResourceInitializationException- if a failure occurs during initialization.
-
destroy
public void destroy()Description copied from interface:ResourceReleases all resources held by thisResource.- Specified by:
destroyin interfaceResource- Overrides:
destroyin classResource_ImplBase- See Also:
-
typeSystemInit
Description copied from interface:CasObjectProcessorInforms this CasConsumer that the CAS TypeSystem has changed. The CPM calls this method prior to initiating collection processing, and will call it again whenever the CAS TypeSystem changes.In this method, the CasConsumer should use the
TypeSystemto resolve the names of Type and Features to the actualTypeandFeatureobjects, which can then be used during processing.- Specified by:
typeSystemInitin interfaceCasObjectProcessor- Parameters:
arg0- the type system to use- Throws:
ResourceInitializationException- if the type system is not compatible with this Cas Consumer- See Also:
-
processCas
Description copied from interface:CasObjectProcessorProcesses multiple CASes.- Specified by:
processCasin interfaceCasObjectProcessor- Parameters:
aCASes- an array of CASes to be processed. Additional information may be added to these CASes (if this CAS processor is notread-only).- Throws:
ResourceProcessException- if processing fails for any of the CASes- See Also:
-
isStateless
public boolean isStateless()Description copied from interface:CasProcessorGets whether this is a stateless CAS Processor. Stateless CAS Processors do not maintain any data between calls to their process methods.- Specified by:
isStatelessin interfaceCasProcessor- Returns:
- true if this CAS processor is stateless, false if it is stateful.
- See Also:
-
isReadOnly
public final boolean isReadOnly()Returns true. By contract, CAS Consumers must be read only.- Specified by:
isReadOnlyin interfaceCasConsumer- Specified by:
isReadOnlyin interfaceCasProcessor- Returns:
- true if this CAS processor does not modify the CAS, false if it does.
- See Also:
-
getProcessingResourceMetaData
Description copied from interface:CasProcessorGets the metadata that describes thisCasProcesor.- Specified by:
getProcessingResourceMetaDatain interfaceCasProcessor- Returns:
- an object containing all metadata for this CasProcessor
- See Also:
-
batchProcessComplete
Description copied from interface:CasProcessorCompletes 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:
batchProcessCompletein interfaceCasProcessor- Parameters:
arg0- 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:
-
collectionProcessComplete
public void collectionProcessComplete(ProcessTrace arg0) throws ResourceProcessException, IOException Description copied from interface:CasProcessorCompletes the processing of an entire collection.- Specified by:
collectionProcessCompletein interfaceCasProcessor- Parameters:
arg0- 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:
-
reconfigure
Notifies this CAS Consumer that its configuration parameter settings have been changed. By default this method just callsdestroy()followed byinitialize(). 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:
reconfigurein interfaceConfigurableResource- Overrides:
reconfigurein classConfigurableResource_ImplBase- Throws:
ResourceConfigurationException- if the configuration is not valid- See Also:
-