|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.flow.FlowController_ImplBase
org.apache.uima.flow.CasFlowController_ImplBase
org.apache.uima.flow.impl.FixedFlowController
public class FixedFlowController
Simple FlowController that invokes components in a fixed sequence.
Field Summary | |
---|---|
static java.lang.String |
PARAM_ACTION_AFTER_CAS_MULTIPLIER
Key for the configuration parameter that determines what should happen to a CAS after it has been input to a CAS Multiplier. |
Constructor Summary | |
---|---|
FixedFlowController()
|
Method Summary | |
---|---|
void |
addAnalysisEngines(java.util.Collection<java.lang.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. |
void |
removeAnalysisEngines(java.util.Collection<java.lang.String> aKeys)
Throws an AnalysisEngineProcessException by default. |
Methods inherited from class org.apache.uima.flow.CasFlowController_ImplBase |
---|
computeFlow, getRequiredCasInterface, typeSystemInit |
Methods inherited from class org.apache.uima.flow.FlowController_ImplBase |
---|
batchProcessComplete, collectionProcessComplete, destroy, getContext, reconfigure |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PARAM_ACTION_AFTER_CAS_MULTIPLIER
Constructor Detail |
---|
public FixedFlowController()
Method Detail |
---|
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 FlowController
initialize
in class FlowController_ImplBase
aContext
- 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_ImplBase
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.
computeFlow
in class CasFlowController_ImplBase
aCAS
- the CAS to be routed
aCAS
AnalysisEngineProcessException
- if a problem occurs during processingFlowController.computeFlow(AbstractCas)
public void addAnalysisEngines(java.util.Collection<java.lang.String> aKeys)
FlowController_ImplBase
addAnalysisEngines
in interface FlowController
addAnalysisEngines
in class FlowController_ImplBase
aKeys
- 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(java.util.Collection<java.lang.String> aKeys) throws AnalysisEngineProcessException
FlowController_ImplBase
removeAnalysisEngines
in interface FlowController
removeAnalysisEngines
in class FlowController_ImplBase
aKeys
- 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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |