Package co.elasticsearch.enterprisesearch.client.model.request.search

Class GeolocationSort

java.lang.Object

co.elasticsearch.enterprisesearch.client.model.request.search.GeolocationSort

All Implemented Interfaces:

SortOrder

public class GeolocationSort
extends Object
implements SortOrder

Represents a Geolocation Sort in a search request

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeolocationSort.Mode	How to calculate distance in case a field has several geo points.

Constructor Summary

Constructors

Constructor	Description
GeolocationSort(Geolocation geoLocation)	Build a GeolocationSort from a central point

Method Summary

Modifier and Type	Method	Description
Geolocation	getCenter()	Center point will be used to calculate the distance from that point to the field in each document, and return the results ordered by distance.
GeolocationSort.Mode	getMode()	How to calculate distance in case a field has several geo points.
Sort.Order	getOrder()	Gets the sort order
GeolocationSort	setMode(GeolocationSort.Mode mode)	How to calculate distance in case a field has several geo points.
GeolocationSort	setOrder(Sort.Order order)	The sort order

Methods inherited from class java.lang.Object

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

Constructor Detail

GeolocationSort

public GeolocationSort(Geolocation geoLocation)

Build a GeolocationSort from a central point

Parameters:

geoLocation - the centeral geolocation point

Method Detail

getOrder

public Sort.Order getOrder()

Description copied from interface: SortOrder

Gets the sort order

Specified by:

getOrder in interface SortOrder

Returns:

The sort order

getCenter

public Geolocation getCenter()

Center point will be used to calculate the distance from that point to the field in each document, and return the results ordered by distance. Center point can be specified using any of the geolocation field formats, see geolocation fields.

Returns:

the center

getMode

public GeolocationSort.Mode getMode()

How to calculate distance in case a field has several geo points. By default, the shortest distance is taken into account when sorting in ascending order and the longest distance when sorting in descending order.

Returns:

the sort mode

setMode

public GeolocationSort setMode(GeolocationSort.Mode mode)

How to calculate distance in case a field has several geo points. By default, the shortest distance is taken into account when sorting in ascending order and the longest distance when sorting in descending order.

Parameters:

mode - the sort mode

Returns:

this.

setOrder

public GeolocationSort setOrder(Sort.Order order)

The sort order

Parameters:

order - the sort order

Returns:

this.