|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.resource.Resource_ImplBase
org.apache.uima.analysis_engine.asb.impl.ASB_impl
public class ASB_impl
A simple ASB
implementation. This implementation is not specific to any transport
technology. It simply uses the ResourceFactory
to acquire instances of its delegate
AnalysisEngines and then communicates with these delegate AnalysisEngines through the
AnalysisEngine
interface. Any communication with remote AnalysisEngine services is done
through a AnalysisEngineServiceAdapter
and is not
the concern of this ASB implementation.
Field Summary |
---|
Fields inherited from interface org.apache.uima.analysis_engine.asb.ASB |
---|
PARAM_AGGREGATE_ANALYSIS_ENGINE_NAME |
Fields inherited from interface org.apache.uima.resource.Resource |
---|
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_PARAM_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT |
Constructor Summary | |
---|---|
ASB_impl()
|
Method Summary | |
---|---|
void |
destroy()
Releases all resources held by this Resource . |
java.util.Map<java.lang.String,ProcessingResourceMetaData> |
getAllComponentMetaData()
Gets the metadata for all components known to this ASB. |
java.util.Map<java.lang.String,AnalysisEngineMetaData> |
getComponentAnalysisEngineMetaData()
Gets metadata for all of the component AnalysisEngines known to this ASB . |
java.util.Map<java.lang.String,AnalysisEngine> |
getComponentAnalysisEngines()
Gets references to the component AnalysisEngines known to this ASB . |
FlowControllerContainer |
getFlowControllerContainer()
Not public API. |
protected AnalysisEngineManagementImpl |
getMBean()
Gets the MBean that provides the management interface to this AE. |
protected void |
initFlowController(FlowControllerDeclaration aFlowControllerDeclaration,
UimaContextAdmin aParentContext,
AnalysisEngineMetaData aAggregateMetadata)
Initializes the FlowController for this aggregate. |
boolean |
initialize(ResourceSpecifier aSpecifier,
java.util.Map<java.lang.String,java.lang.Object> aAdditionalParams)
Initializes this ASB. |
CasIterator |
process(CAS aCAS)
Invokes the processing of the aggregate on the given input CAS. |
void |
setup(java.util.Map<java.lang.String,ResourceSpecifier> aSpecifiers,
UimaContextAdmin aParentContext,
FlowControllerDeclaration aFlowControllerDeclaration,
AnalysisEngineMetaData aAggregateMetadata)
Called after calling initialize() (see above) by the Aggregate Analysis Engine to provide this ASB with information it needs to operate. |
Methods inherited from class org.apache.uima.resource.Resource_ImplBase |
---|
getCasManager, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.uima.resource.Resource |
---|
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger |
Constructor Detail |
---|
public ASB_impl()
Method Detail |
---|
public boolean initialize(ResourceSpecifier aSpecifier, java.util.Map<java.lang.String,java.lang.Object> aAdditionalParams) throws ResourceInitializationException
initialize
in interface Resource
initialize
in class Resource_ImplBase
aSpecifier
- describes how to create this ASB.aAdditionalParams
- parameters which are passed along to the delegate Analysis Engines when they are
constructed
ResourceSpecifier
.
ResourceInitializationException
- if a failure occurs during initialization.Resource.initialize(ResourceSpecifier, Map)
public void destroy()
Resource
Resource
.
destroy
in interface Resource
destroy
in class Resource_ImplBase
Resource.destroy()
public void setup(java.util.Map<java.lang.String,ResourceSpecifier> aSpecifiers, UimaContextAdmin aParentContext, FlowControllerDeclaration aFlowControllerDeclaration, AnalysisEngineMetaData aAggregateMetadata) throws ResourceInitializationException
setup
in interface ASB
aSpecifiers
- the specifiers for all component AEs within this Aggregate. The ASB will instantiate
those AEs.aParentContext
- UIMA context for the aggregate AEaFlowControllerDeclaration
- declaration (key and specifier) of FlowController to be used for this aggregate.aAggregateMetadata
- metadata for the aggregate AE
ResourceInitializationException
protected void initFlowController(FlowControllerDeclaration aFlowControllerDeclaration, UimaContextAdmin aParentContext, AnalysisEngineMetaData aAggregateMetadata) throws ResourceInitializationException
ResourceInitializationException
public java.util.Map<java.lang.String,AnalysisEngineMetaData> getComponentAnalysisEngineMetaData()
ASB
ASB
.
getComponentAnalysisEngineMetaData
in interface ASB
AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()
to
AnalysisEngineMetaData
values.ASB.getComponentAnalysisEngineMetaData()
public java.util.Map<java.lang.String,AnalysisEngine> getComponentAnalysisEngines()
ASB
ASB
.
getComponentAnalysisEngines
in interface ASB
AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()
to
AnalysisEngine
objects.ASB.getComponentAnalysisEngines()
public java.util.Map<java.lang.String,ProcessingResourceMetaData> getAllComponentMetaData()
ASB
getAllComponentMetaData
in interface ASB
ProcessingResourceMetaData
values.public CasIterator process(CAS aCAS) throws AnalysisEngineProcessException
ASB
CasIterator
.
If the aggregate does not generate any output CASes of the input CAS, an empty
CasIterator
will be returned.
process
in interface ASB
aCAS
- the CAS to process
AnalysisEngineProcessException
public FlowControllerContainer getFlowControllerContainer()
getFlowControllerContainer
in interface ASB
FlowControllerContainer
protected AnalysisEngineManagementImpl getMBean()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |