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

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

public static final class DirectPostingsFormat.HighFreqDocsAndPositionsEnum
extends DocsAndPositionsEnum


Field Summary
 
Fields inherited from class org.apache.lucene.index.DocsAndPositionsEnum
FLAG_OFFSETS, FLAG_PAYLOADS
 
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.HighFreqDocsAndPositionsEnum(Bits liveDocs, boolean hasOffsets)
           
 
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.
 int docID()
          Returns the following: -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
 int endOffset()
          Returns end offset for the current position, or -1 if offsets were not indexed.
 int freq()
          Returns term frequency in the current document.
 int[] getDocIDs()
           
 Bits getLiveDocs()
           
 BytesRef getPayload()
          Returns the payload at this position, or null if no payload was indexed.
 int[][] getPositions()
           
 int getPosJump()
           
 boolean hasPayload()
           
 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.
 int nextPosition()
          Returns the next position.
 DocsAndPositionsEnum reset(int[] docIDs, int[] freqs, int[][] positions, byte[][][] payloads)
           
 int startOffset()
          Returns start offset for the current position, or -1 if offsets were not indexed.
 
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.HighFreqDocsAndPositionsEnum

public DirectPostingsFormat.HighFreqDocsAndPositionsEnum(Bits liveDocs,
                                                         boolean hasOffsets)
Method Detail

getDocIDs

public int[] getDocIDs()

getPositions

public int[][] getPositions()

getPosJump

public int getPosJump()

getLiveDocs

public Bits getLiveDocs()

reset

public DocsAndPositionsEnum reset(int[] docIDs,
                                  int[] freqs,
                                  int[][] positions,
                                  byte[][][] payloads)

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

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

docID

public int docID()
Description copied from class: DocIdSetIterator
Returns the following:

Specified by:
docID in class DocIdSetIterator

nextPosition

public int nextPosition()
Description copied from class: DocsAndPositionsEnum
Returns the next position. You should only call this up to DocsEnum.freq() times else the behavior is not defined. If positions were not indexed this will return -1; this only happens if offsets were indexed and you passed needsOffset=true when pulling the enum.

Specified by:
nextPosition in class DocsAndPositionsEnum

startOffset

public int startOffset()
Description copied from class: DocsAndPositionsEnum
Returns start offset for the current position, or -1 if offsets were not indexed.

Specified by:
startOffset in class DocsAndPositionsEnum

endOffset

public int endOffset()
Description copied from class: DocsAndPositionsEnum
Returns end offset for the current position, or -1 if offsets were not indexed.

Specified by:
endOffset in class DocsAndPositionsEnum

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

hasPayload

public boolean hasPayload()
Specified by:
hasPayload in class DocsAndPositionsEnum

getPayload

public BytesRef getPayload()
Description copied from class: DocsAndPositionsEnum
Returns the payload at this position, or null if no payload was indexed. Only call this once per position. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).

Specified by:
getPayload in class DocsAndPositionsEnum


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