Package org.opensearch.search.sort

Class GeoDistanceSortBuilder

java.lang.Object

org.opensearch.search.sort.SortBuilder<GeoDistanceSortBuilder>

org.opensearch.search.sort.GeoDistanceSortBuilder

All Implemented Interfaces:

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

public class GeoDistanceSortBuilder
extends SortBuilder<GeoDistanceSortBuilder>

A geo distance based sorting on a geo point like field.

Nested Class Summary

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALTERNATIVE_NAME
static GeoValidationMethod	DEFAULT_VALIDATION
static java.lang.String	NAME

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

NESTED_FILTER_FIELD, NESTED_PATH_FIELD, order, ORDER_FIELD

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

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoDistanceSortBuilder(java.lang.String fieldName, double lat, double lon)	Constructs a new distance based sort on a geo point like field.
GeoDistanceSortBuilder(java.lang.String fieldName, java.lang.String... geohashes)	Constructs a new distance based sort on a geo point like field.
GeoDistanceSortBuilder(java.lang.String fieldName, GeoPoint... points)	Constructs a new distance based sort on a geo point like field.
GeoDistanceSortBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
SortFieldAndFormat	build(QueryShardContext context)	Create a SortFieldAndFormat from this builder.
BucketedSort	buildBucketedSort(QueryShardContext context, int bucketSize, BucketedSort.ExtraData extra)	Create a BucketedSort which is useful for sorting inside of aggregations.
boolean	equals(java.lang.Object object)
java.lang.String	fieldName()	Returns the geo point like field the distance based sort operates on.
static GeoDistanceSortBuilder	fromXContent(org.opensearch.common.xcontent.XContentParser parser, java.lang.String elementName)	Creates a new GeoDistanceSortBuilder from the query held by the XContentParser in XContent format.
GeoDistance	geoDistance()	Returns the geo distance type used to compute the distance.
GeoDistanceSortBuilder	geoDistance(GeoDistance geoDistance)	The geo distance type used to compute the distance.
QueryBuilder	getNestedFilter()	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
java.lang.String	getNestedPath()	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
NestedSortBuilder	getNestedSort()	Returns the NestedSortBuilder
java.lang.String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
boolean	ignoreUnmapped()	Returns true if unmapped geo fields should be treated as located at an infinite distance
GeoDistanceSortBuilder	ignoreUnmapped(boolean ignoreUnmapped)
GeoDistanceSortBuilder	point(double lat, double lon)	The point to create the range distance facets from.
GeoPoint[]	points()	Returns the points to create the range distance facets from.
GeoDistanceSortBuilder	points(GeoPoint... points)	The point to create the range distance facets from.
GeoDistanceSortBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
GeoDistanceSortBuilder	setNestedFilter(QueryBuilder nestedFilter)	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
GeoDistanceSortBuilder	setNestedPath(java.lang.String nestedPath)	Deprecated. set nested sort with setNestedSort(NestedSortBuilder) and retrieve with getNestedSort()
GeoDistanceSortBuilder	setNestedSort(NestedSortBuilder nestedSort)	Sets the NestedSortBuilder to be used for fields that are inside a nested object.
SortMode	sortMode()	Returns which distance to use for sorting in the case a document contains multiple geo points.
GeoDistanceSortBuilder	sortMode(SortMode sortMode)	Defines which distance to use for sorting in the case a document contains multiple geo points.
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
DistanceUnit	unit()	Returns the distance unit to use.
GeoDistanceSortBuilder	unit(DistanceUnit unit)	The distance unit to use.
GeoValidationMethod	validation()	Returns the validation method to use for this sort builder.
GeoDistanceSortBuilder	validation(GeoValidationMethod method)	Sets validation method for this sort builder.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.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.opensearch.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

ALTERNATIVE_NAME

public static final java.lang.String ALTERNATIVE_NAME

See Also:

Constant Field Values

DEFAULT_VALIDATION

public static final GeoValidationMethod DEFAULT_VALIDATION

Constructor Details

GeoDistanceSortBuilder

public GeoDistanceSortBuilder(java.lang.String fieldName, GeoPoint... points)

Constructs a new distance based sort on a geo point like field.

Parameters:

fieldName - The geo point like field name.

points - The points to create the range distance facets from.

GeoDistanceSortBuilder

public GeoDistanceSortBuilder(java.lang.String fieldName, double lat, double lon)

Constructs a new distance based sort on a geo point like field.

Parameters:

fieldName - The geo point like field name.

lat - Latitude of the point to create the range distance facets from.

lon - Longitude of the point to create the range distance facets from.

GeoDistanceSortBuilder

public GeoDistanceSortBuilder(java.lang.String fieldName, java.lang.String... geohashes)

Constructs a new distance based sort on a geo point like field.

Parameters:

fieldName - The geo point like field name.

geohashes - The points to create the range distance facets from.

GeoDistanceSortBuilder

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

Read from a stream.

Throws:

java.io.IOException

Method Details

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

Returns the geo point like field the distance based sort operates on.

point

public GeoDistanceSortBuilder point(double lat, double lon)

The point to create the range distance facets from.

Parameters:

lat - latitude.

lon - longitude.

points

public GeoDistanceSortBuilder points(GeoPoint... points)

The point to create the range distance facets from.

Parameters:

points - reference points.

points

public GeoPoint[] points()

Returns the points to create the range distance facets from.

geoDistance

public GeoDistanceSortBuilder geoDistance(GeoDistance geoDistance)

The geo distance type used to compute the distance.

geoDistance

public GeoDistance geoDistance()

Returns the geo distance type used to compute the distance.

unit

public GeoDistanceSortBuilder unit(DistanceUnit unit)

The distance unit to use. Defaults to DistanceUnit.METERS

unit

public DistanceUnit unit()

Returns the distance unit to use. Defaults to DistanceUnit.METERS

validation

public GeoDistanceSortBuilder validation(GeoValidationMethod method)

Sets validation method for this sort builder.

validation

public GeoValidationMethod validation()

Returns the validation method to use for this sort builder.

sortMode

public GeoDistanceSortBuilder sortMode(SortMode sortMode)

Defines which distance to use for sorting in the case a document contains multiple geo points. Possible values: min and max

sortMode

public SortMode sortMode()

Returns which distance to use for sorting in the case a document contains multiple geo points.

setNestedFilter

@Deprecated public GeoDistanceSortBuilder 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()

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

setNestedPath

@Deprecated public GeoDistanceSortBuilder setNestedPath(java.lang.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. By default when sorting on a field inside a nested object, the nearest upper nested object is selected as nested path.

getNestedPath

@Deprecated public java.lang.String getNestedPath()

Deprecated.

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

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

getNestedSort

public NestedSortBuilder getNestedSort()

Returns the NestedSortBuilder

setNestedSort

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

ignoreUnmapped

public boolean ignoreUnmapped()

Returns true if unmapped geo fields should be treated as located at an infinite distance

ignoreUnmapped

public GeoDistanceSortBuilder ignoreUnmapped(boolean ignoreUnmapped)

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromXContent

public static GeoDistanceSortBuilder fromXContent(org.opensearch.common.xcontent.XContentParser parser, java.lang.String elementName) throws java.io.IOException

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

Throws:

java.io.IOException

build

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

Description copied from class: SortBuilder

Create a SortFieldAndFormat from this builder.

Specified by:

build in class SortBuilder<GeoDistanceSortBuilder>

Throws:

java.io.IOException

buildBucketedSort

public BucketedSort buildBucketedSort(QueryShardContext context, int bucketSize, BucketedSort.ExtraData extra) throws java.io.IOException

Description copied from class: SortBuilder

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

Specified by:

buildBucketedSort in class SortBuilder<GeoDistanceSortBuilder>

Throws:

java.io.IOException

rewrite

public GeoDistanceSortBuilder rewrite(QueryRewriteContext ctx) throws java.io.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:

java.io.IOException