Class DirectPostingsFormat.HighFreqDocsEnum

java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.PostingsEnum
org.apache.lucene.codecs.memory.DirectPostingsFormat.HighFreqDocsEnum
Enclosing class:
DirectPostingsFormat

private static final class DirectPostingsFormat.HighFreqDocsEnum extends PostingsEnum
  • Field Details

    • docIDs

      private int[] docIDs
    • freqs

      private int[] freqs
    • upto

      private int upto
    • docID

      private int docID
  • Constructor Details

    • HighFreqDocsEnum

      public HighFreqDocsEnum()
  • Method Details

    • reset

      public PostingsEnum reset(int[] docIDs, int[] freqs)
    • nextDoc

      public int nextDoc()
      Description copied from class: DocIdSetIterator
      Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
      NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
      Specified by:
      nextDoc in class DocIdSetIterator
    • docID

      public int docID()
      Description copied from class: DocIdSetIterator
      Returns the following:
      Specified by:
      docID in class DocIdSetIterator
    • freq

      public int freq()
      Description copied from class: PostingsEnum
      Returns term frequency in the current document, or 1 if the field was indexed with IndexOptions.DOCS. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns DocIdSetIterator.NO_MORE_DOCS.

      NOTE: if the PostingsEnum was obtain with PostingsEnum.NONE, the result of this method is undefined.

      Specified by:
      freq in class PostingsEnum
    • advance

      public int advance(int target)
      Description copied from class: DocIdSetIterator
      Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

      The behavior of this method is undefined when called with target ≤ current , or after the iterator has exhausted. Both cases may result in unpredicted behavior.

      When target > current it behaves as if written:

       int advance(int target) {
         int doc;
         while ((doc = nextDoc()) < target) {
         }
         return doc;
       }
       
      Some implementations are considerably more efficient than that.

      NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

      Specified by:
      advance in class DocIdSetIterator
    • cost

      public long cost()
      Description copied from class: DocIdSetIterator
      Returns the estimated cost of this DocIdSetIterator.

      This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

      Specified by:
      cost in class DocIdSetIterator
    • nextPosition

      public int nextPosition() throws IOException
      Description copied from class: PostingsEnum
      Returns the next position, or -1 if positions were not indexed. Calling this more than PostingsEnum.freq() times is undefined.
      Specified by:
      nextPosition in class PostingsEnum
      Throws:
      IOException
    • startOffset

      public int startOffset() throws IOException
      Description copied from class: PostingsEnum
      Returns start offset for the current position, or -1 if offsets were not indexed.
      Specified by:
      startOffset in class PostingsEnum
      Throws:
      IOException
    • endOffset

      public int endOffset() throws IOException
      Description copied from class: PostingsEnum
      Returns end offset for the current position, or -1 if offsets were not indexed.
      Specified by:
      endOffset in class PostingsEnum
      Throws:
      IOException
    • getPayload

      public BytesRef getPayload() throws IOException
      Description copied from class: PostingsEnum
      Returns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).
      Specified by:
      getPayload in class PostingsEnum
      Throws:
      IOException