Package org.apache.uima.cas.impl

Class FsIndex_flat<T extends FeatureStructure>

java.lang.Object
java.util.AbstractCollection<T>
org.apache.uima.cas.impl.FsIndex_singletype<T>
org.apache.uima.cas.impl.FsIndex_flat<T>
Type Parameters:
T - the Java class type for this index
All Implemented Interfaces:
Iterable<T>, Collection<T>, Comparator<FeatureStructure>, FSIndex<T>, LowLevelIndex<T>
public class FsIndex_flat<T extends FeatureStructure> extends FsIndex_singletype<T>
Common part of flattened indexes, used for both snapshot iterators and flattened sorted indexes built from passed in instance of FsIndex_iicp

  • Method Details

    • iterator

      public LowLevelIterator<T> iterator()
      Description copied from interface: LowLevelIndex
      Return an iterator over the index. The position of the iterator will be set to return the first item in the index. If the index is empty, the iterator position will be marked as invalid.
      Specified by:
      iterator in interface Collection<T extends FeatureStructure>
      Specified by:
      iterator in interface FSIndex<T extends FeatureStructure>
      Specified by:
      iterator in interface Iterable<T extends FeatureStructure>
      Specified by:
      iterator in interface LowLevelIndex<T extends FeatureStructure>
      Specified by:
      iterator in class AbstractCollection<T extends FeatureStructure>
      Returns:
      An FSIterator positioned at the beginning, or an invalid iterator.

    • iterator

      public LowLevelIterator<T> iterator(boolean orderNotNeeded, boolean ignoreType)
      Description copied from interface: LowLevelIndex
      Internal use, used by select framework. Return an iterator over the index. The position of the iterator will be set to return the first item in the index. If the index is empty, the iterator position will be marked as invalid.
      Parameters:
      orderNotNeeded - if true, skips work while iterating to keep iterators over multiple types in sync.
      ignoreType - if true, the comparator used for moveTo leftmost operations will ignore typeOrder keys, if the index happens to define these
      Returns:
      An FSIterator positioned at the beginning, or an invalid iterator.

    • contains

      public boolean contains(FeatureStructure fs)
      Description copied from interface: FSIndex

      Check if the index contains an element equal to the given feature structure according to the comparators defined for this index. For bag indexes (which have no comparators), the equality test means the identical feature structure. Note that this is in general not the same as feature structure identity.

      The element is used as a template, and may be a supertype of the type of the index, as long as the keys specified for this index can be accessed.

      Parameters:
      fs - A Feature Structure used a template to match for equality with the FSs in the index.
      Returns:
      true if the index contains such an element.

    • find

      public T find(FeatureStructure fs)
      Description copied from interface: FSIndex
      Find an entry in the index "equal to" the given feature structure according to the comparators specified for this index. Note that this is in general not the same as feature structure identity. For BAG indexes, it is identity, for others it means the found feature structure compares equal with the parameter in terms of the defined comparators for the index. If there are multiple different FSs in the index which compare equal with the given feature structure, an arbitrary one is returned. This differs from the moveTo(fs) operation which guarantees to move to the first feature structure occurring in the index in this case.
      Parameters:
      fs - A Feature Structure used a template to match with the Feature Structures in the index. It must have the keys needed to do the compare as specified for the index that it's in.
      Returns:
      A FS equal to the template argument, or null if no such FS exists.
      See Also:

    • size

      public int size()
      Description copied from interface: FSIndex
      Return the number of feature structures in this index.
      Specified by:
      size in interface Collection<T extends FeatureStructure>
      Specified by:
      size in interface FSIndex<T extends FeatureStructure>
      Specified by:
      size in class AbstractCollection<T extends FeatureStructure>
      Returns:
      The number of FSs in this index.
      See Also:

    • deleteFS

      public boolean deleteFS(T fs)
      See Also:
      • FsIndex_singletype.deleteFS(FeatureStructure)

    • bulkAddTo

      protected void bulkAddTo(List<T> v)
      Description copied from class: FsIndex_singletype
      For serialization: get all the items in this index and bulk add to an List<T>
      Specified by:
      bulkAddTo in class FsIndex_singletype<T extends FeatureStructure>
      Parameters:
      v - the set of items to add

    • bulkAddTo

      protected void bulkAddTo(org.apache.uima.internal.util.IntVector v)

    • compare

      public int compare(FeatureStructure fs1, FeatureStructure fs2)
      Description copied from class: FsIndex_singletype
      This is required to avoid compilation error (but not in Eclipse) due to ambiguous interface inheritance from both FeatureStructure and Comparator
      Specified by:
      compare in interface Comparator<T extends FeatureStructure>
      Specified by:
      compare in interface FSIndex<T extends FeatureStructure>
      Specified by:
      compare in class FsIndex_singletype<T extends FeatureStructure>
      Parameters:
      fs1 - the first Feature Structure to compare
      fs2 - the second Feature Structure to compare
      Returns:
      -1 if fs1 < fs2; 0 if fs1 = fs2; 1 else.
      See Also:

    • createCopyOnWriteIndexPart

      protected CopyOnWriteIndexPart createCopyOnWriteIndexPart()
      Specified by:
      createCopyOnWriteIndexPart in class FsIndex_singletype<T extends FeatureStructure>

    • ll_maxAnnotSpan

      public int ll_maxAnnotSpan()
      Returns:
      for annotation indexes, an conservative estimate the maximum span between begin and end The value may be larger than actual.