java.lang.Object
- org.elasticsearch.search.sort.SortBuilder<GeoDistanceSortBuilder>
- - org.elasticsearch.search.sort.GeoDistanceSortBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, 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.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type Field Description

static String ALTERNATIVE_NAME

static GeoValidationMethod DEFAULT_VALIDATION

static String NAME
- Fields inherited from class org.elasticsearch.search.sort.SortBuilder
  NESTED_FILTER_FIELD, NESTED_PATH_FIELD, order, ORDER_FIELD
- Fields inherited from interface org.elasticsearch.index.query.Rewriteable
  MAX_REWRITE_ROUNDS
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Constructor Summary

Constructors
Constructor	Description
`GeoDistanceSortBuilder(String fieldName, double lat, double lon)`	Constructs a new distance based sort on a geo point like field.
`GeoDistanceSortBuilder(String fieldName, String... geohashes)`	Constructs a new distance based sort on a geo point like field.
`GeoDistanceSortBuilder(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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`SortFieldAndFormat`	`build(QueryShardContext context)`	Create a @link `SortFieldAndFormat` from this builder.
`boolean`	`equals(Object object)`
`String`	`fieldName()`	Returns the geo point like field the distance based sort operates on.
`static GeoDistanceSortBuilder`	`fromXContent(XContentParser parser, 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()`
`String`	`getNestedPath()`	Deprecated. set nested sort with `setNestedSort(NestedSortBuilder)` and retrieve with `getNestedSort()`
`NestedSortBuilder`	`getNestedSort()`	Returns the `NestedSortBuilder`
`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(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.
`XContentBuilder`	`toXContent(XContentBuilder builder, 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.elasticsearch.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.elasticsearch.common.xcontent.ToXContentObject
isFragment

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - ALTERNATIVE_NAME
```
public static final String ALTERNATIVE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_VALIDATION
```
public static final GeoValidationMethod DEFAULT_VALIDATION
```
- Constructor Detail
  - GeoDistanceSortBuilder
```
public GeoDistanceSortBuilder(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(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(String fieldName,
                              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 IOException
```
    Read from a stream.
    
    Throws:
    
    IOException
- Method Detail
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Description copied from interface: Writeable
    
    Write this into the StreamOutput.
    
    Throws:
    
    IOException
  - fieldName
```
public 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(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 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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    Throws:
    
    IOException
  - getWriteableName
```
public String getWriteableName()
```
    Description copied from interface: NamedWriteable
    
    Returns the name of the writeable object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - fromXContent
```
public static GeoDistanceSortBuilder fromXContent(XContentParser parser,
                                                  String elementName)
                                           throws 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:
    
    IOException
  - build
```
public SortFieldAndFormat build(QueryShardContext context)
                         throws IOException
```
    Description copied from class: SortBuilder
    
    Create a @link SortFieldAndFormat from this builder.
    
    Specified by:
    
    build in class SortBuilder<GeoDistanceSortBuilder>
    
    Throws:
    
    IOException
  - rewrite
```
public GeoDistanceSortBuilder rewrite(QueryRewriteContext ctx)
                               throws 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:
    
    IOException

Modifier and Type	Field	Description
`static String`	`ALTERNATIVE_NAME`
`static GeoValidationMethod`	`DEFAULT_VALIDATION`
`static String`	`NAME`

Class GeoDistanceSortBuilder

Nested Class Summary

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

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

Field Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.search.sort.SortBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

Field Detail

NAME

ALTERNATIVE_NAME

DEFAULT_VALIDATION

Constructor Detail

GeoDistanceSortBuilder

GeoDistanceSortBuilder

GeoDistanceSortBuilder

GeoDistanceSortBuilder

Method Detail

writeTo

fieldName

point

points

points

geoDistance

geoDistance

unit

unit

validation

validation

sortMode

sortMode

setNestedFilter

getNestedFilter

setNestedPath

getNestedPath

getNestedSort

setNestedSort

ignoreUnmapped

ignoreUnmapped

toXContent

getWriteableName

equals

hashCode

fromXContent

build

rewrite