Package org.elasticsearch.search.sort

Class ScriptSortBuilder

java.lang.Object

org.elasticsearch.search.sort.SortBuilder<ScriptSortBuilder>

org.elasticsearch.search.sort.ScriptSortBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, Rewriteable<SortBuilder<?>>, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class ScriptSortBuilder
extends SortBuilder<ScriptSortBuilder>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScriptSortBuilder.ScriptSortType

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

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.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 final String	NAME
static final org.elasticsearch.xcontent.ParseField	SCRIPT_FIELD
static final org.elasticsearch.xcontent.ParseField	SORTMODE_FIELD
static final org.elasticsearch.xcontent.ParseField	TYPE_FIELD

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

NESTED_FILTER_FIELD, NESTED_PATH_FIELD, order, ORDER_FIELD

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptSortBuilder(StreamInput in)	Read from a stream.
ScriptSortBuilder(Script script, ScriptSortBuilder.ScriptSortType type)	Constructs a script sort builder with the given script.

Method Summary

Modifier and Type	Method	Description
SortFieldAndFormat	build(SearchExecutionContext context)	Create a SortFieldAndFormat from this builder.
BucketedSort	buildBucketedSort(SearchExecutionContext context, BigArrays bigArrays, int bucketSize, BucketedSort.ExtraData extra)	Create a BucketedSort which is useful for sorting inside of aggregations.
boolean	equals(Object object)
static ScriptSortBuilder	fromXContent(org.elasticsearch.xcontent.XContentParser parser, String elementName)	Creates a new ScriptSortBuilder from the query held by the XContentParser in XContent format.
QueryBuilder	getNestedFilter()	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
String	getNestedPath()	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
NestedSortBuilder	getNestedSort()	Returns the NestedSortBuilder
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
ScriptSortBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
Script	script()	Get the script used in this sort.
ScriptSortBuilder	setNestedFilter(QueryBuilder nestedFilter)	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
ScriptSortBuilder	setNestedPath(String nestedPath)	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
ScriptSortBuilder	setNestedSort(NestedSortBuilder nestedSort)	Sets the NestedSortBuilder to be used for fields that are inside a nested object.
SortMode	sortMode()	Get the sort mode.
ScriptSortBuilder	sortMode(SortMode sortMode)	Defines which distance to use for sorting in the case a document contains multiple values. For ScriptSortBuilder.ScriptSortType.STRING, the set of possible values is restricted to SortMode.MIN and SortMode.MAX
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params builderParams)
ScriptSortBuilder.ScriptSortType	type()	Get the type used in this sort.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

buildSort, fromXContent, order, order, parseNestedFilter, resolveNested, resolveNested, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

TYPE_FIELD

public static final org.elasticsearch.xcontent.ParseField TYPE_FIELD

SCRIPT_FIELD

public static final org.elasticsearch.xcontent.ParseField SCRIPT_FIELD

SORTMODE_FIELD

public static final org.elasticsearch.xcontent.ParseField SORTMODE_FIELD

Constructor Details

ScriptSortBuilder

public ScriptSortBuilder(Script script,
 ScriptSortBuilder.ScriptSortType type)

Constructs a script sort builder with the given script.

Parameters:

script - The script to use.

type - The type of the script, can be either ScriptSortBuilder.ScriptSortType.STRING or ScriptSortBuilder.ScriptSortType.NUMBER

ScriptSortBuilder

public ScriptSortBuilder(StreamInput in)
                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

IOException

script

public Script script()

Get the script used in this sort.

type

public ScriptSortBuilder.ScriptSortType type()

Get the type used in this sort.

sortMode

public ScriptSortBuilder sortMode(SortMode sortMode)

Defines which distance to use for sorting in the case a document contains multiple values.
For ScriptSortBuilder.ScriptSortType.STRING, the set of possible values is restricted to SortMode.MIN and SortMode.MAX

sortMode

public SortMode sortMode()

Get the sort mode.

setNestedFilter

@Deprecated
public ScriptSortBuilder setNestedFilter(QueryBuilder nestedFilter)

Deprecated.

set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()

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

getNestedFilter

@Deprecated
public QueryBuilder getNestedFilter()

Deprecated.

set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()

Gets the nested filter.

setNestedPath

@Deprecated
public ScriptSortBuilder setNestedPath(String nestedPath)

Deprecated.

set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()

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.

getNestedPath

@Deprecated
public String getNestedPath()

Deprecated.

set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()

Gets the nested path.

getNestedSort

public NestedSortBuilder getNestedSort()

Returns the NestedSortBuilder

setNestedSort

public ScriptSortBuilder setNestedSort(NestedSortBuilder nestedSort)

Sets the NestedSortBuilder to be used for fields that are inside a nested object. The NestedSortBuilder takes a `path` argument and an optional nested filter that the nested objects should match with in order to be taken into account for sorting.

toXContent

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

Throws:

IOException

fromXContent

public static ScriptSortBuilder fromXContent(org.elasticsearch.xcontent.XContentParser parser,
 String elementName)

Creates a new ScriptSortBuilder from the query held by the XContentParser in XContent format.

Parameters:

parser - the input parser. The state on the parser contained in this context will be changed as a side effect of this method call

elementName - in some sort syntax variations the field name precedes the xContent object that specifies further parameters, e.g. in '{ "foo": { "order" : "asc"} }'. When parsing the inner object, the field name can be passed in via this argument

build

public SortFieldAndFormat build(SearchExecutionContext context)
                         throws IOException

Description copied from class: SortBuilder

Create a SortFieldAndFormat from this builder.

Specified by:

build in class SortBuilder<ScriptSortBuilder>

Throws:

IOException

buildBucketedSort

public BucketedSort buildBucketedSort(SearchExecutionContext context,
 BigArrays bigArrays,
 int bucketSize,
 BucketedSort.ExtraData extra)
                               throws IOException

Description copied from class: SortBuilder

Create a BucketedSort which is useful for sorting inside of aggregations.

Specified by:

buildBucketedSort in class SortBuilder<ScriptSortBuilder>

Throws:

IOException

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

rewrite

public ScriptSortBuilder rewrite(QueryRewriteContext ctx)
                          throws IOException

Description copied from interface: Rewriteable

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

Throws:

IOException