public class GeoDistanceSortBuilder extends SortBuilder
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
EMPTY_PARAMS
Constructor and Description |
---|
GeoDistanceSortBuilder(String fieldName)
Constructs a new distance based sort on a geo point like field.
|
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.
|
toString
public GeoDistanceSortBuilder(String fieldName)
fieldName
- The geo point like field name.public GeoDistanceSortBuilder point(double lat, double lon)
lat
- latitude.lon
- longitude.public GeoDistanceSortBuilder points(GeoPoint... points)
points
- reference points.public GeoDistanceSortBuilder geohashes(String... geohashes)
public GeoDistanceSortBuilder geoDistance(GeoDistance geoDistance)
public GeoDistanceSortBuilder unit(DistanceUnit unit)
DistanceUnit.KILOMETERS
public GeoDistanceSortBuilder order(SortOrder order)
SortOrder.ASC
.order
in class SortBuilder
public SortBuilder missing(Object missing)
missing
in class SortBuilder
public GeoDistanceSortBuilder sortMode(String sortMode)
public GeoDistanceSortBuilder setNestedFilter(QueryBuilder nestedFilter)
public GeoDistanceSortBuilder setNestedPath(String nestedPath)
public GeoDistanceSortBuilder coerce(boolean coerce)
public GeoDistanceSortBuilder ignoreMalformed(boolean ignoreMalformed)
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
IOException
Copyright © 2009–2017. All rights reserved.