org.elasticsearch.index.query.functionscore

Class DecayFunctionBuilder<DFB extends DecayFunctionBuilder>

java.lang.Object

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

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

All Implemented Interfaces:

NamedWriteable<DFB>, StreamableReader<DFB>, Writeable<DFB>, ToXContent

Direct Known Subclasses:

ExponentialDecayFunctionBuilder, GaussDecayFunctionBuilder, LinearDecayFunctionBuilder

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<R>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DECAY
static double	DEFAULT_DECAY
static MultiValueMode	DEFAULT_MULTI_VALUE_MODE
protected static java.lang.String	OFFSET
protected static java.lang.String	ORIGIN
protected static java.lang.String	SCALE

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

weight

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DecayFunctionBuilder(java.lang.String fieldName, BytesReference functionBytes)
protected	DecayFunctionBuilder(java.lang.String fieldName, java.lang.Object origin, java.lang.Object scale, java.lang.Object offset)
protected	DecayFunctionBuilder(java.lang.String fieldName, java.lang.Object origin, java.lang.Object scale, java.lang.Object offset, double decay)

Method Summary

Modifier and Type	Method and Description
protected abstract DFB	createFunctionBuilder(java.lang.String fieldName, BytesReference functionBytes)
protected boolean	doEquals(DFB functionBuilder)
protected int	doHashCode()
protected DFB	doReadFrom(StreamInput in)
protected ScoreFunction	doToFunction(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
protected abstract DecayFunction	getDecayFunction() Override this function if you want to produce your own scorer.
java.lang.String	getFieldName()
BytesReference	getFunctionBytes()
MultiValueMode	getMultiValueMode()
ScoreFunctionBuilder	setMultiValueMode(MultiValueMode multiValueMode)

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

buildWeight, equals, getName, getWeight, getWriteableName, hashCode, readFrom, setWeight, toFunction, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

ORIGIN

protected static final java.lang.String ORIGIN

See Also:

Constant Field Values

SCALE

protected static final java.lang.String SCALE

See Also:

Constant Field Values

DECAY

protected static final java.lang.String DECAY

See Also:

Constant Field Values

OFFSET

protected static final java.lang.String OFFSET

See Also:

Constant Field Values

DEFAULT_DECAY

public static double DEFAULT_DECAY

DEFAULT_MULTI_VALUE_MODE

public static MultiValueMode DEFAULT_MULTI_VALUE_MODE

Constructor Detail

DecayFunctionBuilder

protected DecayFunctionBuilder(java.lang.String fieldName,
                               java.lang.Object origin,
                               java.lang.Object scale,
                               java.lang.Object offset)

DecayFunctionBuilder

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

DecayFunctionBuilder

protected DecayFunctionBuilder(java.lang.String fieldName,
                               BytesReference functionBytes)

Method Detail

getFieldName

public java.lang.String getFieldName()

getFunctionBytes

public BytesReference getFunctionBytes()

doXContent

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

Specified by:

doXContent in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder>

Throws:

java.io.IOException

setMultiValueMode

public ScoreFunctionBuilder setMultiValueMode(MultiValueMode multiValueMode)

getMultiValueMode

public MultiValueMode getMultiValueMode()

doReadFrom

protected DFB doReadFrom(StreamInput in)
                  throws java.io.IOException

Specified by:

doReadFrom in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder>

Throws:

java.io.IOException

createFunctionBuilder

protected abstract DFB createFunctionBuilder(java.lang.String fieldName,
                                             BytesReference functionBytes)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder>

Throws:

java.io.IOException

doEquals

protected boolean doEquals(DFB functionBuilder)

Specified by:

doEquals in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder>

doToFunction

protected ScoreFunction doToFunction(QueryShardContext context)
                              throws java.io.IOException

Specified by:

doToFunction in class ScoreFunctionBuilder<DFB extends DecayFunctionBuilder>

Throws:

java.io.IOException

getDecayFunction

protected abstract DecayFunction getDecayFunction()

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