Package org.apache.uima.analysis_engine.impl

Class PrimitiveAnalysisEngine_impl

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.analysis_engine.impl.AnalysisEngineImplBase

org.apache.uima.analysis_engine.impl.PrimitiveAnalysisEngine_impl

All Implemented Interfaces:

AnalysisEngine, TextAnalysisEngine, CasObjectProcessor, CasProcessor, ConfigurableResource, Resource

public class PrimitiveAnalysisEngine_impl
extends AnalysisEngineImplBase
implements AnalysisEngine

Reference implementation of AnalysisEngine.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	INIT_THREADSAFE	flag for embedders to test to see if they have a version of the framework which supports multi-threaded produceResource

Fields inherited from class org.apache.uima.analysis_engine.impl.AnalysisEngineImplBase

LOG_RESOURCE_BUNDLE, PARAM_VERIFICATION_MODE

Fields inherited from interface org.apache.uima.analysis_engine.AnalysisEngine

MDC_ANNOTATOR_CONTEXT_NAME, MDC_ANNOTATOR_IMPL_NAME, MDC_CAS_ID, MDC_ROOT_CONTEXT_ID, PARAM_CONFIG_PARAM_SETTINGS, PARAM_MBEAN_NAME_PREFIX, PARAM_MBEAN_SERVER, PARAM_NUM_SIMULTANEOUS_REQUESTS, PARAM_RESOURCE_MANAGER, PARAM_THROTTLE_EXCESSIVE_ANNOTATOR_LOGGING, PARAM_TIMEOUT_PERIOD

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
PrimitiveAnalysisEngine_impl()

Method Summary

Modifier and Type	Method	Description
void	batchProcessComplete()	Notifies this AnalysisEngine that processing of a batch has completed.
protected CAS	callAnalysisComponentNext()	Calls the Analysis Component's next() method.
protected void	callAnalysisComponentProcess(CAS aCAS)	Calls the Analysis Component's process method.
void	collectionProcessComplete()	Notifies this AnalysisEngine that processing of an entire collection has completed.
void	destroy()	Releases all resources held by this Resource.
protected AnalysisComponent	getAnalysisComponent()
boolean	initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams)	Initializes this Resource from a ResourceSpecifier.
protected void	initializeAnalysisComponent(Map<String,Object> aAdditionalParams)	Loads, instantiates, and initializes the AnalysisComponent contained in this AE.
CasIterator	processAndOutputNewCASes(CAS aCAS)	Processes a CAS, possibly producing multiple CASes as a result.
void	reconfigure()	Instructs this Resource to re-read its configuration parameter settings.
void	setResultSpecification(ResultSpecification aResultSpec)	Sets the list of output types and features that the application wants this AnalysisEngine to produce.

Methods inherited from class org.apache.uima.analysis_engine.impl.AnalysisEngineImplBase

batchProcessComplete, buildProcessTraceFromMBeanStats, buildProcessTraceFromMBeanStats, callInitializeMethod, callProcessMethod, collectionProcessComplete, createResultSpecification, createResultSpecification, enterBatchProcessComplete, enterCollectionProcessComplete, enterProcess, exitBatchProcessComplete, exitCollectionProcessComplete, exitProcess, finalize, getAnalysisEngineMetaData, getCurrentConfigParameterSettings, getFeatureNamesForType, getManagementInterface, getMBean, getMBeanNamePrefix, getMBeanServer, getPerformanceTuningSettings, getProcessingResourceMetaData, isProcessTraceEnabled, isReadOnly, isStateless, newCAS, newJCas, normalizeIsoLangCodes, process, process, process, process, process, process, process, processAndOutputNewCASes, processCas, processCas, resetResultSpecificationToDefault, setMetaData, setPerformanceTuningSettings, 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, loadUserClass, loadUserClassOrThrow, setContextHolder, setContextHolderX, setLogger, withContextHolder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.analysis_engine.AnalysisEngine

createResultSpecification, createResultSpecification, getAnalysisEngineMetaData, getFeatureNamesForType, getLogger, getManagementInterface, getPerformanceTuningSettings, getResourceManager, newCAS, newJCas, process, process, process, process, process, process, process, processAndOutputNewCASes, setLogger

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

processCas, processCas, typeSystemInit

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

batchProcessComplete, collectionProcessComplete, 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

getMetaData, getUimaContext, getUimaContextAdmin

Field Details

INIT_THREADSAFE

public static final boolean INIT_THREADSAFE

flag for embedders to test to see if they have a version of the framework which supports multi-threaded produceResource

See Also:

• Constant Field Values

Constructor Details

PrimitiveAnalysisEngine_impl

public PrimitiveAnalysisEngine_impl()

Method Details

initialize

public boolean initialize(ResourceSpecifier aSpecifier,
 Map<String,Object> aAdditionalParams)
                   throws ResourceInitializationException

Description copied from interface: Resource

Initializes this Resource from a ResourceSpecifier. Applications do not need to call this method. It is called automatically by the ResourceFactory and cannot be called a second time.

Specified by:

initialize in interface AnalysisEngine

Specified by:

initialize in interface Resource

Overrides:

initialize in class AnalysisEngineImplBase

Parameters:

aSpecifier - 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.

Returns:

true if and only if initialization completed successfully. Returns false if the given 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.

Throws:

ResourceInitializationException - if a failure occurs during initialization.

See Also:

• Resource.initialize(ResourceSpecifier, Map)

initializeAnalysisComponent

protected void initializeAnalysisComponent(Map<String,Object> aAdditionalParams)
                                    throws ResourceInitializationException

Loads, instantiates, and initializes the AnalysisComponent contained in this AE.

Parameters:

aAdditionalParams - parameters passed to this AE's initialize method

Throws:

ResourceInitializationException - if an initialization failure occurs

destroy

public void destroy()

Description copied from interface: Resource

Releases all resources held by this Resource.

Specified by:

destroy in interface Resource

Overrides:

destroy in class Resource_ImplBase

See Also:

• Resource.destroy()

setResultSpecification

public void setResultSpecification(ResultSpecification aResultSpec)

Description copied from interface: AnalysisEngine

Sets the list of output types and features that the application wants this AnalysisEngine to produce. This is only a guideline. Annotators may use this information to avoid doing unnecessary work, but they are not required to do so.

Specified by:

setResultSpecification in interface AnalysisEngine

Overrides:

setResultSpecification in class AnalysisEngineImplBase

Parameters:

aResultSpec - specifies the list of output types and features that the application is interested in.

processAndOutputNewCASes

public CasIterator processAndOutputNewCASes(CAS aCAS)
                                     throws AnalysisEngineProcessException

Description copied from interface: AnalysisEngine

Processes a CAS, possibly producing multiple CASes as a result. The application uses the CasIterator interface to step through the output CASes.

If this Analysis Engine does not produce output CASes, then the CasIterator will return no elements. You can check if an AnalysisEngine is capable of producing output CASes by checking the OperationalProperties.getOutputsNewCASes() operational property (getAnalysisEngineMetaData().getOperationalProperties().getOutputsNewCASes()).

Once this method is called, the AnalysisEngine "owns" aCAS until such time as the CasIterator.hasNext() method returns false. That is, the caller should not attempt to modify or access the input CAS until it has read all of the elements from the CasIterator. If the caller wants to abort the processing before having read all of the output CASes, it may call CasIterator.release(), which will stop further processing from occurring, and ownership of aCAS will revert to the caller.

Specified by:

processAndOutputNewCASes in interface AnalysisEngine

Overrides:

processAndOutputNewCASes in class AnalysisEngineImplBase

Parameters:

aCAS - the CAS to be processed

Returns:

an object for iterating through any output CASes

Throws:

AnalysisEngineProcessException - if a failure occurs during processing

See Also:

• AnalysisEngine.processAndOutputNewCASes(CAS)

batchProcessComplete

public void batchProcessComplete()
                          throws AnalysisEngineProcessException

Description copied from interface: AnalysisEngine

Notifies this AnalysisEngine that processing of a batch has completed. It is up to the caller to determine the size of a batch. Components (particularly CAS Consumers) inside this Analysis Engine may respond to this event, for example by writing data to the disk.

Specified by:

batchProcessComplete in interface AnalysisEngine

Overrides:

batchProcessComplete in class AnalysisEngineImplBase

Throws:

AnalysisEngineProcessException - if an exception occurs during processing

collectionProcessComplete

public void collectionProcessComplete()
                               throws AnalysisEngineProcessException

Description copied from interface: AnalysisEngine

Notifies this AnalysisEngine that processing of an entire collection has completed. It is up to the caller to determine when this has occurred. Components (particularly CAS Consumers) inside this Analysis Engine may respond to this event, for example by writing data to the disk.

If this AnalysisEngine is an aggregate, this method will call the collectionProcessComplete method of all components of that aggregate. If the aggregate descriptor declares a fixedFlow or capabilityLanguageFlow, then the components' collectionProcessComplete methods will be called in the order specified by that flow element. Once all components in the flow have been called, any components not declared in the flow will be called, in arbitrary order. If there is no fixedFlow or capabilityLanguageFlow, then all components in the aggregate will be called in arbitrary order.

Specified by:

collectionProcessComplete in interface AnalysisEngine

Overrides:

collectionProcessComplete in class AnalysisEngineImplBase

Throws:

AnalysisEngineProcessException - if an exception occurs during processing

callAnalysisComponentProcess

protected void callAnalysisComponentProcess(CAS aCAS)
                                     throws AnalysisEngineProcessException

Calls the Analysis Component's process method.

Parameters:

aCAS - CAS to be processed by annotator

Throws:

AnalysisEngineProcessException - -

callAnalysisComponentNext

protected CAS callAnalysisComponentNext()
                                 throws AnalysisEngineProcessException,
ResultNotSupportedException

Calls the Analysis Component's next() method.

Returns:

CAS returned by the analysis component

Throws:

AnalysisEngineProcessException - -

ResultNotSupportedException - -

reconfigure

public void reconfigure()
                 throws ResourceConfigurationException

Description copied from interface: ConfigurableResource

Instructs this Resource to re-read its configuration parameter settings.

Specified by:

reconfigure in interface AnalysisEngine

Specified by:

reconfigure in interface ConfigurableResource

Overrides:

reconfigure in class ConfigurableResource_ImplBase

Throws:

ResourceConfigurationException - if the configuration is not valid

See Also:

• AnalysisEngine.reconfigure()

getAnalysisComponent

protected AnalysisComponent getAnalysisComponent()