Class FsIndex_set_sorted<T extends FeatureStructure>

  • Type Parameters:
    T - the Java class type for this index
    All Implemented Interfaces:
    java.lang.Iterable<T>, java.util.Collection<T>, java.util.Comparator<FeatureStructure>, FSIndex<T>, LowLevelIndex<T>

    public final class FsIndex_set_sorted<T extends FeatureStructure>
    extends FsIndex_singletype<T>
    Common index impl for set and sorted indexes. Differences: - Number of "equal" (but not identical) FSs: Set: 1, Sorted, N - Iterators: Set: unordered, Sorted: ordered This is an index over just one type (excluding subtypes) Uses key augmented by a least-significant additional key: the _id field of the FS itself, to allow multiple otherwise equal (but not ==) FSs to be in the index.
    • Method Detail

      • contains

        public boolean contains​(FeatureStructure templateKey)
        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:
        templateKey - the feature structure
        Returns:
        true if the fs is contained
        See Also:
        FSIndex.contains(FeatureStructure)
      • insert

        void insert​(T fs)
        Description copied from class: FsIndex_singletype
        Adding FS to an index. not in upper interfaces because it's internal use only - called via addToIndexes etc.
        Specified by:
        insert in class FsIndex_singletype<T extends FeatureStructure>
        Parameters:
        fs - the fs to be added
      • find

        public T find​(FeatureStructure templateKey)
        find any arbitrary matching FS two comparators: cp, and cpx (has extra id comparing) First find an FS in the index that's the smallest that's GE to key using cpx - if none found, then all of the entries in the index are LessThan the key (using cpx); but one might be equal using cp -- if one or more would be equal using cp, it would be because the only reason for the inequality using cpx was due to the _id miscompare. Therefore we only need to check the last of the previous ones to see if it is cp equal - if we find one that is GE using cpx, -- if it is equal then return it (any equal one is ok) -- if it is GT, then the ones preceding it are LessThan (using cpx) the key. Do the same check as above to see if the last of the preceding ones is equal using cp.
        Parameters:
        templateKey - the matching fs template
        Returns:
        an arbitrary fs that matches
        See Also:
        FSIterator.moveTo(FeatureStructure)
      • size

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

        public boolean deleteFS​(T fs)
        Specified by:
        deleteFS in class FsIndex_singletype<T extends FeatureStructure>
        Parameters:
        fs - - the Feature Structure to be removed. Only this exact Feature Structure is removed (this is a stronger test than, for example, what moveTo(fs) does, where the fs in that case is used as a template). It is not an error if this exact Feature Structure is not in an index.
        Returns:
        true if something was removed, false if not found
      • 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 java.util.Collection<T extends FeatureStructure>
        Specified by:
        iterator in interface FSIndex<T extends FeatureStructure>
        Specified by:
        iterator in interface java.lang.Iterable<T extends FeatureStructure>
        Specified by:
        iterator in interface LowLevelIndex<T extends FeatureStructure>
        Specified by:
        iterator in class java.util.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.
      • 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.