public interface ASB extends Resource
ASB) is the component responsible for the details of
 communicating with Analysis Engines that may potentially be distributed across different physical
 machines. The ASB hides all such details from the rest of the AnalysisEngine, which should be
 able to operate with no knowledge of whether Analysis Engines are co-located or distributed.| Modifier and Type | Field and Description | 
|---|---|
| static String | PARAM_AGGREGATE_ANALYSIS_ENGINE_NAMEKey for the initialization parameter whose value is the name of the aggregate analysis engine
 that owns this ASB. | 
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| Modifier and Type | Method and Description | 
|---|---|
| Map<String,ProcessingResourceMetaData> | getAllComponentMetaData()Gets the metadata for all components known to this ASB. | 
| Map<String,AnalysisEngineMetaData> | getComponentAnalysisEngineMetaData()Gets metadata for all of the component AnalysisEngines known to this  ASB. | 
| Map<String,AnalysisEngine> | getComponentAnalysisEngines()Gets references to the component AnalysisEngines known to this  ASB. | 
| FlowControllerContainer | getFlowControllerContainer()Gets the  FlowControllerContainerknown to this ASB. | 
| CasIterator | process(CAS aCAS)Invokes the processing of the aggregate on the given input CAS. | 
| void | setup(Map<String,ResourceSpecifier> aComponentSpecifiers,
     UimaContextAdmin aParentContext,
     FlowControllerDeclaration aFlowControllerDeclaration,
     AnalysisEngineMetaData aAggregateMetadata)Called by the Aggregate Analysis Engine to provide this ASB with information it needs to
 operate. | 
destroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, initialize, setLoggerstatic final String PARAM_AGGREGATE_ANALYSIS_ENGINE_NAME
void setup(Map<String,ResourceSpecifier> aComponentSpecifiers, UimaContextAdmin aParentContext, FlowControllerDeclaration aFlowControllerDeclaration, AnalysisEngineMetaData aAggregateMetadata) throws ResourceInitializationException
 This includes a collection of ResourceSpecifier objects that
 describe how to create or locate the component AnalysisEngines within the aggregate. Each
 ResourceSpecifier has an associated key, which the aggregate Analysis Engine and
 the FlowController use to identify that component.
 
This method is where the component AnalysisEngines and the FlowController are instantiated.
aComponentSpecifiers - a Map from String keys to ResourceSpecifier values, which specify how to
          create or locate the component CasObjectProcessors.aParentContext - the UIMA Context of the parent AnalysisEngine, used to construct the subcontexts for
          the components.aFlowControllerDeclaration - declaration (key and specifier) of FlowController to be used for this aggregate.aAggregateMetadata - metadata for the Aggregate AE, needed by the FlowControllerResourceInitializationException - if the ResourceFactory could not create or acquire a
           CasObjectProcessor instance for one of the specifiers in
           aComponentSpecifiers.Map<String,AnalysisEngineMetaData> getComponentAnalysisEngineMetaData()
ASB.AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers() to
         AnalysisEngineMetaData values.UIMA_IllegalStateException - if
           setup(Map, UimaContextAdmin, FlowControllerDeclaration, AnalysisEngineMetaData)
           has not been called yet.Map<String,ProcessingResourceMetaData> getAllComponentMetaData()
ProcessingResourceMetaData values.Map<String,AnalysisEngine> getComponentAnalysisEngines()
ASB.AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers() to
         AnalysisEngine objects.UIMA_IllegalStateException - if
           setup(Map, UimaContextAdmin, FlowControllerDeclaration, AnalysisEngineMetaData)
           has not been called yet.CasIterator process(CAS aCAS) throws AnalysisEngineProcessException
CasIterator.
 
 If the aggregate does not generate any output CASes of the input CAS, an empty
 CasIterator will be returned.
aCAS - the CAS to processAnalysisEngineProcessException - -FlowControllerContainer getFlowControllerContainer()
FlowControllerContainer known to this ASB. This includes the
 FlowController as well as the component AnalysisEngines.FlowControllerContainerCopyright © 2006–2022 The Apache Software Foundation. All rights reserved.