Class FieldValueFactorFunctionBuilder
java.lang.Object
org.elasticsearch.index.query.functionscore.ScoreFunctionBuilder<FieldValueFactorFunctionBuilder>
org.elasticsearch.index.query.functionscore.FieldValueFactorFunctionBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 float
DEFAULT_FACTOR
static FieldValueFactorFunction.Modifier
DEFAULT_MODIFIER
static java.lang.String
NAME
-
Constructor Summary
Constructors Constructor Description FieldValueFactorFunctionBuilder(java.lang.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(QueryShardContext context)
Build the Lucene ScoreFunction for this builder.protected void
doWriteTo(StreamOutput out)
Write the subclass's components into the stream.void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Convert this subclass's data into XContent.float
factor()
FieldValueFactorFunctionBuilder
factor(float boostFactor)
java.lang.String
fieldName()
static FieldValueFactorFunctionBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getName()
The name of this score function.java.lang.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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
DEFAULT_MODIFIER
-
DEFAULT_FACTOR
public static final float DEFAULT_FACTOR- See Also:
- Constant Field Values
-
-
Constructor Details
-
FieldValueFactorFunctionBuilder
public FieldValueFactorFunctionBuilder(java.lang.String fieldName) -
FieldValueFactorFunctionBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
Description copied from class:ScoreFunctionBuilder
Write the subclass's components into the stream.- Specified by:
doWriteTo
in classScoreFunctionBuilder<FieldValueFactorFunctionBuilder>
- Throws:
java.io.IOException
-
getName
public java.lang.String getName()Description copied from class:ScoreFunctionBuilder
The name of this score function.- Specified by:
getName
in classScoreFunctionBuilder<FieldValueFactorFunctionBuilder>
-
fieldName
public java.lang.String fieldName() -
factor
-
factor
public float factor() -
missing
Value used instead of the field value for documents that don't have that field defined. -
missing
public java.lang.Double missing() -
modifier
-
modifier
-
doXContent
public void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOExceptionDescription copied from class:ScoreFunctionBuilder
Convert this subclass's data into XContent.- Specified by:
doXContent
in classScoreFunctionBuilder<FieldValueFactorFunctionBuilder>
- Throws:
java.io.IOException
-
doEquals
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 classScoreFunctionBuilder<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 classScoreFunctionBuilder<FieldValueFactorFunctionBuilder>
-
doToFunction
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 classScoreFunctionBuilder<FieldValueFactorFunctionBuilder>
-
fromXContent
public static FieldValueFactorFunctionBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException, ParsingException- Throws:
java.io.IOException
ParsingException
-