public abstract class JCasFlowController_ImplBase extends FlowController_ImplBase
JCas interface.| Constructor and Description |
|---|
JCasFlowController_ImplBase() |
| Modifier and Type | Method and Description |
|---|---|
Flow |
computeFlow(AbstractCas aCAS)
Overriden to check that
aCAS is an instanceof JCas. |
abstract Flow |
computeFlow(JCas aJCas)
This method must be overriden by subclasses.
|
Class<JCas> |
getRequiredCasInterface()
Returns the specific CAS interface that this FlowController requires the framework to pass to
its
FlowController.computeFlow(AbstractCas) method. |
addAnalysisEngines, batchProcessComplete, collectionProcessComplete, destroy, getContext, initialize, reconfigure, removeAnalysisEnginespublic Class<JCas> getRequiredCasInterface()
FlowControllerFlowController.computeFlow(AbstractCas) method.AbstractCas.public final Flow computeFlow(AbstractCas aCAS) throws AnalysisEngineProcessException
aCAS is an instanceof JCas. If it is, then
computeFlow(JCas) 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 CASpublic abstract Flow computeFlow(JCas aJCas) throws AnalysisEngineProcessException
JCas and returns a Flow
object that is responsible for routing this particular JCas through the components of this
Aggregate. The Flow object should be given a handle to the JCas, 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 JCasFlow_ImplBase. This method would
then just instantiate the flow object, call its setCas method to provide a
handle to the JCas, and return the flow object.
aJCas - the JCas to be routedaJCasAnalysisEngineProcessException - if a problem occurs during processingFlowController.computeFlow(AbstractCas)Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.