Module org.apache.lucene.core

Package org.apache.lucene.search

Class SimpleScorable

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.SimpleScorable

final class SimpleScorable
extends Scorable

Simplest implementation of Scorable, implemented via simple getters and setters.

Nested Class Summary

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

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
(package private) float	minCompetitiveScore
(package private) float	score

Constructor Summary

Constructors

Constructor	Description
SimpleScorable()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
float	minCompetitiveScore()	Get the min competitive score.
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.
void	setScore(float score)	Set the score.

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

getChildren, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

score

float score

minCompetitiveScore

float minCompetitiveScore

Constructor Details

SimpleScorable

public SimpleScorable()

Sole constructor.

Method Details

score

public float score()

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable

setScore

public void setScore(float score)

Set the score.

minCompetitiveScore

public float minCompetitiveScore()

Get the min competitive score.

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