Package org.apache.lucene.search
Class Scorable
java.lang.Object
org.apache.lucene.search.Scorable
- Direct Known Subclasses:
FilterScorable,ScoreCachingWrappingScorer,Scorer
Allows access to the score of a Query
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordA child Scorer and its relationship to its parent. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns child sub-scorers positioned on the current documentabstract 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.
-
Constructor Details
-
Scorable
public Scorable()
-
-
Method Details
-
score
Returns the score of the current document matching the query.- Throws:
IOException
-
smoothingScore
Returns 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.
- Throws:
IOException
-
setMinCompetitiveScore
Optional 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.- Throws:
IOException
-
getChildren
Returns child sub-scorers positioned on the current document- Throws:
IOException- WARNING: This API is experimental and might change in incompatible ways in the next release.
-