Module org.apache.lucene.codecs
Package org.apache.lucene.codecs.memory
Class DirectPostingsFormat.LowFreqPostingsEnum
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.PostingsEnum
org.apache.lucene.codecs.memory.DirectPostingsFormat.LowFreqPostingsEnum
- Enclosing class:
DirectPostingsFormat
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private int
private int
private final boolean
private final boolean
private int
private final BytesRef
private byte[]
private int
private int
private int
private final int
private int[]
private int
private int
private int
Fields inherited from class org.apache.lucene.index.PostingsEnum
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
advance
(int target) Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
Returns end offset for the current position, or -1 if offsets were not indexed.int
freq()
Returns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS
.Returns the payload at this position, or null if no payload was indexed.int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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
Returns the next position, or -1 if positions were not indexed.reset
(int[] postings, byte[] payloadBytes) int
Returns start offset for the current position, or -1 if offsets were not indexed.Methods inherited from class org.apache.lucene.index.PostingsEnum
featureRequested
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
Field Details
-
postings
private int[] postings -
posMult
private final int posMult -
hasOffsets
private final boolean hasOffsets -
hasPayloads
private final boolean hasPayloads -
payload
-
upto
private int upto -
docID
private int docID -
freq
private int freq -
skipPositions
private int skipPositions -
pos
private int pos -
startOffset
private int startOffset -
endOffset
private int endOffset -
lastPayloadOffset
private int lastPayloadOffset -
payloadOffset
private int payloadOffset -
payloadLength
private int payloadLength -
payloadBytes
private byte[] payloadBytes
-
-
Constructor Details
-
LowFreqPostingsEnum
public LowFreqPostingsEnum(boolean hasOffsets, boolean hasPayloads)
-
-
Method Details
-
reset
-
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, orDocIdSetIterator.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 classDocIdSetIterator
-
docID
public int docID()Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
-
freq
public int freq()Description copied from class:PostingsEnum
Returns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS
. Do not call this beforeDocIdSetIterator.nextDoc()
is first called, nor afterDocIdSetIterator.nextDoc()
returnsDocIdSetIterator.NO_MORE_DOCS
.NOTE: if the
PostingsEnum
was obtain withPostingsEnum.NONE
, the result of this method is undefined.- Specified by:
freq
in classPostingsEnum
-
nextPosition
public int nextPosition()Description copied from class:PostingsEnum
Returns the next position, or -1 if positions were not indexed. Calling this more thanPostingsEnum.freq()
times is undefined.- Specified by:
nextPosition
in classPostingsEnum
-
startOffset
public int startOffset()Description copied from class:PostingsEnum
Returns start offset for the current position, or -1 if offsets were not indexed.- Specified by:
startOffset
in classPostingsEnum
-
endOffset
public int endOffset()Description copied from class:PostingsEnum
Returns end offset for the current position, or -1 if offsets were not indexed.- Specified by:
endOffset
in classPostingsEnum
-
advance
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 returnsDocIdSetIterator.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 classDocIdSetIterator
- Throws:
IOException
-
getPayload
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 classPostingsEnum
-
cost
public long cost()Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.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 classDocIdSetIterator
-