|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.flow.JCasFlow_ImplBase
public abstract class JCasFlow_ImplBase
Convenience base class for Flow objects that use the JCas interface. Stores the JCas in a field
made accessible through the protected getJCas()
method.
Constructor Summary | |
---|---|
JCasFlow_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 JCas |
getJCas()
Gets the JCas being routed by this Flow object. |
Flow |
newCasProduced(AbstractCas newCas,
java.lang.String producedBy)
Overriden to check that newCas is an instanceof JCas . |
protected Flow |
newCasProduced(JCas 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 |
setJCas(JCas aJCas)
Deprecated. this is done automatically by the framework with the 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 JCasFlow_ImplBase()
Method Detail |
---|
@Deprecated public void setJCas(JCas aJCas)
FlowController.computeFlow(AbstractCas)
method after this Flow object is instantiated.
aJCas
- the JCas to be routed by this Flow objectpublic final Flow newCasProduced(AbstractCas newCas, java.lang.String producedBy) throws AnalysisEngineProcessException
newCas
is an instanceof JCas
. If it is, then
newCasProduced(JCas,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(JCas newCas, java.lang.String producedBy) throws AnalysisEngineProcessException
newCas
- the new JCasproducedBy
- the key of the CAS Multiplier that produced this JCas
AnalysisEngineProcessException
- -Flow.newCasProduced(AbstractCas, String)
protected JCas getJCas()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |