Package org.apache.uima.flow.impl
Class FixedFlowController.FixedFlowObject
- java.lang.Object
-
- org.apache.uima.flow.CasFlow_ImplBase
-
- org.apache.uima.flow.impl.FixedFlowController.FixedFlowObject
-
- All Implemented Interfaces:
Flow
- Enclosing class:
- FixedFlowController
class FixedFlowController.FixedFlowObject extends CasFlow_ImplBase
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
casMultiplierProducedNewCas
private int
currentStep
private boolean
internallyCreatedCas
private boolean
wasPassedToCasMultiplier
-
Constructor Summary
Constructors Constructor Description FixedFlowObject(int startStep)
Create a new fixed flow starting at stepstartStep
of the fixed sequence.FixedFlowObject(int startStep, boolean internallyCreatedCas)
Create a new fixed flow starting at stepstartStep
of the fixed sequence.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Flow
newCasProduced(CAS newCas, java.lang.String producedBy)
By default, throws an exception to indicate this this Flow object does not support new CASes being produced in the middle of the flow.Step
next()
Gets the next destination for the CAS.-
Methods inherited from class org.apache.uima.flow.CasFlow_ImplBase
aborted, continueOnFailure, getCas, newCasProduced, setCas
-
-
-
-
Constructor Detail
-
FixedFlowObject
public FixedFlowObject(int startStep)
Create a new fixed flow starting at stepstartStep
of the fixed sequence.- Parameters:
startStep
- index of mSequence to start at
-
FixedFlowObject
public FixedFlowObject(int startStep, boolean internallyCreatedCas)
Create a new fixed flow starting at stepstartStep
of the fixed sequence.- Parameters:
startStep
- index of mSequence to start atinternallyCreatedCas
- true to indicate that this Flow object is for a CAS that was produced by a CasMultiplier within this aggregate. Such CASes area allowed to be dropped and not output from the aggregate.
-
-
Method Detail
-
next
public Step next() throws AnalysisEngineProcessException
Description copied from interface:Flow
Gets the next destination for the CAS. This is defined by aStep
object. There may be different kinds of Step objects to indicate different kinds of routing actions.- Returns:
- the next destination for the CAS
- Throws:
AnalysisEngineProcessException
- if a failure occurs while determining the next destination
-
newCasProduced
public Flow newCasProduced(CAS newCas, java.lang.String producedBy) throws AnalysisEngineProcessException
Description copied from class:CasFlow_ImplBase
By default, throws an exception to indicate this this Flow object does not support new CASes being produced in the middle of the flow. Subclasses can override to implement handling for this.- Overrides:
newCasProduced
in classCasFlow_ImplBase
- Parameters:
newCas
- the new CASproducedBy
- the key of the CAS Multiplier that produced this CAS- Returns:
- a Flow object that will be used to route the new CAS
- Throws:
AnalysisEngineProcessException
- passthru- See Also:
Flow.newCasProduced(AbstractCas, String)
-
-