Package org.opensearch.common.lucene.search.function

Class WeightFactorFunction

java.lang.Object

org.opensearch.common.lucene.search.function.ScoreFunction

org.opensearch.common.lucene.search.function.WeightFactorFunction

public class WeightFactorFunction
extends ScoreFunction

Weight factor function

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
WeightFactorFunction(float weight)
WeightFactorFunction(float weight, String functionName)
WeightFactorFunction(float weight, ScoreFunction scoreFunction)
WeightFactorFunction(float weight, ScoreFunction scoreFunction, String functionName)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(ScoreFunction other)	Indicates whether some other ScoreFunction object of the same type is "equal to" this one.
protected int	doHashCode()
org.apache.lucene.search.Explanation	explainWeight()
LeafScoreFunction	getLeafScoreFunction(org.apache.lucene.index.LeafReaderContext ctx)
ScoreFunction	getScoreFunction()
float	getWeight()
boolean	needsScores()	Indicates if document scores are needed by this function.

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

equals, getDefaultScoreCombiner, hashCode, rewrite

Methods inherited from class java.lang.Object

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

Constructor Details

WeightFactorFunction

public WeightFactorFunction(float weight,
 ScoreFunction scoreFunction)

WeightFactorFunction

public WeightFactorFunction(float weight,
 ScoreFunction scoreFunction,
 @Nullable
 String functionName)

WeightFactorFunction

public WeightFactorFunction(float weight)

WeightFactorFunction

public WeightFactorFunction(float weight,
 @Nullable
 String functionName)

Method Details

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()

Overrides:

getWeight in class ScoreFunction

getScoreFunction

public ScoreFunction getScoreFunction()

doEquals

protected boolean doEquals(ScoreFunction other)

Description copied from class: ScoreFunction

Indicates whether some other ScoreFunction object of the same type is "equal to" this one.

Specified by:

doEquals in class ScoreFunction

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class ScoreFunction