org.elasticsearch.search.sort

Class FieldSortBuilder

java.lang.Object

org.elasticsearch.search.sort.SortBuilder

org.elasticsearch.search.sort.FieldSortBuilder

All Implemented Interfaces:

ToXContent

public class FieldSortBuilder
extends SortBuilder

A sort builder to sort based on a document field.

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
FieldSortBuilder(String fieldName) Constructs a new sort based on a document field.

Method Summary

Methods

Modifier and Type	Method and Description
FieldSortBuilder	ignoreUnmapped(boolean ignoreUnmapped) Deprecated. Use unmappedType(String) instead.
FieldSortBuilder	missing(Object missing) Sets the value when a field is missing in a doc.
FieldSortBuilder	order(SortOrder order) The order of sorting.
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(String nestedPath) Sets the nested path if sorting occurs on a field that is inside a nested object.
FieldSortBuilder	sortMode(String 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)
FieldSortBuilder	unmappedType(String type) Set the type to use in case the current field is not mapped in an index.

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

FieldSortBuilder

public FieldSortBuilder(String fieldName)

Constructs a new sort based on a document field.

Parameters:

fieldName - The field name.

Method Detail

order

public FieldSortBuilder order(SortOrder order)

The order of sorting. Defaults to SortOrder.ASC.

Specified by:

order in class SortBuilder

missing

public FieldSortBuilder missing(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.

Specified by:

missing in class SortBuilder

ignoreUnmapped

@Deprecated
public FieldSortBuilder ignoreUnmapped(boolean ignoreUnmapped)

Deprecated. Use unmappedType(String) instead.

Sets if the field does not exists in the index, it should be ignored and not sorted by or not. Defaults to false (not ignoring).

unmappedType

public FieldSortBuilder unmappedType(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.

sortMode

public FieldSortBuilder sortMode(String 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.

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.

setNestedPath

public FieldSortBuilder setNestedPath(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.

toXContent

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

Throws:

IOException