Package org.elasticsearch.search.sort

Class SortBuilder<T extends SortBuilder<T>>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FieldSortBuilder, GeoDistanceSortBuilder, ScoreSortBuilder, ScriptSortBuilder

public abstract class SortBuilder<T extends SortBuilder<T>>
extends Object
implements NamedWriteable, org.elasticsearch.xcontent.ToXContentObject, Rewriteable<SortBuilder<?>>

Nested Class Summary

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 org.elasticsearch.xcontent.ParseField	NESTED_FILTER_FIELD
static final org.elasticsearch.xcontent.ParseField	NESTED_PATH_FIELD
protected SortOrder	order
static final org.elasticsearch.xcontent.ParseField	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
SortBuilder()

Method Summary

Modifier and Type	Method	Description
protected abstract SortFieldAndFormat	build(SearchExecutionContext context)	Create a SortFieldAndFormat from this builder.
abstract BucketedSort	buildBucketedSort(SearchExecutionContext context, BigArrays bigArrays, int bucketSize, BucketedSort.ExtraData extra)	Create a BucketedSort which is useful for sorting inside of aggregations.
static Optional<SortAndFormats>	buildSort(List<SortBuilder<?>> sortBuilders, SearchExecutionContext context)
static List<SortBuilder<?>>	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
SortOrder	order()	Return the SortOrder used for this SortBuilder.
T	order(SortOrder order)	Set the order of sorting.
protected static QueryBuilder	parseNestedFilter(org.elasticsearch.xcontent.XContentParser parser)
protected static IndexFieldData.XFieldComparatorSource.Nested	resolveNested(SearchExecutionContext context, String nestedPath, QueryBuilder nestedFilter)
protected static IndexFieldData.XFieldComparatorSource.Nested	resolveNested(SearchExecutionContext context, NestedSortBuilder nestedSort)
String	toString()

Methods inherited from class java.lang.Object

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

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

getWriteableName

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

rewrite

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

writeTo

Field Details

order

protected SortOrder order

ORDER_FIELD

public static final org.elasticsearch.xcontent.ParseField ORDER_FIELD

NESTED_FILTER_FIELD

public static final org.elasticsearch.xcontent.ParseField NESTED_FILTER_FIELD

NESTED_PATH_FIELD

public static final org.elasticsearch.xcontent.ParseField NESTED_PATH_FIELD

Constructor Details

SortBuilder

public SortBuilder()

Method Details

build

protected abstract SortFieldAndFormat build(SearchExecutionContext context)
                                     throws IOException

Create a SortFieldAndFormat from this builder.

Throws:

IOException

buildBucketedSort

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

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

Throws:

IOException

order

public T order(SortOrder order)

Set the order of sorting.

order

public SortOrder order()

Return the SortOrder used for this SortBuilder.

fromXContent

public static List<SortBuilder<?>> fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                                         throws IOException

Throws:

IOException

buildSort

public static Optional<SortAndFormats> buildSort(List<SortBuilder<?>> sortBuilders,
 SearchExecutionContext context)
                                          throws IOException

Throws:

IOException

resolveNested

protected static IndexFieldData.XFieldComparatorSource.Nested resolveNested(SearchExecutionContext context,
 String nestedPath,
 QueryBuilder nestedFilter)
                                                                     throws IOException

Throws:

IOException

resolveNested

protected static IndexFieldData.XFieldComparatorSource.Nested resolveNested(SearchExecutionContext context,
 NestedSortBuilder nestedSort)
                                                                     throws IOException

Throws:

IOException

parseNestedFilter

protected static QueryBuilder parseNestedFilter(org.elasticsearch.xcontent.XContentParser parser)

toString

public String toString()

Overrides:

toString in class Object