GeoLocationSort (Enterprise Search Java Client 0.0.2 API)

java.lang.Object
- co.elasticsearch.enterprisesearch.client.model.request.search.GeoLocationSort

All Implemented Interfaces:: SortOrder

public class GeoLocationSort
extends Object
implements SortOrder

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GeoLocationSort.Mode

Constructor Summary

Constructors
Constructor Description

GeoLocationSort(GeoLocation geoLocation)

Method Summary

All Methods Instance Methods Concrete Methods
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()`
`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)
```
- Method Detail
  - getOrder
```
public Sort.Order getOrder()
```
    Specified by:
    
    getOrder in interface SortOrder
  - 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.