public static class FilterLeafReader.FilterDocsEnum extends DocsEnum
DocsEnum
implementations.Modifier and Type | Field and Description |
---|---|
protected DocsEnum |
in
The underlying DocsEnum instance.
|
FLAG_FREQS, FLAG_NONE
NO_MORE_DOCS
Constructor and Description |
---|
FilterLeafReader.FilterDocsEnum(DocsEnum in)
Create a new FilterDocsEnum
|
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.
|
AttributeSource |
attributes()
Returns the related attributes.
|
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 |
freq()
Returns term frequency in the current document, or 1 if the field was
indexed with
IndexOptions.DOCS . |
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. |
empty, slowAdvance
protected final DocsEnum in
public FilterLeafReader.FilterDocsEnum(DocsEnum in)
in
- the underlying DocsEnum instance.public AttributeSource attributes()
DocsEnum
attributes
in class DocsEnum
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 freq() throws IOException
DocsEnum
IndexOptions.DOCS
. 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 DocsEnum
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 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 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-2015 Apache Software Foundation. All Rights Reserved.