Public Member Functions | |
TextAnnotator () | |
virtual | ~TextAnnotator () |
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. | |
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. | |
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. |
uima::TextAnnotator::TextAnnotator | ( | ) | [inline] |
virtual uima::TextAnnotator::~TextAnnotator | ( | ) | [inline, virtual] |
TyErrorId uima::TextAnnotator::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 from uima::Annotator.
void uima::Annotator::setAnnotatorContext | ( | AnnotatorContext & | rclAnnotatorContext | ) | [inline, inherited] |
set the AnnotatorContext.
This function need not be called by the annotator code.
AnnotatorContext & uima::Annotator::getAnnotatorContext | ( | void | ) | [inline, inherited] |
TyErrorId uima::Annotator::initialize | ( | AnnotatorContext & | rclAnnotatorContext | ) | [inline, virtual, inherited] |
TyErrorId uima::Annotator::typeSystemInit | ( | TypeSystem const & | ) | [inline, virtual, inherited] |
Call the annotator to cache type/feature objects used in subsequent process() calls.
References UIMA_ERR_NONE.
TyErrorId uima::Annotator::destroy | ( | void | ) | [inline, virtual, inherited] |
TyErrorId uima::Annotator::reconfigure | ( | ) | [inline, virtual, inherited] |
TyErrorId uima::Annotator::batchProcessComplete | ( | ) | [inline, virtual, inherited] |
TyErrorId uima::Annotator::collectionProcessComplete | ( | ) | [inline, virtual, inherited] |
bool uima::Annotator::hasNext | ( | ) | [inline, virtual, inherited] |
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, inherited] |
Call the annotator to retrieve the next CAS if hasNext() has returned true.
References UIMA_ERR_NOT_YET_IMPLEMENTED, UIMA_EXC_THROW_NEW, and uima::ErrorInfo::unrecoverable.
int uima::Annotator::getCasInstancesRequired | ( | ) | [inline, virtual, inherited] |
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.