Class InstantiatedTermPositions

    • Method Detail

      • getPayloadLength

        public int getPayloadLength()
        Specified by:
        getPayloadLength in interface org.apache.lucene.index.TermPositions
      • getPayload

        public byte[] getPayload​(byte[] data,
                                 int offset)
                          throws IOException
        Specified by:
        getPayload in interface org.apache.lucene.index.TermPositions
        Throws:
        IOException
      • isPayloadAvailable

        public boolean isPayloadAvailable()
        Specified by:
        isPayloadAvailable in interface org.apache.lucene.index.TermPositions
      • nextPosition

        public int nextPosition()
        Returns next position in the current document. It is an error to call this more than InstantiatedTermDocs.freq() times without calling next()

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

        Specified by:
        nextPosition in interface org.apache.lucene.index.TermPositions
      • next

        public boolean next()
        Moves to the next pair in the enumeration.

        Returns true if there is such a next pair in the enumeration.

        Specified by:
        next in interface org.apache.lucene.index.TermDocs
        Overrides:
        next in class InstantiatedTermDocs
      • 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 iff there is such an entry.

        Behaves as if written:

           boolean skipTo(int target) {
             do {
               if (!next())
                     return false;
             } while (target > doc());
             return true;
           }
         
        Some implementations are considerably more efficient than that.
        Specified by:
        skipTo in interface org.apache.lucene.index.TermDocs
        Overrides:
        skipTo in class InstantiatedTermDocs