ExponentialDecayFunctionBuilder (server 7.10.2 API)

java.lang.Object

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

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

org.elasticsearch.index.query.functionscore.ExponentialDecayFunctionBuilder

All Implemented Interfaces:: NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class ExponentialDecayFunctionBuilder
extends DecayFunctionBuilder<ExponentialDecayFunctionBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.index.query.functionscore.DecayFunctionBuilder
DecayFunctionBuilder.AbstractDistanceScoreFunction

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 DecayFunction`	`EXP_DECAY_FUNCTION`
`static java.lang.String`	`NAME`
`static ScoreFunctionParser<ExponentialDecayFunctionBuilder>`	`PARSER`

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

DECAY, DEFAULT_DECAY, DEFAULT_MULTI_VALUE_MODE, OFFSET, ORIGIN, SCALE

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

EMPTY_PARAMS

Constructor Summary

Constructors
Constructor	Description
`ExponentialDecayFunctionBuilder(java.lang.String fieldName, java.lang.Object origin, java.lang.Object scale, java.lang.Object offset)`
`ExponentialDecayFunctionBuilder(java.lang.String fieldName, java.lang.Object origin, java.lang.Object scale, java.lang.Object offset, double decay)`
`ExponentialDecayFunctionBuilder(StreamInput in)`	Read from a stream.

Method Summary

Modifier and Type	Method	Description
`DecayFunction`	`getDecayFunction()`	Override this function if you want to produce your own scorer.
`java.lang.String`	`getName()`	The name of this score function.

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

doEquals, doHashCode, doToFunction, doWriteTo, doXContent, getFieldName, getFunctionBytes, getMultiValueMode, setMultiValueMode

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

isFragment

Field Details
- NAME
  
  public static final java.lang.String NAME
  
  See Also:
  
  Constant Field Values
- PARSER
  
  public static final ScoreFunctionParser<ExponentialDecayFunctionBuilder> PARSER
- EXP_DECAY_FUNCTION
  
  public static final DecayFunction EXP_DECAY_FUNCTION
Constructor Details
- ExponentialDecayFunctionBuilder
  
  public ExponentialDecayFunctionBuilder(java.lang.String fieldName, java.lang.Object origin, java.lang.Object scale, java.lang.Object offset)
- ExponentialDecayFunctionBuilder
  
  public ExponentialDecayFunctionBuilder(java.lang.String fieldName, java.lang.Object origin, java.lang.Object scale, java.lang.Object offset, double decay)
- ExponentialDecayFunctionBuilder
  
  public ExponentialDecayFunctionBuilder(StreamInput in) throws java.io.IOException
  
  Read from a stream.
  
  Throws:
  
  java.io.IOException
Method Details
- getName
  
  public java.lang.String getName()
  
  Description copied from class: ScoreFunctionBuilder
  
  The name of this score function.
  
  Specified by:
  
  getName in class ScoreFunctionBuilder<ExponentialDecayFunctionBuilder>
- getDecayFunction
  
  public DecayFunction getDecayFunction()
  
  Description copied from class: DecayFunctionBuilder
  
  Override this function if you want to produce your own scorer.
  
  Specified by:
  
  getDecayFunction in class DecayFunctionBuilder<ExponentialDecayFunctionBuilder>