Scorable.ChildScorable
Constructor and Description |
---|
ConstantScoreScorer(Weight weight,
float score,
ScoreMode scoreMode,
DocIdSetIterator disi)
Constructor based on a
DocIdSetIterator which will be used to
drive iteration. |
ConstantScoreScorer(Weight weight,
float score,
ScoreMode scoreMode,
TwoPhaseIterator twoPhaseIterator)
Constructor based on a
TwoPhaseIterator . |
Modifier and Type | Method and Description |
---|---|
int |
docID()
Returns the doc ID that is currently being scored.
|
float |
getMaxScore(int upTo)
Return the maximum score that documents between the last
target
that this iterator was shallow-advanced to
included and upTo included. |
DocIdSetIterator |
iterator()
Return a
DocIdSetIterator over matching documents. |
float |
score()
Returns the score of the current document matching the query.
|
void |
setMinCompetitiveScore(float minScore)
Optional method: Tell the scorer that its iterator may safely ignore all
documents whose score is less than the given
minScore . |
TwoPhaseIterator |
twoPhaseIterator()
Optional method: Return a
TwoPhaseIterator view of this
Scorer . |
advanceShallow, getWeight
getChildren, smoothingScore
public ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, DocIdSetIterator disi)
DocIdSetIterator
which will be used to
drive iteration. Two phase iteration will not be supported.weight
- the parent weightscore
- the score to return on each documentscoreMode
- the score modedisi
- the iterator that defines matching documentspublic ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, TwoPhaseIterator twoPhaseIterator)
TwoPhaseIterator
. In that case the
Scorer
will support two-phase iteration.weight
- the parent weightscore
- the score to return on each documentscoreMode
- the score modetwoPhaseIterator
- the iterator that defines matching documentspublic float getMaxScore(int upTo) throws IOException
Scorer
target
that this iterator was shallow-advanced
to
included and upTo
included.getMaxScore
in class Scorer
IOException
public void setMinCompetitiveScore(float minScore) throws IOException
Scorable
minScore
. This is a
no-op by default.
This method may only be called from collectors that use
ScoreMode.TOP_SCORES
, and successive calls may only set increasing
values of minScore
.setMinCompetitiveScore
in class Scorable
IOException
public DocIdSetIterator iterator()
Scorer
DocIdSetIterator
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()
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 the Scorer.iterator()
: advancing the
approximation must advance the 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
.twoPhaseIterator
in class Scorer
public int docID()
Scorable
public float score() throws IOException
Scorable
score
in class Scorable
IOException
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.