org.elasticsearch.index.query.functionscore

クラス DecayFunctionParser

java.lang.Object

org.elasticsearch.index.query.functionscore.DecayFunctionParser

すべての実装されたインタフェース:

ScoreFunctionParser

直系の既知のサブクラス:

ExponentialDecayFunctionParser, GaussDecayFunctionParser, LinearDecayFunctionParser

public abstract class DecayFunctionParser
extends Object
implements ScoreFunctionParser

This class provides the basic functionality needed for adding a decay function. This parser parses this kind of input

 
 {
      "fieldname1" : {
          "origin" = "someValue",
          "scale" = "someValue"
      }

 
 

"origin" here refers to the reference point and "scale" to the level of uncertainty you have in your origin.

For example, you might want to retrieve an event that took place around the 20 May 2010 somewhere near Berlin. You are mainly interested in events that are close to the 20 May 2010 but you are unsure about your guess, maybe it was a week before or after that. Your "origin" for the date field would be "20 May 2010" and your "scale" would be "7d". This class parses the input and creates a scoring function from the parameters origin and scale.

To write a new scoring function, create a new class that inherits from this one and implement the getDistanceFunction(). Furthermore, to create a builder, override the getName() in DecayFunctionBuilder.

See GaussDecayFunctionBuilder and GaussDecayFunctionParser for an example. The parser furthermore needs to be registered in the ScoreFunctionParserMapper.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	DecayFunctionParser.AbstractDistanceScoreFunction This is the base class for scoring a single field.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static ParseField	MULTI_VALUE_MODE

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DecayFunctionParser()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract DecayFunction	getDecayFunction() Override this function if you want to produce your own scorer.
ScoreFunction	parse(QueryParseContext parseContext, XContentParser parser) Parses bodies of the kind { "fieldname1" : { "origin" = "someValue", "scale" = "someValue" } }

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド org.elasticsearch.index.query.functionscore.ScoreFunctionParser

getNames

フィールドの詳細

MULTI_VALUE_MODE

public static final ParseField MULTI_VALUE_MODE

コンストラクタの詳細

DecayFunctionParser

public DecayFunctionParser()

メソッドの詳細

getDecayFunction

public abstract DecayFunction getDecayFunction()

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

parse

public ScoreFunction parse(QueryParseContext parseContext,
                           XContentParser parser)
                    throws IOException,
                           QueryParsingException

Parses bodies of the kind

 
 {
      "fieldname1" : {
          "origin" = "someValue",
          "scale" = "someValue"
      }

 }
 
 

定義:

parse インタフェース内 ScoreFunctionParser

例外:

IOException

QueryParsingException