Package org.springframework.data.elasticsearch.core.query

Class GeoDistanceOrder

java.lang.Object

org.springframework.data.domain.Sort.Order

org.springframework.data.elasticsearch.core.query.Order

org.springframework.data.elasticsearch.core.query.GeoDistanceOrder

All Implemented Interfaces:

Serializable

public class GeoDistanceOrder
extends Order

Sort.Order derived class to be able to define a _geo_distance order for a search.

Since:

4.0

Author:

Peter-Josef Meisch

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GeoDistanceOrder.DistanceType

Nested classes/interfaces inherited from class org.springframework.data.elasticsearch.core.query.Order

Order.Mode

Field Summary

Fields

Modifier and Type	Field	Description
static final GeoDistanceOrder.DistanceType	DEFAULT_DISTANCE_TYPE
static final Boolean	DEFAULT_IGNORE_UNMAPPED
static final String	DEFAULT_UNIT

Fields inherited from class org.springframework.data.elasticsearch.core.query.Order

DEFAULT_MODE, DEFAULT_NULL_HANDLING, mode, unmappedType

Constructor Summary

Constructors

Constructor	Description
GeoDistanceOrder(String property, GeoPoint geoPoint)

Method Summary

Modifier and Type	Method	Description
GeoDistanceOrder.DistanceType	getDistanceType()
GeoPoint	getGeoPoint()
Boolean	getIgnoreUnmapped()
Order.Mode	getMode()
String	getUnit()
String	toString()
GeoDistanceOrder	with(org.springframework.data.domain.Sort.Direction direction)
GeoDistanceOrder	with(org.springframework.data.domain.Sort.NullHandling nullHandling)
GeoDistanceOrder	with(GeoDistanceOrder.DistanceType distanceType)
GeoDistanceOrder	with(Order.Mode mode)
GeoDistanceOrder	withIgnoreUnmapped(Boolean ignoreUnmapped)
GeoDistanceOrder	withProperty(String property)
GeoDistanceOrder	withUnit(String unit)

Methods inherited from class org.springframework.data.elasticsearch.core.query.Order

getUnmappedType, withUnmappedType

Methods inherited from class org.springframework.data.domain.Sort.Order

asc, by, desc, equals, getDirection, getNullHandling, getProperty, hashCode, ignoreCase, isAscending, isDescending, isIgnoreCase, nullsFirst, nullsLast, nullsNative, reverse, withProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_DISTANCE_TYPE

public static final GeoDistanceOrder.DistanceType DEFAULT_DISTANCE_TYPE

DEFAULT_UNIT

public static final String DEFAULT_UNIT

See Also:

• Constant Field Values

DEFAULT_IGNORE_UNMAPPED

public static final Boolean DEFAULT_IGNORE_UNMAPPED

Constructor Details

GeoDistanceOrder

public GeoDistanceOrder(String property,
 GeoPoint geoPoint)

Method Details

getGeoPoint

public GeoPoint getGeoPoint()

getDistanceType

public GeoDistanceOrder.DistanceType getDistanceType()

getMode

public Order.Mode getMode()

Overrides:

getMode in class Order

getUnit

public String getUnit()

getIgnoreUnmapped

public Boolean getIgnoreUnmapped()

withProperty

public GeoDistanceOrder withProperty(String property)

Overrides:

withProperty in class Order

with

public GeoDistanceOrder with(org.springframework.data.domain.Sort.Direction direction)

Overrides:

with in class Order

with

public GeoDistanceOrder with(org.springframework.data.domain.Sort.NullHandling nullHandling)

Overrides:

with in class Order

with

public GeoDistanceOrder with(GeoDistanceOrder.DistanceType distanceType)

with

public GeoDistanceOrder with(Order.Mode mode)

Overrides:

with in class Order

withUnit

public GeoDistanceOrder withUnit(String unit)

withIgnoreUnmapped

public GeoDistanceOrder withIgnoreUnmapped(Boolean ignoreUnmapped)

toString

public String toString()

Overrides:

toString in class org.springframework.data.domain.Sort.Order