Class TermMatchesIterator

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int endOffset()
      The ending offset of the current match, or -1 if offsets are not available
      int endPosition()
      The end position of the current match, or -1 if positions are not available
      Query getQuery()
      Returns the Query causing the current match
      MatchesIterator getSubMatches()
      Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match
      boolean next()
      Advance the iterator to the next match position
      int startOffset()
      The starting offset of the current match, or -1 if offsets are not available
      int startPosition()
      The start position of the current match, or -1 if positions are not available
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • upto

        private int upto
      • pos

        private int pos
      • query

        private final Query query
    • Constructor Detail

      • TermMatchesIterator

        TermMatchesIterator​(Query query,
                            PostingsEnum pe)
                     throws java.io.IOException
        Create a new TermMatchesIterator for the given term and postings list
        Throws:
        java.io.IOException
    • Method Detail

      • next

        public boolean next()
                     throws java.io.IOException
        Description copied from interface: MatchesIterator
        Advance the iterator to the next match position
        Specified by:
        next in interface MatchesIterator
        Returns:
        true if matches have not been exhausted
        Throws:
        java.io.IOException
      • startOffset

        public int startOffset()
                        throws java.io.IOException
        Description copied from interface: MatchesIterator
        The starting offset of the current match, or -1 if offsets are not available

        Should only be called after MatchesIterator.next() has returned true

        Specified by:
        startOffset in interface MatchesIterator
        Throws:
        java.io.IOException
      • endOffset

        public int endOffset()
                      throws java.io.IOException
        Description copied from interface: MatchesIterator
        The ending offset of the current match, or -1 if offsets are not available

        Should only be called after MatchesIterator.next() has returned true

        Specified by:
        endOffset in interface MatchesIterator
        Throws:
        java.io.IOException
      • getSubMatches

        public MatchesIterator getSubMatches()
                                      throws java.io.IOException
        Description copied from interface: MatchesIterator
        Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match

        Returns null if there are no submatches (ie the current iterator is at the leaf level)

        Should only be called after MatchesIterator.next() has returned true

        Specified by:
        getSubMatches in interface MatchesIterator
        Throws:
        java.io.IOException