org.elasticsearch.common.lucene.search.function

Class FieldValueFactorFunction

java.lang.Object

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

org.elasticsearch.common.lucene.search.function.FieldValueFactorFunction

public class FieldValueFactorFunction
extends ScoreFunction

A function_score function that multiplies the score with the value of a field from the document, optionally multiplying the field by a factor first, and applying a modification (log, ln, sqrt, square, etc) afterwards.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldValueFactorFunction.Modifier The Type class encapsulates the modification types that can be applied to the score/value product.

Constructor Summary

Constructors

Constructor and Description
FieldValueFactorFunction(String field, float boostFactor, FieldValueFactorFunction.Modifier modifierType, Double missing, IndexNumericFieldData indexFieldData)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Explanation	explainScore(int docId, org.apache.lucene.search.Explanation subQueryScore)
double	score(int docId, float subQueryScore)
void	setNextReader(org.apache.lucene.index.AtomicReaderContext context)

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

FieldValueFactorFunction

public FieldValueFactorFunction(String field,
                                float boostFactor,
                                FieldValueFactorFunction.Modifier modifierType,
                                Double missing,
                                IndexNumericFieldData indexFieldData)

Method Detail

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext context)

Specified by:

setNextReader in class ScoreFunction

score

public double score(int docId,
                    float subQueryScore)

Specified by:

score in class ScoreFunction

explainScore

public org.apache.lucene.search.Explanation explainScore(int docId,
                                                         org.apache.lucene.search.Explanation subQueryScore)

Specified by:

explainScore in class ScoreFunction