# Package org.apache.uima.analysis_engine.annotator

package org.apache.uima.analysis_engine.annotator

The Annotator Interfaces, along with supporting interfaces and exception classes.

The annotator interfaces are as follows:

- ``BaseAnnotator``: the base interface for all annotators. Annotators should not implement this directly.
- ``GenericAnnotator``: an annotator that can process any type of entity.
- ``TextAnnotator``: an annotator that processes text documents.
- ``JTextAnnotator``: similar to `TextAnnotator`, but uses the Java-object-based `JCas` interface instead of the standard `CAS` interface.

- Related Packages
  Package
  Description
  org.apache.uima.analysis_engine
  The Analysis Engine interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.asb
  Contains the Analysis Structure Broker (ASB) interface, along with supporting interfaces and exception classes.
  org.apache.uima.analysis_engine.impl
  org.apache.uima.analysis_engine.metadata
  Interfaces for objects that represent metadata for an Analysis Engine.
- Class
  Description
  Annotator_ImplBase
  Deprecated.
  As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead
  AnnotatorConfigurationException
  An `AnnotatorConfigurationException` is thrown by an annotator if the settings of its configuration parameters are invalid.
  AnnotatorContext
  Deprecated.
  As of release 2.3.0, use UimaContext instead
  AnnotatorContextException
  An `AnnotatorContextException` is thrown by an `AnnotatorContext` if it cannot complete the invoked operation due to a failure in the underlying implementation.
  AnnotatorInitializationException
  An `AnnotatorInitializationException` may be thrown by an annotator's initialize method, indicating that the annotator failed to successfully initialize itself.
  AnnotatorProcessException
  An `AnnotatorProcessException` may be thrown by an annotator's process method, indicating that a failure occurred during processing.
  BaseAnnotator
  Base interface for annotators in UIMA SDK v1.x.
  GenericAnnotator
  Deprecated.
  As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead
  GenericAnnotator_ImplBase
  Deprecated.
  As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead
  JTextAnnotator
  Deprecated.
  As of release 2.3.0, use JCasAnnotator_ImplBase instead
  JTextAnnotator_ImplBase
  Deprecated.
  As of release 2.3.0, use JCasAnnotator_ImplBase instead
  TextAnnotator
  Deprecated.
  As of release 2.3.0, use CasAnnotator_ImplBase or JCasAnnotator_ImplBase instead