Package org.elasticsearch.index.query.functionscore

Class DecayFunctionBuilder<DFB extends DecayFunctionBuilder<DFB>>

java.lang.Object

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

org.elasticsearch.index.query.functionscore.DecayFunctionBuilder<DFB>

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

Direct Known Subclasses:

ExponentialDecayFunctionBuilder, GaussDecayFunctionBuilder, LinearDecayFunctionBuilder

public abstract class DecayFunctionBuilder<DFB extends DecayFunctionBuilder<DFB>>
extends ScoreFunctionBuilder<DFB>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DecayFunctionBuilder.AbstractDistanceScoreFunction	This is the base class for scoring a single field.

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
protected static String	DECAY
static double	DEFAULT_DECAY
static MultiValueMode	DEFAULT_MULTI_VALUE_MODE
protected static String	OFFSET
protected static String	ORIGIN
protected static String	SCALE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DecayFunctionBuilder(String fieldName, Object origin, Object scale, Object offset)	Convenience constructor that converts its parameters into json to parse on the data nodes.
protected	DecayFunctionBuilder(String fieldName, Object origin, Object scale, Object offset, double decay)	Convenience constructor that converts its parameters into json to parse on the data nodes.
protected	DecayFunctionBuilder(String fieldName, BytesReference functionBytes)
protected	DecayFunctionBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(DFB 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(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)	Convert this subclass's data into XContent.
protected abstract DecayFunction	getDecayFunction()	Override this function if you want to produce your own scorer.
String	getFieldName()
BytesReference	getFunctionBytes()
MultiValueMode	getMultiValueMode()
DFB	setMultiValueMode(MultiValueMode multiValueMode)

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

equals, getName, 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.common.xcontent.ToXContentFragment

isFragment

Field Details

ORIGIN

protected static final String ORIGIN

See Also:

Constant Field Values

SCALE

protected static final String SCALE

See Also:

Constant Field Values

DECAY

protected static final String DECAY

See Also:

Constant Field Values

OFFSET

protected static final String OFFSET

See Also:

Constant Field Values

DEFAULT_DECAY

public static final double DEFAULT_DECAY

See Also:

Constant Field Values

DEFAULT_MULTI_VALUE_MODE

public static final MultiValueMode DEFAULT_MULTI_VALUE_MODE

Constructor Details

DecayFunctionBuilder

protected DecayFunctionBuilder(String fieldName,
 Object origin,
 Object scale,
 Object offset)

Convenience constructor that converts its parameters into json to parse on the data nodes.

DecayFunctionBuilder

protected DecayFunctionBuilder(String fieldName,
 Object origin,
 Object scale,
 Object offset,
 double decay)

Convenience constructor that converts its parameters into json to parse on the data nodes.

DecayFunctionBuilder

protected DecayFunctionBuilder(String fieldName,
 BytesReference functionBytes)

DecayFunctionBuilder

protected DecayFunctionBuilder(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<DFB extends DecayFunctionBuilder<DFB>>

Throws:

IOException

getFieldName

public String getFieldName()

getFunctionBytes

public BytesReference getFunctionBytes()

doXContent

public void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                throws IOException

Description copied from class: ScoreFunctionBuilder

Convert this subclass's data into XContent.

Specified by:

doXContent in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder<DFB>>

Throws:

IOException

setMultiValueMode

public DFB setMultiValueMode(MultiValueMode multiValueMode)

getMultiValueMode

public MultiValueMode getMultiValueMode()

doEquals

protected boolean doEquals(DFB 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<DFB extends DecayFunctionBuilder<DFB>>

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<DFB extends DecayFunctionBuilder<DFB>>

doToFunction

protected ScoreFunction doToFunction(SearchExecutionContext context)
                              throws IOException

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<DFB extends DecayFunctionBuilder<DFB>>

Throws:

IOException

getDecayFunction

protected abstract DecayFunction getDecayFunction()

Override this function if you want to produce your own scorer.