Package org.apache.uima.flow
Class CasFlowController_ImplBase
java.lang.Object
org.apache.uima.flow.FlowController_ImplBase
org.apache.uima.flow.CasFlowController_ImplBase
- All Implemented Interfaces:
FlowController
- Direct Known Subclasses:
CapabilityLanguageFlowController,FixedFlowController
Base class to be extended by FlowControllers that use the
CAS interface.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal FlowcomputeFlow(AbstractCas aCAS) Overriden to check thataCASis an instanceofCAS.abstract FlowcomputeFlow(CAS aCAS) This method must be overriden by subclasses.Returns the specific CAS interface that this FlowController requires the framework to pass to itsFlowController.computeFlow(AbstractCas)method.voidtypeSystemInit(TypeSystem aTypeSystem) This method may be overriden by subclasses.Methods inherited from class org.apache.uima.flow.FlowController_ImplBase
addAnalysisEngines, batchProcessComplete, collectionProcessComplete, destroy, getContext, getLogger, initialize, reconfigure, removeAnalysisEngines
-
Constructor Details
-
CasFlowController_ImplBase
public CasFlowController_ImplBase()
-
-
Method Details
-
getRequiredCasInterface
Description copied from interface:FlowControllerReturns the specific CAS interface that this FlowController requires the framework to pass to itsFlowController.computeFlow(AbstractCas)method.- Returns:
- the required CAS interface. This must specify a subtype of
AbstractCas.
-
computeFlow
Overriden to check thataCASis an instanceofCAS. If it is, thencomputeFlow(CAS)is called. If not, an exception is thrown.- Parameters:
aCAS- A CAS that this FlowController should process. The framework will ensure that aCAS implements the specific CAS interface declared in the <casInterface> element of this FlowController's descriptor.- Returns:
- a Flow object that has responsibility for routing
aCASthrough the Aggregate Analysis Engine. - Throws:
AnalysisEngineProcessException- if this FlowController encounters a problem computing the flow for the CAS- See Also:
-
computeFlow
This method must be overriden by subclasses. It takes aCASand returns aFlowobject that is responsible for routing this particular CAS through the components of this Aggregate. TheFlowobject should be given a handle to the CAS, so that it can use information in the CAS to make routing decisions.FlowController implementations will typically define their own class that implements
Flowby extending from the base classCasFlow_ImplBase. This method would then just instantiate the flow object, call itssetCasmethod to provide a handle to the CAS, and return the flow object.- Parameters:
aCAS- the CAS to be routed- Returns:
- a Flow object that will be used to route
aCAS - Throws:
AnalysisEngineProcessException- if a problem occurs during processing- See Also:
-
typeSystemInit
This method may be overriden by subclasses. It is called whenever th TypeSystem of the CAS changes. This method will be called immediately prior to the first call tocomputeFlow(CAS), and will be called again whenever the CAS TypeSystem changes.In this method, the FlowController can use the
TypeSystemto resolve the names of Type and Features to the actualTypeandFeatureobjects, which can then be used to access information from the CAS during routing.- Parameters:
aTypeSystem- the typesystem- Throws:
AnalysisEngineProcessException- if a problem occurs during processing
-