Class FsIterator_bag<T extends FeatureStructure>

    • Method Detail

      • maybeReinitIterator

        public boolean maybeReinitIterator()
        Description copied from interface: LowLevelIterator
        Internal use
        Returns:
        true if the iterator was refreshed to match the current index
      • isValid

        public boolean isValid()
        Description copied from interface: FSIterator
        Check if this iterator is valid.
        Returns:
        true if the iterator is valid.
      • getNvc

        public T getNvc()
        Description copied from interface: FSIterator
        Get the structure the iterator is pointing at. Throws various unchecked exceptions, if the iterator is not valid
        Returns:
        The structure the iterator is pointing at.
      • moveToFirstNoReinit

        public void moveToFirstNoReinit()
        Description copied from interface: LowLevelIterator
        Internal use same as moveToFirst, but won't reset to use current contents of index if index has changed
      • moveToLastNoReinit

        public void moveToLastNoReinit()
        Description copied from interface: LowLevelIterator
        Internal use same as moveToLast, but won't reset to use current contents of index if index has changed
      • moveToNextNvc

        public void moveToNextNvc()
        Description copied from interface: FSIterator
        version of moveToNext which bypasses the isValid check - call only if you've just done this check yourself
      • moveToPreviousNvc

        public void moveToPreviousNvc()
        Description copied from interface: FSIterator
        version of moveToPrevious which bypasses the isValid check - call only if you've just done this check yourself
      • moveToNoReinit

        public void moveToNoReinit​(FeatureStructure fs)
        Description copied from interface: LowLevelIterator
        Internal use same as moveTo(fs), but won't reset to use current contents of index if index has changed
        Parameters:
        fs - the fs to use as the template identifying the place to move to
      • copyCommonSetup

        protected void copyCommonSetup​(FsIterator_bag<T> copy)
      • ll_indexSizeMaybeNotCurrent

        public int ll_indexSizeMaybeNotCurrent()
        Returns:
        The size of the index. In case of copy-on-write, this returns the size of the index at the time the iterator was created, or at the last moveTo, moveToFirst, or moveToLast. To get the current index size, use ll_getIndex().getSize()
      • ll_maxAnnotSpan

        public int ll_maxAnnotSpan()
        Returns:
        an estimate of the maximum span over all annotations (end - begin)
      • ll_getIndex

        public LowLevelIndex<T> ll_getIndex()
        Description copied from interface: LowLevelIterator
        Get the index for just the top most type of this iterator (excludes subtypes).
        Returns:
        The index.
      • isIndexesHaveBeenUpdated

        public boolean isIndexesHaveBeenUpdated()
        Returns:
        true if one or more of the underlying indexes this iterator goes over, has been updated since initialization or resetting operation (moveToFirst/Last/feature_structure). This includes empty iterators becoming non-empty.
      • getComparator

        public java.util.Comparator<TOP> getComparator()
        Returns:
        the comparator used by this iterator. It is always a withoutID style, and may be either a withType or NoType style.
      • size

        public int size()
        Description copied from interface: FSIterator
        return the size of the collection being iterated over, if available. Because the iterator can move forwards and backwards, the size is the total size that the iterator would iterate over, starting at the first element thru the last element. This may be inefficient to compute.
        Returns:
        the size of the collection being iterated over.