org.elasticsearch.search.sort

Class FieldSortBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.search.sort.FieldSortBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent

public class FieldSortBuilder
extends SortBuilder<FieldSortBuilder>

A sort builder to sort based on a document field.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DOC_FIELD_NAME special field name to sort by index order
static ParseField	MISSING
static java.lang.String	NAME
static ParseField	SORT_MODE
static ParseField	UNMAPPED_TYPE

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

NESTED_FILTER_FIELD, NESTED_PATH_FIELD, order, ORDER_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
FieldSortBuilder(FieldSortBuilder template) Copy constructor.
FieldSortBuilder(StreamInput in) Read from a stream.
FieldSortBuilder(java.lang.String fieldName) Constructs a new sort based on a document field.

Method Summary

Modifier and Type	Method and Description
SortFieldAndFormat	build(QueryShardContext context) Create a @link SortFieldAndFormat from this builder.
boolean	equals(java.lang.Object other)
static FieldSortBuilder	fromXContent(QueryParseContext context, java.lang.String fieldName) Creates a new FieldSortBuilder from the query held by the QueryParseContext in XContent format.
java.lang.String	getFieldName() Returns the document field this sort should be based on.
QueryBuilder	getNestedFilter() Returns the nested filter that the nested objects should match with in order to be taken into account for sorting.
java.lang.String	getNestedPath() Returns the nested path if sorting occurs in a field that is inside a nested object.
java.lang.String	getWriteableName() Returns the name of the writeable object
int	hashCode()
java.lang.Object	missing() Returns the value used when a field is missing in a doc.
FieldSortBuilder	missing(java.lang.Object missing) Sets the value when a field is missing in a doc.
FieldSortBuilder	setNestedFilter(QueryBuilder nestedFilter) Sets the nested filter that the nested objects should match with in order to be taken into account for sorting.
FieldSortBuilder	setNestedPath(java.lang.String nestedPath) Sets the nested path if sorting occurs on a field that is inside a nested object.
SortMode	sortMode() Returns what values to pick in the case a document contains multiple values for the targeted sort field.
FieldSortBuilder	sortMode(SortMode sortMode) Defines what values to pick in the case a document contains multiple values for the targeted sort field.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	unmappedType() Returns the type to use in case the current field is not mapped in an index.
FieldSortBuilder	unmappedType(java.lang.String type) Set the type to use in case the current field is not mapped in an index.
void	writeTo(StreamOutput out) Write this into the StreamOutput.

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

buildSort, fromXContent, order, order, parseNestedFilter, resolveNested

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

MISSING

public static final ParseField MISSING

SORT_MODE

public static final ParseField SORT_MODE

UNMAPPED_TYPE

public static final ParseField UNMAPPED_TYPE

DOC_FIELD_NAME

public static final java.lang.String DOC_FIELD_NAME

special field name to sort by index order

See Also:

Constant Field Values

Constructor Detail

FieldSortBuilder

public FieldSortBuilder(FieldSortBuilder template)

Copy constructor.

FieldSortBuilder

public FieldSortBuilder(java.lang.String fieldName)

Constructs a new sort based on a document field.

Parameters:

fieldName - The field name.

FieldSortBuilder

public FieldSortBuilder(StreamInput in)
                 throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

java.io.IOException

getFieldName

public java.lang.String getFieldName()

Returns the document field this sort should be based on.

missing

public FieldSortBuilder missing(java.lang.Object missing)

Sets the value when a field is missing in a doc. Can also be set to _last or _first to sort missing last or first respectively.

missing

public java.lang.Object missing()

Returns the value used when a field is missing in a doc.

unmappedType

public FieldSortBuilder unmappedType(java.lang.String type)

Set the type to use in case the current field is not mapped in an index. Specifying a type tells Elasticsearch what type the sort values should have, which is important for cross-index search, if there are sort fields that exist on some indices only. If the unmapped type is null then query execution will fail if one or more indices don't have a mapping for the current field.

unmappedType

public java.lang.String unmappedType()

Returns the type to use in case the current field is not mapped in an index.

sortMode

public FieldSortBuilder sortMode(SortMode sortMode)

Defines what values to pick in the case a document contains multiple values for the targeted sort field. Possible values: min, max, sum and avg

The last two values are only applicable for number based fields.

sortMode

public SortMode sortMode()

Returns what values to pick in the case a document contains multiple values for the targeted sort field.

setNestedFilter

public FieldSortBuilder setNestedFilter(QueryBuilder nestedFilter)

Sets the nested filter that the nested objects should match with in order to be taken into account for sorting. TODO should the above getters and setters be deprecated/ changed in favour of real getters and setters?

getNestedFilter

public QueryBuilder getNestedFilter()

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

setNestedPath

public FieldSortBuilder setNestedPath(java.lang.String nestedPath)

Sets the nested path if sorting occurs on a field that is inside a nested object. By default when sorting on a field inside a nested object, the nearest upper nested object is selected as nested path.

getNestedPath

public java.lang.String getNestedPath()

Returns the nested path if sorting occurs in a field that is inside a nested object.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Throws:

java.io.IOException

build

public SortFieldAndFormat build(QueryShardContext context)
                         throws java.io.IOException

Description copied from class: SortBuilder

Create a @link SortFieldAndFormat from this builder.

Specified by:

build in class SortBuilder<FieldSortBuilder>

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

fromXContent

public static FieldSortBuilder fromXContent(QueryParseContext context,
                                            java.lang.String fieldName)
                                     throws java.io.IOException

Creates a new FieldSortBuilder from the query held by the QueryParseContext in XContent format.

Parameters:

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

fieldName - 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

Throws:

java.io.IOException