Class TermScorer
Scorer for documents matching a Term.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable -
Constructor Summary
ConstructorsConstructorDescriptionTermScorer(ImpactsEnum impactsEnum, Similarity.SimScorer scorer, NumericDocValues norms, boolean topLevelScoringClause) Construct aTermScorerthat will use impacts to skip blocks of non-competitive documents.TermScorer(PostingsEnum postingsEnum, Similarity.SimScorer scorer, NumericDocValues norms) Construct aTermScorerthat will iterate all documents. -
Method Summary
Modifier and TypeMethodDescriptionintadvanceShallow(int target) Advance to the block of documents that containstargetin order to get scoring information about this block.intdocID()Returns the doc ID that is currently being scored.final intfreq()Returns term frequency in the current document.floatgetMaxScore(int upTo) Return the maximum score that documents between the lasttargetthat this iterator wasshallow-advancedto included andupToincluded.iterator()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.floatsmoothingScore(int docId) Returns the smoothing score of the current document matching the query.Methods inherited from class org.apache.lucene.search.Scorer
twoPhaseIteratorMethods inherited from class org.apache.lucene.search.Scorable
getChildren
-
Constructor Details
-
TermScorer
Construct aTermScorerthat will iterate all documents. -
TermScorer
public TermScorer(ImpactsEnum impactsEnum, Similarity.SimScorer scorer, NumericDocValues norms, boolean topLevelScoringClause) Construct aTermScorerthat will use impacts to skip blocks of non-competitive documents.
-
-
Method Details
-
docID
public int docID()Description copied from class:ScorerReturns the doc ID that is currently being scored. -
freq
Returns term frequency in the current document.- Throws:
IOException
-
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.
-
score
Description copied from class:ScorableReturns the score of the current document matching the query.- Specified by:
scorein classScorable- Throws:
IOException
-
smoothingScore
Description copied from class:ScorableReturns the smoothing score of the current document matching the query. This score is used when the query/term does not appear in the document, and behaves like an idf. The smoothing score is particularly important when the Scorer returns a product of probabilities so that the document score does not go to zero when one probability is zero. This can return 0 or a smoothing score.Smoothing scores are described in many papers, including: Metzler, D. and Croft, W. B. , "Combining the Language Model and Inference Network Approaches to Retrieval," Information Processing and Management Special Issue on Bayesian Networks and Information Retrieval, 40(5), pp.735-750.
- Overrides:
smoothingScorein classScorable- Throws:
IOException
-
advanceShallow
Description copied from class:ScorerAdvance to the block of documents that containstargetin order to get scoring information about this block. This method is implicitly called byDocIdSetIterator.advance(int)andDocIdSetIterator.nextDoc()on the returned doc ID. Calling this method doesn't modify the currentDocIdSetIterator.docID(). It returns a number that is greater than or equal to all documents contained in the current block, but less than any doc IDS of the next block.targetmust be >=Scorer.docID()as well as all targets that have been passed toScorer.advanceShallow(int)so far.- Overrides:
advanceShallowin classScorer- Throws:
IOException
-
getMaxScore
Description 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) Description 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
-