public class FixedFlowController extends CasFlowController_ImplBase
| Modifier and Type | Field and Description | 
|---|---|
| static String | PARAM_ACTION_AFTER_CAS_MULTIPLIERKey for the configuration parameter that determines what should happen to a
 CAS after it has been input to a CAS Multiplier. | 
| Constructor and Description | 
|---|
| FixedFlowController() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | addAnalysisEngines(Collection<String> aKeys)Does nothing by default. | 
| Flow | computeFlow(CAS aCAS)This method must be overriden by subclasses. | 
| static FlowControllerDescription | getDescription() | 
| void | initialize(FlowControllerContext aContext)Performs any startup tasks required by this component. | 
| static FlowControllerDescription | makeDefaultDescription() | 
| void | removeAnalysisEngines(Collection<String> aKeys)Throws an AnalysisEngineProcessException by default. | 
computeFlow, getRequiredCasInterface, typeSystemInitbatchProcessComplete, collectionProcessComplete, destroy, getContext, getLogger, reconfigurepublic static final String PARAM_ACTION_AFTER_CAS_MULTIPLIER
public void initialize(FlowControllerContext aContext) throws ResourceInitializationException
FlowController
 The framework supplies this FlowController with a reference to the
 FlowControllerContext that it will use, for example to access configuration settings or
 resources. This FlowController should store a reference to this Context for later use.
initialize in interface FlowControllerinitialize in class FlowController_ImplBaseaContext - Provides access to services and resources managed by the framework. This includes
          configuration parameters, logging, and access to external resources. Also provides the
          FlowController with the metadata of all of the AnalysisEngines that are possible
          targets for routing CASes.ResourceInitializationException - if the FlowController cannot initialize successfully.public Flow computeFlow(CAS aCAS) throws AnalysisEngineProcessException
CasFlowController_ImplBaseCAS 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.
computeFlow in class CasFlowController_ImplBaseaCAS - the CAS to be routedaCASAnalysisEngineProcessException - if a problem occurs during processingFlowController.computeFlow(AbstractCas)public void addAnalysisEngines(Collection<String> aKeys)
FlowController_ImplBaseaddAnalysisEngines in interface FlowControlleraddAnalysisEngines in class FlowController_ImplBaseaKeys - a Collection of Strings, each of which is the key of an Analysis Engine to which CASes
          can be routed. These are the same keys as used in
          FlowControllerContext.getAnalysisEngineMetaDataMap().FlowController.addAnalysisEngines(java.util.Collection)public void removeAnalysisEngines(Collection<String> aKeys) throws AnalysisEngineProcessException
FlowController_ImplBaseremoveAnalysisEngines in interface FlowControllerremoveAnalysisEngines in class FlowController_ImplBaseaKeys - a Collection of Strings, each of which is the key of an Analysis Engine to which CASes
          may no longer be routed.AnalysisEngineProcessException - if the FlowController cannot continue with these Analysis Engines removed, or doesn't
           support removing Analysis Engines at all.FlowController.removeAnalysisEngines(java.util.Collection)public static FlowControllerDescription getDescription()
public static FlowControllerDescription makeDefaultDescription()
Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.