Class JCasAnnotator_ImplBase
- java.lang.Object
-
- org.apache.uima.analysis_component.AnalysisComponent_ImplBase
-
- org.apache.uima.analysis_component.Annotator_ImplBase
-
- org.apache.uima.analysis_component.JCasAnnotator_ImplBase
-
- All Implemented Interfaces:
AnalysisComponent
public abstract class JCasAnnotator_ImplBase extends Annotator_ImplBase
Base class to be extended by Annotators that use theJCas
interface. An Annotator is anAnalysisComponent
that may modify its input CAS, but never creates any new CASes as output.
-
-
Constructor Summary
Constructors Constructor Description JCasAnnotator_ImplBase()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Class<JCas>
getRequiredCasInterface()
Returns the specific CAS interface that this AnalysisComponent requires the framework to pass to itsAnalysisComponent.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.Annotator_ImplBase
getCasInstancesRequired, hasNext, next
-
Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase
batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, initialize, reconfigure, setResultSpecification
-
-
-
-
Method Detail
-
getRequiredCasInterface
public java.lang.Class<JCas> getRequiredCasInterface()
Description copied from interface:AnalysisComponent
Returns the specific CAS interface that this AnalysisComponent requires the framework to pass to itsAnalysisComponent.process(AbstractCas)
method.- Returns:
- the required CAS interface. This must specify a subtype of
AbstractCas
.
-
process
public void process(AbstractCas aCAS) throws AnalysisEngineProcessException
Description copied from interface:AnalysisComponent
Inputs a CAS to the AnalysisComponent. The AnalysisComponent "owns" this CAS until such time asAnalysisComponent.hasNext()
is called and returns false or untilprocess
is called again (see class description).- Parameters:
aCAS
- A CAS that this AnalysisComponent should process. The framework will ensure that aCAS implements the specific CAS interface specified by theAnalysisComponent.getRequiredCasInterface()
method.- Throws:
AnalysisEngineProcessException
- if a problem occurs during processing
-
process
public abstract void process(JCas aJCas) throws AnalysisEngineProcessException
This method should be overriden by subclasses. Inputs a JCAS to the AnalysisComponent. The AnalysisComponent "owns" this JCAS until such time asAnnotator_ImplBase.hasNext()
is called and returns false (seeAnalysisComponent
for details).- Parameters:
aJCas
- a JCAS that this AnalysisComponent should process.- Throws:
AnalysisEngineProcessException
- if a problem occurs during processing
-
-