|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.flow.CasFlow_ImplBase
public abstract class CasFlow_ImplBase
Convenience base class for Flow objects that use the CAS interface. Stores the CAS in a field
made accessible through the protected getCas()
method.
Constructor Summary | |
---|---|
CasFlow_ImplBase()
|
Method Summary | |
---|---|
void |
aborted()
By default, does nothing. |
boolean |
continueOnFailure(java.lang.String failedAeKey,
java.lang.Exception failure)
By default, returns false, indicating that processing cannot continue after a failure. |
protected CAS |
getCas()
Gets the CAS being routed by this Flow object. |
Flow |
newCasProduced(AbstractCas newCas,
java.lang.String producedBy)
Overriden to check that newCas is an instanceof CAS . |
protected 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. |
void |
setCas(CAS aCAS)
Deprecated. this is automatically done by the framework after a new flow object is created |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.uima.flow.Flow |
---|
next |
Constructor Detail |
---|
public CasFlow_ImplBase()
Method Detail |
---|
@Deprecated public void setCas(CAS aCAS)
FlowController.computeFlow(AbstractCas)
method after this Flow object is instantiated.
aCAS
- the CAS to be routed by this Flow objectpublic final Flow newCasProduced(AbstractCas newCas, java.lang.String producedBy) throws AnalysisEngineProcessException
newCas
is an instanceof CAS
. If it is, then
newCasProduced(CAS,String)
is called. If not, an exception is thrown.
newCasProduced
in interface Flow
newCas
- the new CASproducedBy
- key of the AnalysisEngine (CAS Multiplier) that produced the new CAS
aCAS
through the
Aggregate Analysis Engine.
AnalysisEngineProcessException
- passthruFlow.newCasProduced(AbstractCas, String)
public boolean continueOnFailure(java.lang.String failedAeKey, java.lang.Exception failure)
continueOnFailure
in interface Flow
failedAeKey
- The key of the analysis engine that failed.failure
- the Exception that occurred
Flow.continueOnFailure(String, java.lang.Exception)
public void aborted()
aborted
in interface Flow
Flow.aborted()
protected Flow newCasProduced(CAS newCas, java.lang.String producedBy) throws AnalysisEngineProcessException
newCas
- the new CASproducedBy
- the key of the CAS Multiplier that produced this CAS
AnalysisEngineProcessException
- passthruFlow.newCasProduced(AbstractCas, String)
protected CAS getCas()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |