Package org.apache.lucene.search
Class IndriScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.IndriScorer
-
- Direct Known Subclasses:
IndriDisjunctionScorer
public abstract class IndriScorer extends Scorer
The Indri parent scorer that stores the boost so that IndriScorers can use the boost outside of the term.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedIndriScorer(Weight weight, float boost)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract intdocID()Returns the doc ID that is currently being scored.floatgetBoost()abstract floatgetMaxScore(int upTo)Return the maximum score that documents between the lasttargetthat this iterator wasshallow-advancedto included andupToincluded.abstract DocIdSetIteratoriterator()Return aDocIdSetIteratorover matching documents.abstract floatscore()Returns the score of the current document matching the query.abstract floatsmoothingScore(int docId)Returns the smoothing score of the current document matching the query.-
Methods inherited from class org.apache.lucene.search.Scorer
advanceShallow, getWeight, twoPhaseIterator
-
Methods inherited from class org.apache.lucene.search.Scorable
getChildren, setMinCompetitiveScore
-
-
-
-
Constructor Detail
-
IndriScorer
protected IndriScorer(Weight weight, float boost)
-
-
Method Detail
-
iterator
public abstract 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.
-
getMaxScore
public abstract 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
-
score
public abstract float score() throws IOExceptionDescription copied from class:ScorableReturns the score of the current document matching the query.- Specified by:
scorein classScorable- Throws:
IOException
-
smoothingScore
public abstract float smoothingScore(int docId) throws IOExceptionDescription 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
-
docID
public abstract int docID()
Description copied from class:ScorableReturns the doc ID that is currently being scored.
-
getBoost
public float getBoost()
-
-