Class ConstantScoreScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.ConstantScoreScorer
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
-
Constructor Summary
Constructors Constructor Description ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, DocIdSetIterator disi)Constructor based on aDocIdSetIteratorwhich will be used to drive iteration.ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, TwoPhaseIterator twoPhaseIterator)Constructor based on aTwoPhaseIterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdocID()Returns the doc ID that is currently being scored.floatgetMaxScore(int upTo)Return the maximum score that documents between the lasttargetthat this iterator wasshallow-advancedto included andupToincluded.DocIdSetIteratoriterator()Return aDocIdSetIteratorover matching documents.floatscore()Returns the score of the current document matching the query.voidsetMinCompetitiveScore(float minScore)Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the givenminScore.TwoPhaseIteratortwoPhaseIterator()Optional method: Return aTwoPhaseIteratorview of thisScorer.-
Methods inherited from class org.apache.lucene.search.Scorer
advanceShallow, getWeight
-
Methods inherited from class org.apache.lucene.search.Scorable
getChildren, smoothingScore
-
-
-
-
Constructor Detail
-
ConstantScoreScorer
public ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, DocIdSetIterator disi)
Constructor based on aDocIdSetIteratorwhich will be used to drive iteration. Two phase iteration will not be supported.- Parameters:
weight- the parent weightscore- the score to return on each documentscoreMode- the score modedisi- the iterator that defines matching documents
-
ConstantScoreScorer
public ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, TwoPhaseIterator twoPhaseIterator)
Constructor based on aTwoPhaseIterator. In that case theScorerwill support two-phase iteration.- Parameters:
weight- the parent weightscore- the score to return on each documentscoreMode- the score modetwoPhaseIterator- the iterator that defines matching documents
-
-
Method Detail
-
getMaxScore
public float getMaxScore(int upTo) throws IOExceptionDescription copied from class:ScorerReturn the maximum score that documents between the lasttargetthat this iterator wasshallow-advancedto included andupToincluded.- Specified by:
getMaxScorein classScorer- Throws:
IOException
-
setMinCompetitiveScore
public void setMinCompetitiveScore(float minScore) throws IOExceptionDescription copied from class:ScorableOptional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the givenminScore. 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 ofminScore.- Overrides:
setMinCompetitiveScorein classScorable- Throws:
IOException
-
iterator
public DocIdSetIterator iterator()
Description copied from class:ScorerReturn aDocIdSetIteratorover matching documents.The returned iterator will either be positioned on
-1if no documents have been scored yet,DocIdSetIterator.NO_MORE_DOCSif 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.
-
twoPhaseIterator
public TwoPhaseIterator twoPhaseIterator()
Description copied from class:ScorerOptional method: Return aTwoPhaseIteratorview of thisScorer. A return value ofnullindicates that two-phase iteration is not supported.Note that the returned
TwoPhaseIterator'sapproximationmust advance synchronously with theScorer.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.- Overrides:
twoPhaseIteratorin classScorer
-
docID
public int docID()
Description copied from class:ScorableReturns the doc ID that is currently being scored.
-
score
public float score() throws IOExceptionDescription copied from class:ScorableReturns the score of the current document matching the query.- Specified by:
scorein classScorable- Throws:
IOException
-
-