org.apache.uima.fit.util

## Class JCasUtil

- java.lang.Object
- - org.apache.uima.fit.util.JCasUtil

-     public final class JCasUtil
      extends Object

  Utility methods for convenient access to the `JCas`.

- - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | `contains(org.apache.uima.jcas.JCas jCas, org.apache.uima.cas.text.AnnotationFS coveringAnnotation, Class<? extends org.apache.uima.jcas.tcas.Annotation> type)` Check if the given annotation contains any annotation of the given type.
    `static <T extends org.apache.uima.jcas.cas.TOP> boolean` | `exists(org.apache.uima.jcas.JCas aJCas, Class<T> aType)` Test if a JCas contains an annotation of the given type.
    `static org.apache.uima.cas.Type` | `getAnnotationType(org.apache.uima.jcas.JCas jCas, Class<?> type)` Get the CAS type for the given JCas wrapper class type making sure it inherits from `Annotation`.
    `static org.apache.uima.cas.Type` | `getType(org.apache.uima.jcas.JCas jCas, Class<?> type)` Get the CAS type for the given JCas wrapper class type.
    `static org.apache.uima.jcas.JCas` | `getView(org.apache.uima.jcas.JCas jcas, String viewName, boolean create)` Convenience method to get the specified view or create a new view if the requested view does not exist.
    `static org.apache.uima.jcas.JCas` | `getView(org.apache.uima.jcas.JCas jcas, String viewName, org.apache.uima.jcas.JCas fallback)` Convenience method to get the specified view or a default view if the requested view does not exist.
    `static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation> Map<T,Collection<S>>` | `indexCovered(org.apache.uima.jcas.JCas jCas, Class<? extends T> type, Class<? extends S> coveredType)` Create an index for quickly lookup up the annotations covered by a particular annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation> Map<T,Collection<S>>` | `indexCovering(org.apache.uima.jcas.JCas jCas, Class<? extends T> type, Class<? extends S> coveringType)` Create an index for quickly lookup up the annotations covering a particular annotation.
    `static <T extends org.apache.uima.cas.text.AnnotationFS> Iterator<T>` | `iterator(org.apache.uima.cas.text.AnnotationFS container, Class<T> type, boolean ambiguous, boolean strict)` Convenience method to get a sub-iterator for the specified type.
    `static <T extends org.apache.uima.jcas.cas.TOP> Iterator<T>` | `iterator(org.apache.uima.jcas.JCas jCas, Class<T> type)` Get an iterator over the given feature structure type.
    `static <T extends org.apache.uima.jcas.cas.TOP> Collection<T>` | `select(org.apache.uima.jcas.cas.FSArray array, Class<T> type)` Convenience method select all feature structure from the given type from an array.
    `static <T extends org.apache.uima.jcas.cas.TOP> Collection<T>` | `select(org.apache.uima.jcas.cas.FSList list, Class<T> type)` Convenience method select all feature structure from the given type from a list.
    `static <T extends org.apache.uima.jcas.cas.TOP> Collection<T>` | `select(org.apache.uima.jcas.JCas jCas, Class<T> type)` Convenience method to iterator over all features structures of a given type.
    `static Collection<org.apache.uima.jcas.cas.TOP>` | `selectAll(org.apache.uima.jcas.JCas jCas)` Convenience method to iterator over all features structures.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectAt(org.apache.uima.jcas.JCas jCas, Class<T> type, int aBegin, int aEnd)` Get all annotations of the given type at the specified offsets.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectBetween(Class<T> type, org.apache.uima.cas.text.AnnotationFS ann1, org.apache.uima.cas.text.AnnotationFS ann2)` Get a list of annotations of the given annotation type located between two annotations.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectBetween(org.apache.uima.jcas.JCas jCas, Class<T> type, org.apache.uima.cas.text.AnnotationFS ann1, org.apache.uima.cas.text.AnnotationFS ann2)` Get a list of annotations of the given annotation type located between two annotations.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> T` | `selectByIndex(org.apache.uima.jcas.JCas jCas, Class<T> cls, int index)` This method exists simply as a convenience method for unit testing.
    `static <T extends org.apache.uima.cas.text.AnnotationFS> List<T>` | `selectCovered(Class<T> type, org.apache.uima.cas.text.AnnotationFS coveringAnnotation)` Get a list of annotations of the given annotation type constrained by a 'covering' annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectCovered(org.apache.uima.jcas.JCas jCas, Class<T> type, org.apache.uima.cas.text.AnnotationFS coveringAnnotation)` Get a list of annotations of the given annotation type constrained by a 'covering' annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectCovered(org.apache.uima.jcas.JCas jCas, Class<T> type, int begin, int end)` Get a list of annotations of the given annotation type constrained by a 'covering' annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectCovering(Class<T> type, org.apache.uima.cas.text.AnnotationFS coveredAnnotation)` Get a list of annotations of the given annotation type constraint by a certain annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectCovering(org.apache.uima.jcas.JCas jCas, Class<T> type, org.apache.uima.cas.text.AnnotationFS coveredAnnotation)` Get a list of annotations of the given annotation type constraint by a certain annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectCovering(org.apache.uima.jcas.JCas jCas, Class<T> type, int begin, int end)` Get a list of annotations of the given annotation type constraint by a certain annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectFollowing(Class<T> aType, org.apache.uima.cas.text.AnnotationFS annotation, int count)` Returns the n annotations following the given annotation
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectFollowing(org.apache.uima.jcas.JCas aJCas, Class<T> aType, org.apache.uima.cas.text.AnnotationFS annotation, int count)` Returns the n annotations following the given annotation
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectPreceding(Class<T> aType, org.apache.uima.cas.text.AnnotationFS annotation, int count)` Returns the n annotations preceding the given annotation
    `static <T extends org.apache.uima.jcas.tcas.Annotation> List<T>` | `selectPreceding(org.apache.uima.jcas.JCas aJCas, Class<T> aType, org.apache.uima.cas.text.AnnotationFS annotation, int count)` Returns the n annotations preceding the given annotation
    `static <T extends org.apache.uima.jcas.cas.TOP> T` | `selectSingle(org.apache.uima.jcas.JCas jCas, Class<T> type)` Get the single instance of the specified type from the JCas.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> T` | `selectSingleAt(org.apache.uima.jcas.JCas jCas, Class<T> type, int aBegin, int aEnd)` Get a single annotations of the given type at the specified offsets.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> T` | `selectSingleRelative(Class<T> aType, org.apache.uima.cas.text.AnnotationFS annotation, int index)` Return an annotation preceding or following of a given reference annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> T` | `selectSingleRelative(org.apache.uima.jcas.JCas aJCas, Class<T> aType, org.apache.uima.cas.text.AnnotationFS aAnchor, int aPosition)` Return an annotation preceding or following of a given reference annotation.
    `static <T extends org.apache.uima.jcas.tcas.Annotation> Iterable<T>` | `subiterate(org.apache.uima.jcas.JCas jCas, Class<T> type, org.apache.uima.cas.text.AnnotationFS container, boolean ambiguous, boolean strict)` Convenience method to iterator over all annotations of a given type occurring within the scope of a provided annotation (sub-iteration).
    `static <T extends org.apache.uima.cas.text.AnnotationFS> List<String>` | `toText(Iterable<T> iterable)` Fetch the text covered by the specified annotations and return it as a list of strings.

    - ### Methods inherited from class java.lang.Object

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

- - ### Method Detail

    - #### subiterate

          public static <T extends org.apache.uima.jcas.tcas.Annotation> Iterable<T> subiterate(org.apache.uima.jcas.JCas jCas,
                                                                                                Class<T> type,
                                                                                                org.apache.uima.cas.text.AnnotationFS container,
                                                                                                boolean ambiguous,
                                                                                                boolean strict)

      Convenience method to iterator over all annotations of a given type occurring within the scope of a provided annotation (sub-iteration).
      Type Parameters:
        `T` - the iteration type.
      Parameters:
        `jCas` - a JCas.
        `container` - the containing annotation.
        `type` - the type.
        `ambiguous` - If set to `false`, resulting iterator will be unambiguous.
        `strict` - Controls if annotations that overlap to the right are considered in or out.
      Returns:
        A sub-iterator iterable.
      See Also:
        `AnnotationIndex.subiterator(AnnotationFS, boolean, boolean)`, Order of selected feature structures

    - #### iterator

          public static <T extends org.apache.uima.jcas.cas.TOP> Iterator<T> iterator(org.apache.uima.jcas.JCas jCas,
                                                                                      Class<T> type)

      Get an iterator over the given feature structure type.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `jCas` - a JCas.
        `type` - a type.
      Returns:
        a return value.
      See Also:
        Order of selected feature structures

    - #### iterator

          public static <T extends org.apache.uima.cas.text.AnnotationFS> Iterator<T> iterator(org.apache.uima.cas.text.AnnotationFS container,
                                                                                               Class<T> type,
                                                                                               boolean ambiguous,
                                                                                               boolean strict)

      Convenience method to get a sub-iterator for the specified type.
      Type Parameters:
        `T` - the iteration type.
      Parameters:
        `container` - the containing annotation.
        `type` - the type.
        `ambiguous` - If set to `false`, resulting iterator will be unambiguous.
        `strict` - Controls if annotations that overlap to the right are considered in or out.
      Returns:
        A sub-iterator.
      See Also:
        Order of selected feature structures

    - #### getType

          public static org.apache.uima.cas.Type getType(org.apache.uima.jcas.JCas jCas,
                                                         Class<?> type)

      Get the CAS type for the given JCas wrapper class type.
      Parameters:
        `jCas` - the JCas containing the type system.
        `type` - the JCas wrapper class type.
      Returns:
        the CAS type.

    - #### getAnnotationType

          public static org.apache.uima.cas.Type getAnnotationType(org.apache.uima.jcas.JCas jCas,
                                                                   Class<?> type)

      Get the CAS type for the given JCas wrapper class type making sure it inherits from `Annotation`.
      Parameters:
        `jCas` - the JCas containing the type system.
        `type` - the JCas wrapper class type.
      Returns:
        the CAS type.

    - #### select

          public static <T extends org.apache.uima.jcas.cas.TOP> Collection<T> select(org.apache.uima.jcas.cas.FSArray array,
                                                                                      Class<T> type)

      Convenience method select all feature structure from the given type from an array.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `array` - a feature structure array.
        `type` - the type.
      Returns:
        A collection of the selected type.
      See Also:
        Order of selected feature structures

    - #### select

          public static <T extends org.apache.uima.jcas.cas.TOP> Collection<T> select(org.apache.uima.jcas.cas.FSList list,
                                                                                      Class<T> type)

      Convenience method select all feature structure from the given type from a list.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `list` - a feature structure list.
        `type` - the type.
      Returns:
        A collection of the selected type.
      See Also:
        Order of selected feature structures

    - #### select

          public static <T extends org.apache.uima.jcas.cas.TOP> Collection<T> select(org.apache.uima.jcas.JCas jCas,
                                                                                      Class<T> type)

      Convenience method to iterator over all features structures of a given type.
      Type Parameters:
        `T` - the iteration type.
      Parameters:
        `jCas` - the JCas containing the type system.
        `type` - the type.
      Returns:
        A collection of the selected type.
      See Also:
        Order of selected feature structures

    - #### selectAt

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectAt(org.apache.uima.jcas.JCas jCas,
                                                                                          Class<T> type,
                                                                                          int aBegin,
                                                                                          int aEnd)

      Get all annotations of the given type at the specified offsets.
      Type Parameters:
        `T` - the type of annotations to fetch.
      Parameters:
        `jCas` - the CAS containing the annotations.
        `type` - the type of annotations to fetch.
        `aBegin` - the begin offset.
        `aEnd` - the end offset.
      Returns:
        the annotations at the specified offsets.

    - #### selectSingleAt

          public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectSingleAt(org.apache.uima.jcas.JCas jCas,
                                                                                          Class<T> type,
                                                                                          int aBegin,
                                                                                          int aEnd)

      Get a single annotations of the given type at the specified offsets.
      Type Parameters:
        `T` - the type of annotations to fetch.
      Parameters:
        `jCas` - the CAS containing the annotations.
        `type` - the type of annotations to fetch.
        `aBegin` - the begin offset.
        `aEnd` - the end offset.
      Returns:
        the annotation at the specified offsets.

    - #### selectAll

          public static Collection<org.apache.uima.jcas.cas.TOP> selectAll(org.apache.uima.jcas.JCas jCas)

      Convenience method to iterator over all features structures.
      Parameters:
        `jCas` - the JCas containing the type system. the type.
      Returns:
        A collection of the selected type.
      See Also:
        Order of selected feature structures

    - #### selectBetween

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectBetween(Class<T> type,
                                                                                               org.apache.uima.cas.text.AnnotationFS ann1,
                                                                                               org.apache.uima.cas.text.AnnotationFS ann2)

      Get a list of annotations of the given annotation type located between two annotations. Does not use subiterators and does not respect type priorities. Zero-width annotations what lie on the borders are included in the result, e.g. if the boundary annotations are [1..2] and [2..3] then an annotation [2..2] is returned. If there is a non-zero overlap between the boundary annotations, the result is empty. The method properly handles cases where the second boundary annotations occurs before the first boundary annotation by switching their roles.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `type` - a UIMA type.
        `ann1` - the first boundary annotation.
        `ann2` - the second boundary annotation.
      Returns:
        a return value.
      See Also:
        `Subiterator`, Order of selected feature structures

    - #### selectBetween

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectBetween(org.apache.uima.jcas.JCas jCas,
                                                                                               Class<T> type,
                                                                                               org.apache.uima.cas.text.AnnotationFS ann1,
                                                                                               org.apache.uima.cas.text.AnnotationFS ann2)

      Get a list of annotations of the given annotation type located between two annotations. Does not use subiterators and does not respect type priorities. Zero-width annotations what lie on the borders are included in the result, e.g. if the boundary annotations are [1..2] and [2..3] then an annotation [2..2] is returned. If there is a non-zero overlap between the boundary annotations, the result is empty. The method properly handles cases where the second boundary annotations occurs before the first boundary annotation by switching their roles.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `jCas` - a JCas containing the annotation.
        `type` - a UIMA type.
        `ann1` - the first boundary annotation.
        `ann2` - the second boundary annotation.
      Returns:
        a return value.
      See Also:
        `Subiterator`, Order of selected feature structures

    - #### selectCovered

          public static <T extends org.apache.uima.cas.text.AnnotationFS> List<T> selectCovered(Class<T> type,
                                                                                                org.apache.uima.cas.text.AnnotationFS coveringAnnotation)

      Get a list of annotations of the given annotation type constrained by a 'covering' annotation. Iterates over all annotations of the given type to find the covered annotations. Does not use subiterators.

      The covering annotation is never returned itself, even if it is of the queried-for type or a subtype of that type.

      The method only returns properly covered annotations, that is annotations where the begin/end offsets are equal to the 'covering' annotation or where both the begin/end are included in the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `type` - a UIMA type.
        `coveringAnnotation` - the covering annotation.
      Returns:
        a return value.
      See Also:
        `Subiterator`, Order of selected feature structures

    - #### selectCovered

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectCovered(org.apache.uima.jcas.JCas jCas,
                                                                                               Class<T> type,
                                                                                               org.apache.uima.cas.text.AnnotationFS coveringAnnotation)

      Get a list of annotations of the given annotation type constrained by a 'covering' annotation. Iterates over all annotations of the given type to find the covered annotations. Does not use subiterators.

      The covering annotation is never returned itself, even if it is of the queried-for type or a subtype of that type.

      The method only returns properly covered annotations, that is annotations where the begin/end offsets are equal to the 'covering' annotation or where both the begin/end are included in the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `jCas` - a JCas containing the annotation.
        `type` - a UIMA type.
        `coveringAnnotation` - the covering annotation.
      Returns:
        a return value.
      See Also:
        `Subiterator`, Order of selected feature structures

    - #### selectCovered

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectCovered(org.apache.uima.jcas.JCas jCas,
                                                                                               Class<T> type,
                                                                                               int begin,
                                                                                               int end)

      Get a list of annotations of the given annotation type constrained by a 'covering' annotation. Iterates over all annotations of the given type to find the covered annotations. Does not use subiterators.

      Note: this is significantly slower than using `selectCovered(JCas, Class, AnnotationFS)`. It is possible to use `selectCovered(jCas, cls, new Annotation(jCas, int, int))`, but that will allocate memory in the jCas for the new annotation. If you do that repeatedly many times, memory may fill up.

      The method only returns properly covered annotations, that is annotations where the begin/end offsets are equal to the given begin/end or where both the begin/end are included in the span of the given span. Partially overlapping annotations are not returned.

      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `jCas` - a JCas containing the annotation.
        `type` - a UIMA type.
        `begin` - begin offset.
        `end` - end offset.
      Returns:
        a return value.
      See Also:
        Order of selected feature structures

    - #### selectCovering

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectCovering(Class<T> type,
                                                                                                org.apache.uima.cas.text.AnnotationFS coveredAnnotation)

      Get a list of annotations of the given annotation type constraint by a certain annotation. Iterates over all annotations to find the covering annotations.

      The method only returns properly covering annotations, that is annotations where the begin/end offsets are equal to the begin/end of the given annotation or where given 'covered' annotation is properly contained within the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      Note: this is REALLY SLOW! You don't want to use this. Instead, consider using `indexCovering(JCas, Class, Class)` or a `ContainmentIndex`.

      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `type` - a UIMA type.
        `coveredAnnotation` - the covered annotation.
      Returns:
        a return value.
      See Also:
        Order of selected feature structures

    - #### selectCovering

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectCovering(org.apache.uima.jcas.JCas jCas,
                                                                                                Class<T> type,
                                                                                                org.apache.uima.cas.text.AnnotationFS coveredAnnotation)

      Get a list of annotations of the given annotation type constraint by a certain annotation. Iterates over all annotations to find the covering annotations.

      The method only returns properly covering annotations, that is annotations where the begin/end offsets are equal to the begin/end of the given annotation or where given 'covered' annotation is properly contained within the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      Note: this is REALLY SLOW! You don't want to use this. Instead, consider using `indexCovering(JCas, Class, Class)` or a `ContainmentIndex`.

      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `jCas` - a CAS.
        `type` - a UIMA type.
        `coveredAnnotation` - the covered annotation.
      Returns:
        a return value.
      See Also:
        Order of selected feature structures

    - #### selectCovering

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectCovering(org.apache.uima.jcas.JCas jCas,
                                                                                                Class<T> type,
                                                                                                int begin,
                                                                                                int end)

      Get a list of annotations of the given annotation type constraint by a certain annotation. Iterates over all annotations to find the covering annotations.

      The method only returns properly covering annotations, that is annotations where the begin/end offsets are equal to the given begin/end to or where given span is properly contained within the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      Note: this is REALLY SLOW! You don't want to use this. Instead, consider using `indexCovering(JCas, Class, Class)` or a `ContainmentIndex`.

      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `jCas` - a CAS.
        `type` - a UIMA type.
        `begin` - begin offset.
        `end` - end offset.
      Returns:
        a return value.
      See Also:
        Order of selected feature structures

    - #### indexCovering

          public static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation> Map<T,Collection<S>> indexCovering(org.apache.uima.jcas.JCas jCas,
                                                                                                                                                           Class<? extends T> type,
                                                                                                                                                           Class<? extends S> coveringType)

      Create an index for quickly lookup up the annotations covering a particular annotation. This is preferable to using `selectCovering(JCas, Class, int, int)` because the overhead of scanning the CAS occurs only when the index is build. Subsequent lookups to the index are fast.

      The method only returns properly covering annotations, that is annotations where the begin/end offsets are equal to the begin/end of the given annotation or where given 'covered' annotation is properly contained within the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      When querying for the annotations covering a given annotation, the given annotation itself is never returned, even if it is of the queried type.

      Type Parameters:
        `T` - the covered JCAs type.
        `S` - the covering JCas type.
      Parameters:
        `jCas` - a JCas.
        `type` - type to create the index for - this is used in lookups.
        `coveringType` - type of covering annotations.
      Returns:
        the index.
      See Also:
        Order of selected feature structures

    - #### indexCovered

          public static <T extends org.apache.uima.jcas.tcas.Annotation,S extends org.apache.uima.jcas.tcas.Annotation> Map<T,Collection<S>> indexCovered(org.apache.uima.jcas.JCas jCas,
                                                                                                                                                          Class<? extends T> type,
                                                                                                                                                          Class<? extends S> coveredType)

      Create an index for quickly lookup up the annotations covered by a particular annotation. This is preferable to using `selectCovered(JCas, Class, int, int)` because the overhead of scanning the CAS occurs only when the index is build. Subsequent lookups to the index are fast. The order of entries in the map is not defined. However, lists of covered annotations in the map are guaranteed to be in the same order as in the UIMA default annotation index.

      The method only returns properly covered annotations, that is annotations where the begin/end offsets are equal to the 'covering' annotation or where both the begin/end are included in the span of the 'covering' annotation. Partially overlapping annotations are not returned.

      When querying for the annotations covered by a given annotation, the given annotation itself is never returned, even if it is of the queried type.

      Type Parameters:
        `T` - the covering JCas type.
        `S` - the covered JCas type.
      Parameters:
        `jCas` - a JCas.
        `type` - type to create the index for - this is used in lookups.
        `coveredType` - type of covered annotations.
      Returns:
        the index.
      See Also:
        Order of selected feature structures

    - #### contains

          public static boolean contains(org.apache.uima.jcas.JCas jCas,
                                         org.apache.uima.cas.text.AnnotationFS coveringAnnotation,
                                         Class<? extends org.apache.uima.jcas.tcas.Annotation> type)

      Check if the given annotation contains any annotation of the given type.
      Parameters:
        `jCas` - a JCas containing the annotation.
        `coveringAnnotation` - the covering annotation.
        `type` - a UIMA type.
      Returns:
        if an annotation of the given type is present.
      See Also:
        Order of selected feature structures

    - #### selectByIndex

          public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectByIndex(org.apache.uima.jcas.JCas jCas,
                                                                                         Class<T> cls,
                                                                                         int index)

      This method exists simply as a convenience method for unit testing. It is not very efficient and should not, in general be used outside the context of unit testing.

      It is intentional that this method only allows annotation types. The CAS indexing mechanisms are not well defined for non-annotation types. There are no reliably, built-in indexes for non-annotation types.

      Type Parameters:
        `T` - JCas wrapper type.
      Parameters:
        `jCas` - a JCas containing the annotation.
        `cls` - a UIMA type.
        `index` - this can be either positive (0 corresponds to the first annotation of a type) or negative (-1 corresponds to the last annotation of a type.)
      Returns:
        an annotation of the given type
      See Also:
        Order of selected feature structures

    - #### selectSingle

          public static <T extends org.apache.uima.jcas.cas.TOP> T selectSingle(org.apache.uima.jcas.JCas jCas,
                                                                                Class<T> type)

      Get the single instance of the specified type from the JCas.
      Type Parameters:
        `T` - JCas wrapper type.
      Parameters:
        `jCas` - a JCas containing the annotation.
        `type` - a UIMA type.
      Returns:
        the single instance of the given type. throws IllegalArgumentException if not exactly one instance if the given type is present.

    - #### selectSingleRelative

          public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectSingleRelative(Class<T> aType,
                                                                                                org.apache.uima.cas.text.AnnotationFS annotation,
                                                                                                int index)

      Return an annotation preceding or following of a given reference annotation.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `aType` - a type.
        `annotation` - anchor annotation
        `index` - relative position to access. A negative value selects a preceding annotation while a positive number selects a following annotation.
      Returns:
        the addressed annotation.
      Throws:
        `IndexOutOfBoundsException` - if the relative index points beyond the type index bounds.
      See Also:
        Order of selected feature structures

    - #### selectSingleRelative

          public static <T extends org.apache.uima.jcas.tcas.Annotation> T selectSingleRelative(org.apache.uima.jcas.JCas aJCas,
                                                                                                Class<T> aType,
                                                                                                org.apache.uima.cas.text.AnnotationFS aAnchor,
                                                                                                int aPosition)

      Return an annotation preceding or following of a given reference annotation. If the type parameter corresponds to the type or a subtype of the anchor annotation and the relative position is 0, then the anchor annotation is returned.
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `aJCas` - a JCas.
        `aType` - type of the annotation to be returned.
        `aAnchor` - anchor annotation
        `aPosition` - relative position to access. A negative value selects a preceding annotation while a positive number selects a following annotation.
      Returns:
        the addressed annotation.
      Throws:
        `IndexOutOfBoundsException` - if the relative position points beyond the type index bounds.
        `IllegalArgumentException` - if the relative position is `0` and the anchor type does not subsume the selected type.
      See Also:
        Order of selected feature structures

    - #### selectPreceding

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectPreceding(Class<T> aType,
                                                                                                 org.apache.uima.cas.text.AnnotationFS annotation,
                                                                                                 int count)

      Returns the n annotations preceding the given annotation
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `aType` - a type.
        `annotation` - anchor annotation
        `count` - number of annotations to collect
      Returns:
        List of aType annotations preceding anchor annotation
      See Also:
        Order of selected feature structures

    - #### selectPreceding

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectPreceding(org.apache.uima.jcas.JCas aJCas,
                                                                                                 Class<T> aType,
                                                                                                 org.apache.uima.cas.text.AnnotationFS annotation,
                                                                                                 int count)

      Returns the n annotations preceding the given annotation
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `aJCas` - a JCas.
        `aType` - a type.
        `annotation` - anchor annotation
        `count` - number of annotations to collect
      Returns:
        List of aType annotations preceding anchor annotation
      See Also:
        Order of selected feature structures

    - #### selectFollowing

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectFollowing(Class<T> aType,
                                                                                                 org.apache.uima.cas.text.AnnotationFS annotation,
                                                                                                 int count)

      Returns the n annotations following the given annotation
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `aType` - a type.
        `annotation` - anchor annotation
        `count` - number of annotations to collect
      Returns:
        List of aType annotations following anchor annotation
      See Also:
        Order of selected feature structures

    - #### selectFollowing

          public static <T extends org.apache.uima.jcas.tcas.Annotation> List<T> selectFollowing(org.apache.uima.jcas.JCas aJCas,
                                                                                                 Class<T> aType,
                                                                                                 org.apache.uima.cas.text.AnnotationFS annotation,
                                                                                                 int count)

      Returns the n annotations following the given annotation
      Type Parameters:
        `T` - the JCas type.
      Parameters:
        `aJCas` - a JCas.
        `aType` - a type.
        `annotation` - anchor annotation
        `count` - number of annotations to collect
      Returns:
        List of aType annotations following anchor annotation
      See Also:
        Order of selected feature structures

    - #### exists

          public static <T extends org.apache.uima.jcas.cas.TOP> boolean exists(org.apache.uima.jcas.JCas aJCas,
                                                                                Class<T> aType)

      Test if a JCas contains an annotation of the given type.
      Type Parameters:
        `T` - the annotation type.
      Parameters:
        `aJCas` - a JCas.
        `aType` - a annotation class.
      Returns:
        `true` if there is at least one annotation of the given type in the JCas.

    - #### getView

          public static org.apache.uima.jcas.JCas getView(org.apache.uima.jcas.JCas jcas,
                                                          String viewName,
                                                          org.apache.uima.jcas.JCas fallback)

      Convenience method to get the specified view or a default view if the requested view does not exist. The default can also be `null`.
      Parameters:
        `jcas` - a JCas
        `viewName` - the requested view.
        `fallback` - the default view if the requested view does not exist.
      Returns:
        the requested view or the default if the requested view does not exist.
      Throws:
        `IllegalStateException` - if the JCas wrapper cannot be obtained.

    - #### getView

          public static org.apache.uima.jcas.JCas getView(org.apache.uima.jcas.JCas jcas,
                                                          String viewName,
                                                          boolean create)

      Convenience method to get the specified view or create a new view if the requested view does not exist.
      Parameters:
        `jcas` - a JCas
        `viewName` - the requested view.
        `create` - the view is created if it does not exist.
      Returns:
        the requested view
      Throws:
        `IllegalStateException` - if the JCas wrapper cannot be obtained.

    - #### toText

          public static <T extends org.apache.uima.cas.text.AnnotationFS> List<String> toText(Iterable<T> iterable)

      Fetch the text covered by the specified annotations and return it as a list of strings.
      Type Parameters:
        `T` - UIMA JCas type.
      Parameters:
        `iterable` - annotation container.
      Returns:
        list of covered strings.

Copyright © 2012–2020 The Apache Software Foundation. All rights reserved.