public static final class DirectPostingsFormat.HighFreqDocsAndPositionsEnum extends DocsAndPositionsEnum
FLAG_OFFSETS, FLAG_PAYLOADSFLAG_FREQSNO_MORE_DOCS| Constructor and Description |
|---|
DirectPostingsFormat.HighFreqDocsAndPositionsEnum(Bits liveDocs,
boolean hasOffsets) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
attributespublic DirectPostingsFormat.HighFreqDocsAndPositionsEnum(Bits liveDocs, boolean hasOffsets)
public int[] getDocIDs()
public int[][] getPositions()
public int getPosJump()
public Bits getLiveDocs()
public DocsAndPositionsEnum reset(int[] docIDs, int[] freqs, int[][] positions, byte[][][] payloads)
public int nextDoc()
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.nextDoc in class DocIdSetIteratorpublic int freq()
DocsEnumDocIdSetIterator.nextDoc() is first called,
nor after DocIdSetIterator.nextDoc() returns NO_MORE_DOCS.public int docID()
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) were not called yet.
DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
docID in class DocIdSetIteratorpublic int nextPosition()
DocsAndPositionsEnumDocsEnum.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.nextPosition in class DocsAndPositionsEnumpublic int startOffset()
DocsAndPositionsEnumstartOffset in class DocsAndPositionsEnumpublic int endOffset()
DocsAndPositionsEnumendOffset in class DocsAndPositionsEnumpublic int advance(int target)
DocIdSetIteratorDocIdSetIterator.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.
advance in class DocIdSetIteratorpublic boolean hasPayload()
hasPayload in class DocsAndPositionsEnumpublic BytesRef getPayload()
DocsAndPositionsEnumgetPayload in class DocsAndPositionsEnumCopyright © 2000-2012 Apache Software Foundation. All Rights Reserved.