public abstract class ValueSourceScorer extends Scorer
Scorer which returns the result of FunctionValues.floatVal(int) as
the score for a document, and which filters out documents that don't match matches(int).
This Scorer has a TwoPhaseIterator. This is similar to FunctionQuery,
but this one has no Weight normalization factors/multipliers
and that one doesn't filter either.
Note: If the scores are needed, then the underlying value will probably be fetched/computed twice -- once to filter and next to return the score. If that's non-trivial then consider wrapping it in an implementation that will cache the current value.
FunctionQueryScorer.ChildScorer| Modifier and Type | Field and Description |
|---|---|
protected FunctionValues |
values |
| Modifier | Constructor and Description |
|---|---|
protected |
ValueSourceScorer(LeafReaderContext readerContext,
FunctionValues values) |
| Modifier and Type | Method and Description |
|---|---|
int |
docID()
Returns the doc ID that is currently being scored.
|
int |
freq()
Returns the freq of this Scorer on the current document
|
DocIdSetIterator |
iterator()
Return a
DocIdSetIterator over matching documents. |
abstract boolean |
matches(int doc)
Override to decide if this document matches.
|
float |
score()
Returns the score of the current document matching the query.
|
TwoPhaseIterator |
twoPhaseIterator()
Optional method: Return a
TwoPhaseIterator view of this
Scorer. |
getChildren, getWeightprotected final FunctionValues values
protected ValueSourceScorer(LeafReaderContext readerContext, FunctionValues values)
public abstract boolean matches(int doc)
TwoPhaseIterator.matches().public DocIdSetIterator iterator()
ScorerDocIdSetIterator over matching documents.
The returned iterator will either be positioned on -1 if no
documents have been scored yet, DocIdSetIterator.NO_MORE_DOCS
if all documents have been scored already, or the last document id that
has been scored otherwise.
The returned iterator is a view: calling this method several times will
return iterators that have the same state.public TwoPhaseIterator twoPhaseIterator()
ScorerTwoPhaseIterator 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 the Scorer.iterator(): advancing the
approximation must advance the iterator and vice-versa.
Implementing this method is typically useful on Scorers
that have a high per-document overhead in order to confirm matches.
The default implementation returns null.twoPhaseIterator in class Scorerpublic int docID()
Scorer-1 if the Scorer.iterator() is not positioned
or DocIdSetIterator.NO_MORE_DOCS if it has been entirely consumed.docID in class ScorerDocIdSetIterator.docID()public float score() throws IOException
ScorerDocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) is called on the Scorer.iterator()
the first time, or when called from within LeafCollector.collect(int).score in class ScorerIOExceptionpublic int freq() throws IOException
Scorerfreq in class ScorerIOException