|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Flow
A Flow object is responsible for routing a single CAS through an Aggregate Analysis Engine.
Typically, developers extend CasFlow_ImplBase
or
JCasFlow_ImplBase
depending on which CAS interface they wish to use.
Method Summary | |
---|---|
Flow |
newCasProduced(AbstractCas newCas,
String producedBy)
Called by the framework if the CAS that is being routed by this Flow has been sent to a CAS Multiplier which has then created a new CAS derived from that original CAS. |
Step |
next()
Gets the next destination for the CAS. |
Method Detail |
---|
Step next() throws AnalysisEngineProcessException
Step
object. There may be
different kinds of Step objects to indicate different kinds of routing actions.
AnalysisEngineProcessException
- if a failure occurs while determining the next destinationFlow newCasProduced(AbstractCas newCas, String producedBy) throws AnalysisEngineProcessException
It is not required for a Flow implementation to support the production of new CASes in the middle of the flow, in which case this method may throw an exception.
If implemented, this method should construct a new Flow
object that will be used to
route the new CAS. The new Flow object then takes over all responsibility for that CAS.
newCas
- the new CASproducedBy
- key of the AnalysisEngine (CAS Multiplier) that produced the new CAS
aCAS
through the
Aggregate Analysis Engine.
AnalysisEngineProcessException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |