|
||||||||||
| 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.CasMultiplier_ImplBase
public abstract class CasMultiplier_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 | |
|---|---|
CasMultiplier_ImplBase()
|
|
| Method Summary | |
|---|---|
int |
getCasInstancesRequired()
Returns the maximum number of CAS instances that this CAS Multiplier expects to use at the same time. |
protected CAS |
getEmptyCAS()
Gets an empty CAS that this CAS Multiplier can then populate. |
Class<CAS> |
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(CAS aCAS)
This method should be overriden by subclasses. |
void |
typeSystemInit(TypeSystem aTypeSystem)
Informs this annotator that the CAS TypeSystem has changed. |
| 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 CasMultiplier_ImplBase()
| Method Detail |
|---|
public final Class<CAS> 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(CAS aCAS)
throws AnalysisEngineProcessException
AnalysisComponent.hasNext() is called and returns
false, or until the process method is called again (see
AnalysisComponent for details).
aCAS - A CAS that this AnalysisComponent should process.
AnalysisEngineProcessException - if a problem occurs during processing
public void typeSystemInit(TypeSystem aTypeSystem)
throws AnalysisEngineProcessException
AnalysisComponent_ImplBase.initialize(org.apache.uima.UimaContext), and will call
it again whenever the CAS TypeSystem changes.
In this method, the Annotator should use the TypeSystem to resolve the names of Type
and Features to the actual Type and
Feature objects, which can then be used during processing.
AnalysisEngineProcessException - if the provided type system is missing types or features required by this annotatorprotected final CAS getEmptyCAS()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||