org.elasticsearch.index.query.functionscore.fieldvaluefactor

Class FieldValueFactorFunctionBuilder

java.lang.Object

org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder

org.elasticsearch.index.query.functionscore.fieldvaluefactor.FieldValueFactorFunctionBuilder

All Implemented Interfaces:

ToXContent

public class FieldValueFactorFunctionBuilder
extends ScoreFunctionBuilder

Builder to construct field_value_factor functions for a function score query.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
FieldValueFactorFunctionBuilder(String fieldName)

Method Summary

Methods

Modifier and Type	Method and Description
void	doXContent(XContentBuilder builder, ToXContent.Params params)
FieldValueFactorFunctionBuilder	factor(float boostFactor)
String	getName()
FieldValueFactorFunctionBuilder	missing(double missing) Value used instead of the field value for documents that don't have that field defined.
FieldValueFactorFunctionBuilder	modifier(FieldValueFactorFunction.Modifier modifier)

Methods inherited from class org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder

buildWeight, setWeight, toXContent

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValueFactorFunctionBuilder

public FieldValueFactorFunctionBuilder(String fieldName)

Method Detail

getName

public String getName()

Specified by:

getName in class ScoreFunctionBuilder

factor

public FieldValueFactorFunctionBuilder factor(float boostFactor)

missing

public FieldValueFactorFunctionBuilder missing(double missing)

Value used instead of the field value for documents that don't have that field defined.

modifier

public FieldValueFactorFunctionBuilder modifier(FieldValueFactorFunction.Modifier modifier)

doXContent

public void doXContent(XContentBuilder builder,
              ToXContent.Params params)
                throws IOException

Specified by:

doXContent in class ScoreFunctionBuilder

Throws:

IOException