Package org.apache.lucene.search
Class Scorable
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- Direct Known Subclasses:
BlockGroupingCollector.ScoreAndDoc
,CachingCollector.CachedScorable
,FilterScorable
,ScoreAndDoc
,ScoreCachingWrappingScorer
,Scorer
,ValueSource.ScoreAndDoc
public abstract class Scorable extends java.lang.Object
Allows access to the score of a Query
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Scorable.ChildScorable
A child Scorer and its relationship to its parent.
-
Constructor Summary
Constructors Constructor Description Scorable()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract int
docID()
Returns the doc ID that is currently being scored.java.util.Collection<Scorable.ChildScorable>
getChildren()
Returns child sub-scorers positioned on the current documentabstract 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 givenminScore
.
-
-
-
Method Detail
-
score
public abstract float score() throws java.io.IOException
Returns the score of the current document matching the query.- Throws:
java.io.IOException
-
docID
public abstract int docID()
Returns the doc ID that is currently being scored.
-
setMinCompetitiveScore
public void setMinCompetitiveScore(float minScore) throws java.io.IOException
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 useScoreMode.TOP_SCORES
, and successive calls may only set increasing values ofminScore
.- Throws:
java.io.IOException
-
getChildren
public java.util.Collection<Scorable.ChildScorable> getChildren() throws java.io.IOException
Returns child sub-scorers positioned on the current document- Throws:
java.io.IOException
-
-