public static class AssertingLeafReader.AssertingPostingsEnum extends FilterLeafReader.FilterPostingsEnum
in
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS
NO_MORE_DOCS
Constructor and Description |
---|
AssertingPostingsEnum(PostingsEnum in) |
Modifier and Type | Method and Description |
---|---|
int |
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.
|
int |
docID()
Returns the following:
-1 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, or 1 if the field was
indexed with
IndexOptions.DOCS . |
BytesRef |
getPayload()
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, 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, or -1 if positions were not indexed.
|
int |
startOffset()
Returns start offset for the current position, or -1
if offsets were not indexed.
|
attributes, cost
featureRequested
all, empty, range, slowAdvance
public AssertingPostingsEnum(PostingsEnum in)
public int nextDoc() throws java.io.IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
public int advance(int target) throws java.io.IOException
DocIdSetIterator
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.
advance
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
public int docID()
DocIdSetIterator
-1
if DocIdSetIterator.nextDoc()
or
DocIdSetIterator.advance(int)
were not called yet.
DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.
docID
in class FilterLeafReader.FilterPostingsEnum
public int freq() throws java.io.IOException
PostingsEnum
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.
freq
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
public int nextPosition() throws java.io.IOException
PostingsEnum
PostingsEnum.freq()
times is undefined.nextPosition
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
public int startOffset() throws java.io.IOException
PostingsEnum
startOffset
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
public int endOffset() throws java.io.IOException
PostingsEnum
endOffset
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
public BytesRef getPayload() throws java.io.IOException
PostingsEnum
getPayload
in class FilterLeafReader.FilterPostingsEnum
java.io.IOException
Copyright © 2000–2019 The Apache Software Foundation. All rights reserved.