org.elasticsearch.common.lucene.search.function

Class WeightFactorFunction

java.lang.Object

org.elasticsearch.common.lucene.search.function.ScoreFunction

org.elasticsearch.common.lucene.search.function.WeightFactorFunction

public class WeightFactorFunction
extends ScoreFunction

Constructor Summary

Constructors

Constructor and Description
WeightFactorFunction(float weight)
WeightFactorFunction(float weight, ScoreFunction scoreFunction)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.lucene.search.Explanation	explainWeight()
LeafScoreFunction	getLeafScoreFunction(org.apache.lucene.index.LeafReaderContext ctx)
float	getWeight()
boolean	needsScores() Indicates if document scores are needed by this function.

Methods inherited from class org.elasticsearch.common.lucene.search.function.ScoreFunction

getDefaultScoreCombiner

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightFactorFunction

public WeightFactorFunction(float weight,
                    ScoreFunction scoreFunction)

WeightFactorFunction

public WeightFactorFunction(float weight)

Method Detail

getLeafScoreFunction

public LeafScoreFunction getLeafScoreFunction(org.apache.lucene.index.LeafReaderContext ctx)
                                       throws IOException

Specified by:

getLeafScoreFunction in class ScoreFunction

Throws:

IOException

needsScores

public boolean needsScores()

Description copied from class: ScoreFunction

Indicates if document scores are needed by this function.

Specified by:

needsScores in class ScoreFunction

Returns:

true if scores are needed.

explainWeight

public org.apache.lucene.search.Explanation explainWeight()

getWeight

public float getWeight()