org.apache.lucene.search

Class AssertingScorable

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.FilterScorable

org.apache.lucene.search.AssertingScorable

public class AssertingScorable
extends FilterScorable

Wraps another Scorable and asserts that scores are reasonable and only called when positioned

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable

Scorable.ChildScorable

Field Summary

Fields inherited from class org.apache.lucene.search.FilterScorable

in

Constructor Summary

Constructors

Constructor and Description
AssertingScorable(Scorable in)

Method Summary

Modifier and Type	Method and Description
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 given minScore.
static Scorable	unwrap(Scorable in)
static Scorable	wrap(Scorable in)

Methods inherited from class org.apache.lucene.search.FilterScorable

docID, getChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssertingScorable

public AssertingScorable(Scorable in)

Method Detail

score

public float score()
            throws IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Overrides:

score in class FilterScorable

Throws:

IOException

setMinCompetitiveScore

public void setMinCompetitiveScore(float minScore)
                            throws IOException

Description copied from class: Scorable

Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the given minScore. 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 of minScore.

Overrides:

setMinCompetitiveScore in class Scorable

Throws:

IOException

wrap

public static Scorable wrap(Scorable in)

unwrap

public static Scorable unwrap(Scorable in)