org.apache.lucene.codecs.memory
Class DirectPostingsFormat.HighFreqDocsEnum

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

public static final class DirectPostingsFormat.HighFreqDocsEnum
extends DocsEnum


Field Summary
 
Fields inherited from class org.apache.lucene.index.DocsEnum
FLAG_FREQS
 
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
 
Constructor Summary
DirectPostingsFormat.HighFreqDocsEnum(Bits liveDocs)
           
 
Method Summary
 int advance(int target)
          Advances to the first beyond (see NOTE below) the current whose document number is greater than or equal to target.
 boolean canReuse(Bits liveDocs)
           
 int docID()
          Returns the following: -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
 int freq()
          Returns term frequency in the current document.
 int[] getDocIDs()
           
 int[] getFreqs()
           
 int nextDoc()
          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.
 DocsEnum reset(int[] docIDs, int[] freqs)
           
 
Methods inherited from class org.apache.lucene.index.DocsEnum
attributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirectPostingsFormat.HighFreqDocsEnum

public DirectPostingsFormat.HighFreqDocsEnum(Bits liveDocs)
Method Detail

canReuse

public boolean canReuse(Bits liveDocs)

getDocIDs

public int[] getDocIDs()

getFreqs

public int[] getFreqs()

reset

public DocsEnum 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: DocsEnum
Returns term frequency in the current document. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns NO_MORE_DOCS.

Specified by:
freq in class DocsEnum

advance

public int advance(int target)
Description copied from class: DocIdSetIterator
Advances to the first beyond (see NOTE below) the current whose document number is greater than or equal to target. Returns the current document number or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.

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: when target ≤ current implementations may opt not to advance beyond their current DocIdSetIterator.docID().

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.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Specified by:
advance in class DocIdSetIterator


Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.