Package org.apache.lucene.search
Class FilterScorable
- java.lang.Object
-
- org.apache.lucene.search.Scorable
-
- org.apache.lucene.search.FilterScorable
-
public class FilterScorable extends Scorable
Filter aScorable, intercepting methods and optionally changing their return valuesThe default implementation simply passes all calls to its delegate, with the exception of
Scorable.setMinCompetitiveScore(float)which defaults to a no-op.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable
Scorable.ChildScorable
-
-
Constructor Summary
Constructors Constructor Description FilterScorable(Scorable in)Filter a scorer
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intdocID()Returns the doc ID that is currently being scored.Collection<Scorable.ChildScorable>getChildren()Returns child sub-scorers positioned on the current documentfloatscore()Returns the score of the current document matching the query.-
Methods inherited from class org.apache.lucene.search.Scorable
setMinCompetitiveScore, smoothingScore
-
-
-
-
Field Detail
-
in
protected final Scorable in
-
-
Constructor Detail
-
FilterScorable
public FilterScorable(Scorable in)
Filter a scorer- Parameters:
in- the scorer to filter
-
-
Method Detail
-
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
-
docID
public int docID()
Description copied from class:ScorableReturns the doc ID that is currently being scored.
-
getChildren
public Collection<Scorable.ChildScorable> getChildren() throws IOException
Description copied from class:ScorableReturns child sub-scorers positioned on the current document- Overrides:
getChildrenin classScorable- Throws:
IOException
-
-