org.elasticsearch.search.sort

Class ScriptSortBuilder

java.lang.Object

org.elasticsearch.search.sort.SortBuilder

org.elasticsearch.search.sort.ScriptSortBuilder

All Implemented Interfaces:

ToXContent

public class ScriptSortBuilder
extends SortBuilder

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ScriptSortBuilder(Script script, String type) Constructs a script sort builder with the given script.
ScriptSortBuilder(String script, String type) Deprecated. Use ScriptSortBuilder(Script, String) instead.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptSortBuilder	lang(String lang) Deprecated. 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) Deprecated. 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) Deprecated. 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)

Methods inherited from class org.elasticsearch.search.sort.SortBuilder

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptSortBuilder

public ScriptSortBuilder(Script script,
                 String type)

Constructs a script sort builder with the given script.

Parameters:

script - The script to use.

ScriptSortBuilder

@Deprecated
public ScriptSortBuilder(String script,
                            String type)

Deprecated. Use ScriptSortBuilder(Script, String) instead.

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

Parameters:

script - The script to use.

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

Method Detail

param

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

Deprecated. Use ScriptSortBuilder(Script, String) instead.

Adds a parameter to the script.

Parameters:

name - The name of the parameter.

value - The value of the parameter.

setParams

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

Deprecated. Use ScriptSortBuilder(Script, String) instead.

Sets parameters for the script.

Parameters:

params - The script parameters

lang

@Deprecated
public ScriptSortBuilder lang(String lang)

Deprecated. Use ScriptSortBuilder(Script, String) instead.

The language of the script.

order

public ScriptSortBuilder order(SortOrder order)

Sets the sort order.

Specified by:

order in class SortBuilder

missing

public SortBuilder missing(Object missing)

Not really relevant.

Specified by:

missing in class 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

Throws:

IOException