public abstract class CasFlowController_ImplBase extends FlowController_ImplBase
CAS interface.| Constructor and Description |
|---|
CasFlowController_ImplBase() |
| Modifier and Type | Method and Description |
|---|---|
Flow |
computeFlow(AbstractCas aCAS)
Overriden to check that
aCAS is an instanceof CAS. |
abstract Flow |
computeFlow(CAS aCAS)
This method must be overriden by subclasses.
|
Class<CAS> |
getRequiredCasInterface()
Returns the specific CAS interface that this FlowController requires the framework to pass to
its
FlowController.computeFlow(AbstractCas) method. |
void |
typeSystemInit(TypeSystem aTypeSystem)
This method may be overriden by subclasses.
|
addAnalysisEngines, batchProcessComplete, collectionProcessComplete, destroy, getContext, initialize, reconfigure, removeAnalysisEnginespublic Class<CAS> getRequiredCasInterface()
FlowControllerFlowController.computeFlow(AbstractCas) method.AbstractCas.public final Flow computeFlow(AbstractCas aCAS) throws AnalysisEngineProcessException
aCAS is an instanceof CAS. If it is, then
computeFlow(CAS) is called. If not, an exception is thrown.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.aCAS through the
Aggregate Analysis Engine.AnalysisEngineProcessException - if this FlowController encounters a problem computing the flow for the CASFlowController.computeFlow(AbstractCas)public abstract Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException
CAS and returns a Flow
object that is responsible for routing this particular CAS through the components of this
Aggregate. The Flow object 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
Flow by extending from the base class CasFlow_ImplBase. This method would then
just instantiate the flow object, call its setCas method to provide a handle to
the CAS, and return the flow object.
aCAS - the CAS to be routedaCASAnalysisEngineProcessException - if a problem occurs during processingFlowController.computeFlow(AbstractCas)public void typeSystemInit(TypeSystem aTypeSystem) throws AnalysisEngineProcessException
computeFlow(CAS), and will be called again whenever the CAS TypeSystem changes.
In this method, the FlowController can use the TypeSystem to resolve the names of Type
and Features to the actual Type and
Feature objects, which can then be used to access information from
the CAS during routing.
aTypeSystem - the typesystemAnalysisEngineProcessException - if a problem occurs during processingCopyright © 2006–2021 The Apache Software Foundation. All rights reserved.