public final class MultiPostingsEnum extends PostingsEnum
PostingsEnum
, merged from PostingsEnum
API of sub-segments.Modifier and Type | Class and Description |
---|---|
static class |
MultiPostingsEnum.EnumWithSlice
Holds a
PostingsEnum along with the
corresponding ReaderSlice . |
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS
NO_MORE_DOCS
Constructor and Description |
---|
MultiPostingsEnum(MultiTermsEnum parent,
int subReaderCount)
Sole constructor.
|
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.
|
boolean |
canReuse(MultiTermsEnum parent)
Returns
true if this instance can be reused by
the provided MultiTermsEnum . |
long |
cost()
Returns the estimated cost of this
DocIdSetIterator . |
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 . |
int |
getNumSubs()
How many sub-readers we are merging.
|
BytesRef |
getPayload()
Returns the payload at this position, or null if no
payload was indexed.
|
MultiPostingsEnum.EnumWithSlice[] |
getSubs()
Returns sub-readers we are merging.
|
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.
|
MultiPostingsEnum |
reset(MultiPostingsEnum.EnumWithSlice[] subs,
int numSubs)
Re-use and reset this instance on the provided slices.
|
int |
startOffset()
Returns start offset for the current position, or -1
if offsets were not indexed.
|
String |
toString() |
featureRequested
all, empty, range, slowAdvance
public MultiPostingsEnum(MultiTermsEnum parent, int subReaderCount)
parent
- The MultiTermsEnum
that created us.subReaderCount
- How many sub-readers are being merged.public boolean canReuse(MultiTermsEnum parent)
true
if this instance can be reused by
the provided MultiTermsEnum
.public MultiPostingsEnum reset(MultiPostingsEnum.EnumWithSlice[] subs, int numSubs)
public int getNumSubs()
getSubs()
public MultiPostingsEnum.EnumWithSlice[] getSubs()
public int freq() throws 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 PostingsEnum
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 DocIdSetIterator
public int advance(int target) throws 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 DocIdSetIterator
IOException
public int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class DocIdSetIterator
IOException
public int nextPosition() throws IOException
PostingsEnum
PostingsEnum.freq()
times is undefined.nextPosition
in class PostingsEnum
IOException
public int startOffset() throws IOException
PostingsEnum
startOffset
in class PostingsEnum
IOException
public int endOffset() throws IOException
PostingsEnum
endOffset
in class PostingsEnum
IOException
public BytesRef getPayload() throws IOException
PostingsEnum
getPayload
in class PostingsEnum
IOException
public long cost()
DocIdSetIterator
DocIdSetIterator
.
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.
cost
in class DocIdSetIterator
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.