Module org.elasticsearch.server

Package org.elasticsearch.search.sort

Class FieldSortBuilder

java.lang.Object

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

org.elasticsearch.search.sort.FieldSortBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<SortBuilder<?>>, ToXContent, ToXContentObject

public final 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.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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	DOC_FIELD_NAME	special field name to sort by index order
static final ParseField	FORMAT
static final ParseField	MISSING
static final String	NAME
static final ParseField	NUMERIC_TYPE
static final String	SHARD_DOC_FIELD_NAME	special field name to sort by index order
static final ParseField	SORT_MODE
static final ParseField	UNMAPPED_TYPE

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

order, ORDER_FIELD

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

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

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	canRewriteToMatchNone()
boolean	equals(Object other)
static FieldSortBuilder	fromXContent(XContentParser parser, String fieldName)	Creates a new FieldSortBuilder from the query held by the XContentParser in XContent format.
String	getFieldName()	Returns the document field this sort should be based on.
String	getFormat()	Returns the external format that is specified via setFormat(String)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
static MinAndMax<?>	getMinMaxOrNull(SearchExecutionContext context, FieldSortBuilder sortBuilder)	Return the MinAndMax indexed value from the provided FieldSortBuilder or null if unknown.
NestedSortBuilder	getNestedSort()	Returns the NestedSortBuilder
String	getNumericType()	Returns the numeric type that values should translated to or null if the original numeric type should be preserved.
static FieldSortBuilder	getPrimaryFieldSortOrNull(SearchSourceBuilder source)	Return the FieldSortBuilder if the primary sort in the provided source is an instance of this class, null otherwise.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static boolean	hasPrimaryFieldSort(SearchSourceBuilder source)	Return true if the primary sort in the provided source is an instance of FieldSortBuilder.
boolean	isBottomSortShardDisjoint(SearchExecutionContext context, SearchSortValuesAndFormats bottomSortValues)	Returns whether some values of the given SearchExecutionContext.getIndexReader() are within the primary sort value provided in the bottomSortValues.
Object	missing()	Returns the value used when a field is missing in a doc.
FieldSortBuilder	missing(Object missing)	Sets the value when a field is missing in a doc.
String	name()	The name or type of the sort
FieldSortBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
FieldSortBuilder	setFormat(String format)	Specifies a format specification that will be used to format the output value of this sort field.
FieldSortBuilder	setNestedSort(NestedSortBuilder nestedSort)	Sets the NestedSortBuilder to be used for fields that are inside a nested object.
FieldSortBuilder	setNumericType(String numericType)	Forces the numeric type to use for the field.
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.
boolean	supportsParallelCollection()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	unmappedType()	Returns the type to use in case the current field is not mapped in an index.
FieldSortBuilder	unmappedType(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, buildSort, fromXContent, order, order, parseNestedFilter, 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

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

NAME

public static final 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

NUMERIC_TYPE

public static final ParseField NUMERIC_TYPE

FORMAT

public static final ParseField FORMAT

DOC_FIELD_NAME

public static final String DOC_FIELD_NAME

special field name to sort by index order

See Also:

• Constant Field Values

SHARD_DOC_FIELD_NAME

public static final String SHARD_DOC_FIELD_NAME

special field name to sort by index order

See Also:

• Constant Field Values

Constructor Details

FieldSortBuilder

public FieldSortBuilder(FieldSortBuilder template)

Copy constructor.

FieldSortBuilder

public FieldSortBuilder(String fieldName)

Constructs a new sort based on a document field.

Parameters:

fieldName - The field name.

FieldSortBuilder

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

getFieldName

public String getFieldName()

Returns the document field this sort should be based on.

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.

missing

public Object missing()

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

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.

unmappedType

public 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.

getNestedSort

public NestedSortBuilder getNestedSort()

Returns the NestedSortBuilder

setNestedSort

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

getNumericType

public String getNumericType()

Returns the numeric type that values should translated to or null if the original numeric type should be preserved.

setNumericType

public FieldSortBuilder setNumericType(String numericType)

Forces the numeric type to use for the field. The query will fail if this option is set on a field that is not mapped as a numeric in some indices. Specifying a numeric type tells Elasticsearch what type the sort values should have, which is important for cross-index search, if a field does not have the same type on all indices. Allowed values are long, double, date and date_nanos.

getFormat

public String getFormat()

Returns the external format that is specified via setFormat(String)

setFormat

public FieldSortBuilder setFormat(String format)

Specifies a format specification that will be used to format the output value of this sort field. Currently, only "date" and "data_nanos" date types support this external format (i.e., date format).

toXContent

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

Throws:

IOException

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

Throws:

IOException

name

public String name()

Description copied from class: SortBuilder

The name or type of the sort

Specified by:

name in class SortBuilder<FieldSortBuilder>

canRewriteToMatchNone

public boolean canRewriteToMatchNone()

isBottomSortShardDisjoint

public boolean isBottomSortShardDisjoint(SearchExecutionContext context,
 SearchSortValuesAndFormats bottomSortValues)
                                  throws IOException

Returns whether some values of the given SearchExecutionContext.getIndexReader() are within the primary sort value provided in the bottomSortValues.

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

Throws:

IOException

hasPrimaryFieldSort

public static boolean hasPrimaryFieldSort(SearchSourceBuilder source)

Return true if the primary sort in the provided source is an instance of FieldSortBuilder.

getPrimaryFieldSortOrNull

public static FieldSortBuilder getPrimaryFieldSortOrNull(SearchSourceBuilder source)

Return the FieldSortBuilder if the primary sort in the provided source is an instance of this class, null otherwise.

getMinMaxOrNull

public static MinAndMax<?> getMinMaxOrNull(SearchExecutionContext context,
 FieldSortBuilder sortBuilder)
                                    throws IOException

Return the MinAndMax indexed value from the provided FieldSortBuilder or null if unknown. The value can be extracted on non-nested indexed mapped fields of type keyword, numeric or date, other fields and configurations return null.

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

fromXContent

public static FieldSortBuilder fromXContent(XContentParser parser,
 String fieldName)
                                     throws IOException

Creates a new FieldSortBuilder 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

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:

IOException

rewrite

public FieldSortBuilder 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

supportsParallelCollection

public boolean supportsParallelCollection()

Overrides:

supportsParallelCollection in class SortBuilder<FieldSortBuilder>