public abstract class FilterScorer extends Scorer
FilterScorer
contains another Scorer
, which it
uses as its basic source of data, possibly transforming the data along the
way or providing additional functionality. The class
FilterScorer
itself simply implements all abstract methods
of Scorer
with versions that pass all requests to the
contained scorer. Subclasses of FilterScorer
may
further override some of these methods and may also provide additional
methods and fields.Scorer.ChildScorer
Modifier and Type | Field and Description |
---|---|
protected Scorer |
in |
NO_MORE_DOCS
Constructor and Description |
---|
FilterScorer(Scorer in)
Create a new FilterScorer
|
FilterScorer(Scorer in,
Weight weight)
Create a new FilterScorer with a specific weight
|
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.
|
TwoPhaseIterator |
asTwoPhaseIterator()
Optional method: Return a
TwoPhaseIterator view of this
Scorer . |
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 the freq of this Scorer on the current document
|
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. |
float |
score()
Returns the score of the current document matching the query.
|
getChildren, getWeight
all, empty, slowAdvance
protected final Scorer in
public FilterScorer(Scorer in)
in
- the Scorer
to wrappublic float score() throws IOException
Scorer
DocIdSetIterator.nextDoc()
or DocIdSetIterator.advance(int)
is called the first time, or when called from within
LeafCollector.collect(int)
.score
in class Scorer
IOException
public int freq() throws IOException
Scorer
freq
in class Scorer
IOException
public final 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 final int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.nextDoc
in class DocIdSetIterator
IOException
public final 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
public final TwoPhaseIterator asTwoPhaseIterator()
Scorer
TwoPhaseIterator
view of this
Scorer
. A return value of null
indicates that
two-phase iteration is not supported.
Note that the returned TwoPhaseIterator
's
approximation
must
advance synchronously with this iterator: advancing the approximation must
advance this iterator and vice-versa.
Implementing this method is typically useful on Scorer
s
that have a high per-document overhead in order to confirm matches.
The default implementation returns null
.asTwoPhaseIterator
in class Scorer
Copyright © 2000-2015 Apache Software Foundation. All Rights Reserved.