org.elasticsearch.search.sort

クラス ScriptSortBuilder

java.lang.Object

org.elasticsearch.search.sort.SortBuilder

org.elasticsearch.search.sort.ScriptSortBuilder

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

ToXContent

public class ScriptSortBuilder
extends SortBuilder

Script sort builder allows to sort based on a custom script expression.

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

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

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

コンストラクタ

コンストラクタと説明
ScriptSortBuilder(Script script, String type) Constructs a script sort builder with the given script.
ScriptSortBuilder(String script, String type) 非推奨です。 Use ScriptSortBuilder(Script, String) instead.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ScriptSortBuilder	lang(String lang) 非推奨です。 Use ScriptSortBuilder(Script, String) instead.
SortBuilder	missing(Object missing) Not really relevant.
ScriptSortBuilder	order(SortOrder order) Sets the sort order.
ScriptSortBuilder	param(String name, Object value) 非推奨です。 Use ScriptSortBuilder(Script, String) instead.
ScriptSortBuilder	setNestedFilter(QueryBuilder nestedFilter) Sets the nested filter that the nested objects should match with in order to be taken into account for sorting.
ScriptSortBuilder	setNestedPath(String nestedPath) Sets the nested path if sorting occurs on a field that is inside a nested object.
ScriptSortBuilder	setParams(Map<String,Object> params) 非推奨です。 Use ScriptSortBuilder(Script, String) instead.
ScriptSortBuilder	sortMode(String sortMode) Defines which distance to use for sorting in the case a document contains multiple geo points.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params builderParams)

クラスから継承されたメソッド org.elasticsearch.search.sort.SortBuilder

toString

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

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

コンストラクタの詳細

ScriptSortBuilder

public ScriptSortBuilder(Script script,
                         String type)

Constructs a script sort builder with the given script.

パラメータ:

script - The script to use.

ScriptSortBuilder

@Deprecated
public ScriptSortBuilder(String script,
                                     String type)

非推奨です。 Use ScriptSortBuilder(Script, String) instead.

Constructs a script sort builder with the script and the type.

パラメータ:

script - The script to use.

type - The type, can either be "string" or "number".

メソッドの詳細

param

@Deprecated
public ScriptSortBuilder param(String name,
                                           Object value)

非推奨です。 Use ScriptSortBuilder(Script, String) instead.

Adds a parameter to the script.

パラメータ:

name - The name of the parameter.

value - The value of the parameter.

setParams

@Deprecated
public ScriptSortBuilder setParams(Map<String,Object> params)

非推奨です。 Use ScriptSortBuilder(Script, String) instead.

Sets parameters for the script.

パラメータ:

params - The script parameters

lang

@Deprecated
public ScriptSortBuilder lang(String lang)

非推奨です。 Use ScriptSortBuilder(Script, String) instead.

The language of the script.

order

public ScriptSortBuilder order(SortOrder order)

Sets the sort order.

定義:

order クラス内 SortBuilder

missing

public SortBuilder missing(Object missing)

Not really relevant.

定義:

missing クラス内 SortBuilder

sortMode

public ScriptSortBuilder sortMode(String sortMode)

Defines which distance to use for sorting in the case a document contains multiple geo points. Possible values: min and max

setNestedFilter

public ScriptSortBuilder setNestedFilter(QueryBuilder nestedFilter)

Sets the nested filter that the nested objects should match with in order to be taken into account for sorting.

setNestedPath

public ScriptSortBuilder setNestedPath(String nestedPath)

Sets the nested path if sorting occurs on a field that is inside a nested object. For sorting by script this needs to be specified.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params builderParams)
                           throws IOException

例外:

IOException