Class InstantiatedTermDocs

    • Method Detail

      • seek

        public void seek​(Term term)
        Description copied from interface: TermDocs
        Sets this to the data for a term. The enumeration is reset to the start of the data for this term.
        Specified by:
        seek in interface TermDocs
      • seek

        public void seek​(TermEnum termEnum)
        Description copied from interface: TermDocs
        Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations.
        Specified by:
        seek in interface TermDocs
      • doc

        public int doc()
        Description copied from interface: TermDocs
        Returns the current document number.

        This is invalid until TermDocs.next() is called for the first time.

        Specified by:
        doc in interface TermDocs
      • freq

        public int freq()
        Description copied from interface: TermDocs
        Returns the frequency of the term within the current document.

        This is invalid until TermDocs.next() is called for the first time.

        Specified by:
        freq in interface TermDocs
      • next

        public boolean next()
        Description copied from interface: TermDocs
        Moves to the next pair in the enumeration.

        Returns true iff there is such a next pair in the enumeration. Once this returns false you should not call any of the other methods.

        Specified by:
        next in interface TermDocs
      • read

        public int read​(int[] docs,
                        int[] freqs)
        Description copied from interface: TermDocs
        Attempts to read multiple entries from the enumeration, up to length of docs. Document numbers are stored in docs, and term frequencies are stored in freqs. The freqs array must be as long as the docs array.

        Returns the number of entries read. Zero is only returned when the stream has been exhausted.

        Specified by:
        read in interface TermDocs
      • skipTo

        public boolean skipTo​(int target)
        Skips entries to the first beyond the current whose document number is greater than or equal to target.

        Returns true if there is such an entry.

        Behaves as if written:

           boolean skipTo(int target) {
             do {
               if (!next())
                     return false;
             } while (target > doc());
             return true;
           }
         
        This implementation is considerably more efficient than that.
        Specified by:
        skipTo in interface TermDocs