---

             

---

uima::Annotator Class Reference

Inherited by uima::TextAnnotator.

List of all members.

---

Detailed Description

The class Annotator defines the API methods an annotator must implement.

Public Member Functions
	Annotator (void)
virtual	~Annotator ()
void	setAnnotatorContext (AnnotatorContext &rclAnnotatorContext)
	set the AnnotatorContext.
AnnotatorContext &	getAnnotatorContext (void)
	get the annotator context of this annotator.
Annotator Processing Functions
virtual TyErrorId	initialize (AnnotatorContext &rclAnnotatorContext)
	Call the annotator to initialize itself based on an AnnotatorContext.
virtual TyErrorId	typeSystemInit (TypeSystem const &)
	Call the annotator to cache type/feature objects used in subsequent process() calls.
virtual TyErrorId	destroy (void)
	Call the annotator to deinitialize itself.
virtual TyErrorId	reconfigure ()
	Call the annotator to reconfigure itself.(optional method).
virtual TyErrorId	process (CAS &cas, ResultSpecification const &crResultSpecification)
	Call the annotator to perform its task with a ResultSpecification indicating what (sub)set of the capabilities of the annotator are actually needed.
virtual TyErrorId	batchProcessComplete ()
	Call the annotator to perform a batchProcessComplete operation.
virtual TyErrorId	collectionProcessComplete ()
	Call the annotator to perform a collectionProcessComplete operation.
virtual bool	hasNext ()
	Call the annotator to perform a hasNext operation to determine whether this analysis component will be returning new CASs.
virtual CAS &	next ()
	Call the annotator to retrieve the next CAS if hasNext() has returned true.
virtual int	getCasInstancesRequired ()
	Call the annotator to get the number of CAS instances it will use concurrently in order to determine the size of the CASPool for this component.

---

Constructor & Destructor Documentation

uima::Annotator::Annotator (  void   )  [inline]

virtual uima::Annotator::~Annotator (   )  [inline, virtual]

---

Member Function Documentation

void uima::Annotator::setAnnotatorContext (  AnnotatorContext &  rclAnnotatorContext  )  [inline]

set the AnnotatorContext. This function need not be called by the annotator code.

AnnotatorContext & uima::Annotator::getAnnotatorContext (  void   )  [inline]

get the annotator context of this annotator.

TyErrorId uima::Annotator::initialize (  AnnotatorContext &  rclAnnotatorContext  )  [inline, virtual]

Call the annotator to initialize itself based on an AnnotatorContext.

TyErrorId uima::Annotator::typeSystemInit (  TypeSystem const &   )  [inline, virtual]

Call the annotator to cache type/feature objects used in subsequent process() calls.

TyErrorId uima::Annotator::destroy (  void   )  [inline, virtual]

Call the annotator to deinitialize itself.

TyErrorId uima::Annotator::reconfigure (   )  [inline, virtual]

Call the annotator to reconfigure itself.(optional method).

TyErrorId uima::Annotator::process (  CAS &  cas, ResultSpecification const &  crResultSpecification )  [inline, virtual]

Call the annotator to perform its task with a ResultSpecification indicating what (sub)set of the capabilities of the annotator are actually needed. This method should only be called with an instance of Annotator. It should not be called with an instance of a TextAnnotator as the TextAnnotator works with a TCAS view of the CAS. Reimplemented in uima::TextAnnotator.

TyErrorId uima::Annotator::batchProcessComplete (   )  [inline, virtual]

Call the annotator to perform a batchProcessComplete operation.

TyErrorId uima::Annotator::collectionProcessComplete (   )  [inline, virtual]

Call the annotator to perform a collectionProcessComplete operation.

bool uima::Annotator::hasNext (   )  [inline, virtual]

Call the annotator to perform a hasNext operation to determine whether this analysis component will be returning new CASs.

CAS & uima::Annotator::next (   )  [inline, virtual]

Call the annotator to retrieve the next CAS if hasNext() has returned true.

int uima::Annotator::getCasInstancesRequired (   )  [inline, virtual]

Call the annotator to get the number of CAS instances it will use concurrently in order to determine the size of the CASPool for this component.

---

The documentation for this class was generated from the following file:

• annotator_abase.hpp

---