AnnotationIteratorPair (Apache OpenNLP UIMA Annotators 2.5.9 API)
Description: declaration: package: opennlp.uima.util, class: AnnotationIteratorPair

# Class AnnotationIteratorPair

java.lang.Object
opennlp.uima.util.AnnotationIteratorPair

public final class AnnotationIteratorPair extends Object
A pair of a `UIMA annotation` and an `annotation iterator`.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `AnnotationIteratorPair(org.apache.uima.cas.text.AnnotationFS a, Iterable<org.apache.uima.cas.text.AnnotationFS> it)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `org.apache.uima.cas.text.AnnotationFS`
  `getAnnotation()`
  `Iterable<org.apache.uima.cas.text.AnnotationFS>`
  `getSubIterator()`

  ### Methods inherited from class Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### AnnotationIteratorPair

    public AnnotationIteratorPair(org.apache.uima.cas.text.AnnotationFS a, Iterable<org.apache.uima.cas.text.AnnotationFS> it)

- ## Method Details

  - ### getAnnotation

    public org.apache.uima.cas.text.AnnotationFS getAnnotation()
    Returns:
      Retrieves the `AnnotationFS`.

  - ### getSubIterator

    public Iterable<org.apache.uima.cas.text.AnnotationFS> getSubIterator()
    Returns:
      Retrieves the `sub-iterator`.