|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.uima.analysis_component.AnalysisComponent_ImplBase
org.apache.uima.analysis_component.JCasMultiplier_ImplBase
public abstract class JCasMultiplier_ImplBase
Base class to be extended by CAS Multipliers that use the CAS interface. A CAS Multiplier
can produce multiplie output CASes while processing an input CAS. See AnalysisComponent
for a description of how the framework calls the methods on this interface.
| Constructor Summary | |
|---|---|
JCasMultiplier_ImplBase()
|
|
| Method Summary | |
|---|---|
int |
getCasInstancesRequired()
Returns the maximum number of CAS instances that this CAS Multiplier expects to use at the same time. |
protected JCas |
getEmptyJCas()
Gets an empty JCas that this CAS Multiplier can then populate. |
Class<JCas> |
getRequiredCasInterface()
Returns the specific CAS interface that this AnalysisComponent requires the framework to pass to its AnalysisComponent.process(AbstractCas) method. |
void |
process(AbstractCas aCAS)
Inputs a CAS to the AnalysisComponent. |
abstract void |
process(JCas aJCas)
This method should be overriden by subclasses. |
| Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase |
|---|
batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, initialize, reconfigure, setResultSpecification |
| 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.analysis_component.AnalysisComponent |
|---|
hasNext, next |
| Constructor Detail |
|---|
public JCasMultiplier_ImplBase()
| Method Detail |
|---|
public final Class<JCas> getRequiredCasInterface()
AnalysisComponentAnalysisComponent.process(AbstractCas) method.
AbstractCas.public int getCasInstancesRequired()
public final void process(AbstractCas aCAS)
throws AnalysisEngineProcessException
AnalysisComponentAnalysisComponent.hasNext() is called and returns false or until process is called again
(see class description).
aCAS - A CAS that this AnalysisComponent should process. The framework will ensure that aCAS
implements the specific CAS interface specified by the
AnalysisComponent.getRequiredCasInterface() method.
AnalysisEngineProcessException - if a problem occurs during processing
public abstract void process(JCas aJCas)
throws AnalysisEngineProcessException
AnalysisComponent.hasNext() is called and returns
false, or until the process method is called again (see
AnalysisComponent for details).
aJCas - a JCAS that this AnalysisComponent should process.
AnalysisEngineProcessException - if a problem occurs during processingprotected final JCas getEmptyJCas()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||