public static class AssertingAtomicReader.AssertingDocsEnum extends FilterAtomicReader.FilterDocsEnum
in
FLAG_FREQS, FLAG_NONE
NO_MORE_DOCS
Constructor and Description |
---|
AssertingDocsEnum(DocsEnum in) |
AssertingDocsEnum(DocsEnum in,
boolean failOnUnsupportedDocID) |
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 or
DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) were not called yet. |
int |
freq()
Returns term frequency in the current document, or 1 if the field was
indexed with
FieldInfo.IndexOptions.DOCS_ONLY . |
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. |
attributes, cost
empty, slowAdvance
public AssertingDocsEnum(DocsEnum in)
public AssertingDocsEnum(DocsEnum in, boolean failOnUnsupportedDocID)
public int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class FilterAtomicReader.FilterDocsEnum
IOException
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 FilterAtomicReader.FilterDocsEnum
IOException
public int docID()
DocIdSetIterator
DocIdSetIterator.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 FilterAtomicReader.FilterDocsEnum
public int freq() throws IOException
DocsEnum
FieldInfo.IndexOptions.DOCS_ONLY
. Do not call this before
DocIdSetIterator.nextDoc()
is first called, nor after DocIdSetIterator.nextDoc()
returns
DocIdSetIterator.NO_MORE_DOCS
.
NOTE: if the DocsEnum
was obtain with DocsEnum.FLAG_NONE
,
the result of this method is undefined.
freq
in class FilterAtomicReader.FilterDocsEnum
IOException
Copyright © 2000–2021 The Apache Software Foundation. All rights reserved.