org.elasticsearch.search.sort

Class GeoDistanceSortBuilder

java.lang.Object

org.elasticsearch.search.sort.SortBuilder

org.elasticsearch.search.sort.GeoDistanceSortBuilder

All Implemented Interfaces:

ToXContent

public class GeoDistanceSortBuilder
extends SortBuilder

A geo distance based sorting on a geo point like 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
GeoDistanceSortBuilder(String fieldName) Constructs a new distance based sort on a geo point like field.

Method Summary

Methods

Modifier and Type	Method and Description
GeoDistanceSortBuilder	coerce(boolean coerce)
GeoDistanceSortBuilder	geoDistance(GeoDistance geoDistance) The geo distance type used to compute the distance.
GeoDistanceSortBuilder	geohashes(String... geohashes) The geohash of the geo point to create the range distance facets from.
GeoDistanceSortBuilder	ignoreMalformed(boolean ignoreMalformed)
SortBuilder	missing(Object missing) Not relevant.
GeoDistanceSortBuilder	order(SortOrder order) The order of sorting.
GeoDistanceSortBuilder	point(double lat, double lon) The point to create the range distance facets from.
GeoDistanceSortBuilder	points(GeoPoint... points) The point to create the range distance facets from.
GeoDistanceSortBuilder	setNestedFilter(QueryBuilder nestedFilter) Sets the nested filter that the nested objects should match with in order to be taken into account for sorting.
GeoDistanceSortBuilder	setNestedPath(String nestedPath) Sets the nested path if sorting occurs on a field that is inside a nested object.
GeoDistanceSortBuilder	sortMode(String sortMode) Defines which distance to use for sorting in the case a document contains multiple geo points.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
GeoDistanceSortBuilder	unit(DistanceUnit unit) The distance unit to use.

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

GeoDistanceSortBuilder

public GeoDistanceSortBuilder(String fieldName)

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

Parameters:

fieldName - The geo point like field name.

Method Detail

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.

geohashes

public GeoDistanceSortBuilder geohashes(String... geohashes)

The geohash of the geo point to create the range distance facets from.

geoDistance

public GeoDistanceSortBuilder geoDistance(GeoDistance geoDistance)

The geo distance type used to compute the distance.

unit

public GeoDistanceSortBuilder unit(DistanceUnit unit)

The distance unit to use. Defaults to DistanceUnit.KILOMETERS

order

public GeoDistanceSortBuilder order(SortOrder order)

The order of sorting. Defaults to SortOrder.ASC.

Specified by:

order in class SortBuilder

missing

public SortBuilder missing(Object missing)

Not relevant.

Specified by:

missing in class SortBuilder

sortMode

public GeoDistanceSortBuilder sortMode(String sortMode)

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

setNestedFilter

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

coerce

public GeoDistanceSortBuilder coerce(boolean coerce)

ignoreMalformed

public GeoDistanceSortBuilder ignoreMalformed(boolean ignoreMalformed)

toXContent

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

Throws:

IOException