public class AggregateAnalysisEngine_impl extends AnalysisEngineImplBase implements AnalysisEngine
AnalysisEngine
.Modifier and Type | Field and Description |
---|---|
static String |
PARAM_RESULT_SPECIFICATION |
LOG_RESOURCE_BUNDLE, PARAM_VERIFICATION_MODE
PARAM_CONFIG_PARAM_SETTINGS, PARAM_MBEAN_NAME_PREFIX, PARAM_MBEAN_SERVER, PARAM_NUM_SIMULTANEOUS_REQUESTS, PARAM_RESOURCE_MANAGER, PARAM_TIMEOUT_PERIOD
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_UIMA_CONTEXT
Constructor and Description |
---|
AggregateAnalysisEngine_impl() |
Modifier and Type | Method and Description |
---|---|
protected ASB |
_getASB()
For an aggregate AnalysisEngine only, gets the ASB component.
|
protected Map<String,ResourceSpecifier> |
_getComponentCasProcessorSpecifierMap()
For an aggregate AnalysisEngine only, gets a Map from each component's key to the specifier for
that component.
|
protected Map<String,ProcessingResourceMetaData> |
_getComponentMetaData()
For an aggregate AnalysisEngine only, gets a Map from each component's key to
ProcessingResourceMetaData for that component.
|
void |
batchProcessComplete()
Notifies this AnalysisEngine that processing of a batch has completed.
|
protected void |
buildProcessTraceFromMBeanStats(ProcessTrace trace)
Construct a ProcessTrace object that represents the last execution of this AnalysisEngine.
|
void |
collectionProcessComplete()
Notifies this AnalysisEngine that processing of an entire collection has completed.
|
void |
destroy()
Releases all resources held by this
Resource . |
protected FlowControllerDeclaration |
getDefaultFlowControllerDeclaration() |
protected void |
initASB(AnalysisEngineDescription aAnalysisEngineDescription,
Map<String,Object> aAdditionalParams)
A utility method that creates and configures the ASB component.
|
boolean |
initialize(ResourceSpecifier aSpecifier,
Map<String,Object> aAdditionalParams)
Initializes this
Resource from a ResourceSpecifier . |
protected void |
initializeAggregateAnalysisEngine(AnalysisEngineDescription aDescription,
Map<String,Object> aAdditionalParams)
A utility method that performs initialization logic for a aggregate AnalysisEngine.
|
CasIterator |
processAndOutputNewCASes(CAS aCAS)
Processes a CAS, possibly producing multiple CASes as a result.
|
protected void |
processDelegateAnalysisEngineMetaData()
Does processing using the delegate AnalysisEngine metadata once it becomes available.
|
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.
|
protected void |
validateOperationalProperties()
Checks operational properties in an aggregate to ensure they are not inconsistent with
operational properties of the components.
|
batchProcessComplete, buildProcessTraceFromMBeanStats, 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
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createResultSpecification, createResultSpecification, getAnalysisEngineMetaData, getFeatureNamesForType, getLogger, getManagementInterface, getPerformanceTuningSettings, getResourceManager, newCAS, newJCas, process, process, process, process, process, process, process, processAndOutputNewCASes, setLogger
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
getMetaData, getUimaContext, getUimaContextAdmin
processCas, processCas, typeSystemInit
batchProcessComplete, collectionProcessComplete, getProcessingResourceMetaData, isReadOnly, isStateless
public static final String PARAM_RESULT_SPECIFICATION
public boolean initialize(ResourceSpecifier aSpecifier, Map<String,Object> aAdditionalParams) throws ResourceInitializationException
Resource
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.initialize
in interface AnalysisEngine
initialize
in interface Resource
initialize
in class AnalysisEngineImplBase
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.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(ResourceSpecifier, Map)
public void setResultSpecification(ResultSpecification aResultSpec)
AnalysisEngine
setResultSpecification
in interface AnalysisEngine
setResultSpecification
in class AnalysisEngineImplBase
aResultSpec
- specifies the list of output types and features that the application is interested in.public void destroy()
Resource
Resource
.destroy
in interface Resource
destroy
in class Resource_ImplBase
Resource.destroy()
public CasIterator processAndOutputNewCASes(CAS aCAS) throws AnalysisEngineProcessException
AnalysisEngine
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.
processAndOutputNewCASes
in interface AnalysisEngine
processAndOutputNewCASes
in class AnalysisEngineImplBase
aCAS
- the CAS to be processedAnalysisEngineProcessException
- if a failure occurs during processingAnalysisEngine.processAndOutputNewCASes(CAS)
public void reconfigure() throws ResourceConfigurationException
ConfigurableResource
reconfigure
in interface AnalysisEngine
reconfigure
in interface ConfigurableResource
reconfigure
in class ConfigurableResource_ImplBase
ResourceConfigurationException
- if the configuration is not validAnalysisEngine.reconfigure()
public void batchProcessComplete() throws AnalysisEngineProcessException
AnalysisEngine
batchProcessComplete
in interface AnalysisEngine
batchProcessComplete
in class AnalysisEngineImplBase
AnalysisEngineProcessException
- if an exception occurs during processingpublic void collectionProcessComplete() throws AnalysisEngineProcessException
AnalysisEngine
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.
collectionProcessComplete
in interface AnalysisEngine
collectionProcessComplete
in class AnalysisEngineImplBase
AnalysisEngineProcessException
- if an exception occurs during processingprotected void initializeAggregateAnalysisEngine(AnalysisEngineDescription aDescription, Map<String,Object> aAdditionalParams) throws ResourceInitializationException
aDescription
- the AnalysisEngine description for this AnalysisEngineaAdditionalParams
- additional parameters that were passed to this AnalysisEngine's initialize method.ResourceInitializationException
- if an initialization failure occursprotected void initASB(AnalysisEngineDescription aAnalysisEngineDescription, Map<String,Object> aAdditionalParams) throws ResourceInitializationException
_getComponentMetaData()
method.aAnalysisEngineDescription
- the AnalysisEngine description for this AnalysisEngineaAdditionalParams
- parameters that will be passed to the ASB's initialize method.ResourceInitializationException
- if the ASB or a delegate AnalysisEngine could not be created.protected void processDelegateAnalysisEngineMetaData() throws ResourceInitializationException
Specifically, sets this aggregate AE's Type System, Type Priorities, and FS Index Descriptions equal to the result of merging the information from its delegate AEs.
ResourceInitializationException
- if an error occursprotected void validateOperationalProperties() throws ResourceInitializationException
ResourceInitializationException
- if there is an invalid parameter override declarationprotected FlowControllerDeclaration getDefaultFlowControllerDeclaration()
protected ASB _getASB()
protected Map<String,ProcessingResourceMetaData> _getComponentMetaData()
protected Map<String,ResourceSpecifier> _getComponentCasProcessorSpecifierMap()
protected void buildProcessTraceFromMBeanStats(ProcessTrace trace)
buildProcessTraceFromMBeanStats
in class AnalysisEngineImplBase
trace
- -Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.