Class FSIndexFlat.FSIteratorFlat<TI extends FeatureStructure>

    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • get

        public TI get()
               throws java.util.NoSuchElementException
        Description copied from interface: FSIterator
        Get the structure the iterator is pointing at.
        Specified by:
        get in interface FSIterator<TI extends FeatureStructure>
        Returns:
        The structure the iterator is pointing at.
        Throws:
        java.util.NoSuchElementException - If the iterator is not valid.
      • moveTo

        public void moveTo​(FeatureStructure fs)
        Description copied from interface: FSIterator
        Move the iterator to the first Feature Structure that is equal to fs. First means the earliest one occurring in the index, in case multiple FSs that are "equal" to fs are in the index. If no such feature structure exists in the underlying collection, set the iterator to the "insertion point" for fs, i.e., to a point where the current feature structure is greater than fs, and the previous one is less than fs.

        If the fs is greater than all of the entries in the index, the moveTo cannot set the iterator to an insertion point where the current feature structure is greater than fs, so it marks the iterator "invalid".

        If the underlying index is a bag index, no ordering is present, and the moveTo operation moves to the fs which is the same identical fs as the key. If no such fs is in the index, the iterator is marked invalid.

        Specified by:
        moveTo in interface FSIterator<TI extends FeatureStructure>
        Parameters:
        fs - The feature structure the iterator that supplies the comparison information. It must be of type T or a subtype of T.
      • isUpdateFreeSinceLastCounterReset

        public boolean isUpdateFreeSinceLastCounterReset()
      • ll_get

        public int ll_get()
                   throws java.util.NoSuchElementException
        Description copied from interface: LowLevelIterator
        Return the current FS reference.
        Specified by:
        ll_get in interface LowLevelIterator
        Returns:
        The current FS reference.
        Throws:
        java.util.NoSuchElementException - Iff the iterator is not valid.
      • moveTo

        public void moveTo​(int fsRef)
        Description copied from interface: LowLevelIterator
        Try to position the iterator so that the current element is greater than or equal to fsRef, and previous elements are less than fsRef. This may invalidate the iterator. If fsRef can not be compared to FSs in the index, the results are undefined.
        Specified by:
        moveTo in interface LowLevelIterator
        Parameters:
        fsRef - The FS reference the iterator should be set to.
      • ll_indexSize

        public int ll_indexSize()
        Description copied from interface: LowLevelIterator
        Return the size of the underlying index.
        Specified by:
        ll_indexSize in interface LowLevelIterator
        Returns:
        The size of the index.