Module org.elasticsearch.server

Package org.elasticsearch.index.query.functionscore

Class FieldValueFactorFunctionBuilder

java.lang.Object

org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

org.elasticsearch.index.query.functionscore.FieldValueFactorFunctionBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

public class FieldValueFactorFunctionBuilder
extends ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

Builder to construct field_value_factor functions for a function score query.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_FACTOR
static final FieldValueFactorFunction.Modifier	DEFAULT_MODIFIER
static final String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FieldValueFactorFunctionBuilder(String fieldName)
FieldValueFactorFunctionBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(FieldValueFactorFunctionBuilder functionBuilder)	Check that two instances of the same subclass of ScoreFunctionBuilder are equal.
protected int	doHashCode()	Hashcode for fields defined in this subclass of ScoreFunctionBuilder.
protected ScoreFunction	doToFunction(SearchExecutionContext context)	Build the Lucene ScoreFunction for this builder.
protected void	doWriteTo(StreamOutput out)	Write the subclass's components into the stream.
void	doXContent(XContentBuilder builder, ToXContent.Params params)	Convert this subclass's data into XContent.
float	factor()
FieldValueFactorFunctionBuilder	factor(float boostFactor)
String	fieldName()
static FieldValueFactorFunctionBuilder	fromXContent(XContentParser parser)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getName()	The name of this score function.
Double	missing()
FieldValueFactorFunctionBuilder	missing(double missing)	Value used instead of the field value for documents that don't have that field defined.
FieldValueFactorFunction.Modifier	modifier()
FieldValueFactorFunctionBuilder	modifier(FieldValueFactorFunction.Modifier modifier)

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

equals, getWeight, getWriteableName, hashCode, setWeight, toFunction, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_MODIFIER

public static final FieldValueFactorFunction.Modifier DEFAULT_MODIFIER

DEFAULT_FACTOR

public static final float DEFAULT_FACTOR

See Also:

• Constant Field Values

Constructor Details

FieldValueFactorFunctionBuilder

public FieldValueFactorFunctionBuilder(String fieldName)

FieldValueFactorFunctionBuilder

public FieldValueFactorFunctionBuilder(StreamInput in)
                                throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Description copied from class: ScoreFunctionBuilder

Write the subclass's components into the stream.

Specified by:

doWriteTo in class ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

Throws:

IOException

getName

public String getName()

Description copied from class: ScoreFunctionBuilder

The name of this score function.

Specified by:

getName in class ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

fieldName

public String fieldName()

factor

public FieldValueFactorFunctionBuilder factor(float boostFactor)

factor

public float factor()

missing

public FieldValueFactorFunctionBuilder missing(double missing)

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

missing

public Double missing()

modifier

public FieldValueFactorFunctionBuilder modifier(FieldValueFactorFunction.Modifier modifier)

modifier

public FieldValueFactorFunction.Modifier modifier()

doXContent

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

Description copied from class: ScoreFunctionBuilder

Convert this subclass's data into XContent.

Specified by:

doXContent in class ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(FieldValueFactorFunctionBuilder functionBuilder)

Description copied from class: ScoreFunctionBuilder

Check that two instances of the same subclass of ScoreFunctionBuilder are equal. Implementers don't need to check any fields in ScoreFunctionBuilder, just fields that they define.

Specified by:

doEquals in class ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

doHashCode

protected int doHashCode()

Description copied from class: ScoreFunctionBuilder

Hashcode for fields defined in this subclass of ScoreFunctionBuilder. Implementers should ignore fields defined in ScoreFunctionBuilder because they will already be in the hashCode.

Specified by:

doHashCode in class ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

doToFunction

protected ScoreFunction doToFunction(SearchExecutionContext context)

Description copied from class: ScoreFunctionBuilder

Build the Lucene ScoreFunction for this builder. Implementers should ignore things defined in ScoreFunctionBuilder like weight as they will be handled by the function that calls this one.

Specified by:

doToFunction in class ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>

fromXContent

public static FieldValueFactorFunctionBuilder fromXContent(XContentParser parser)
                                                    throws IOException,
ParsingException

Throws:

IOException

ParsingException