Package lumis.portal.bigdata.query

Class GeoDistanceSearchQuerySort

java.lang.Object

lumis.portal.bigdata.query.SearchQuerySort

lumis.portal.bigdata.query.GeoDistanceSearchQuerySort

All Implemented Interfaces:

ISearchQuerySort

@StableMinor(version="17.0",
             sinceVersion="9.0")
public class GeoDistanceSearchQuerySort
extends SearchQuerySort

Sort documents by the distance to a given point.

The given field will be used to calculate the geo distance to the given point. Thus, the given field must be of the data type DocumentTypeField.DataType.GEO_POINT.

If the given field is a list, the closest point to the given point will be considered.

Since:

9.0.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested classes/interfaces inherited from class lumis.portal.bigdata.query.SearchQuerySort

SearchQuerySort.Order

Constructor Summary

Constructors

Constructor	Description
GeoDistanceSearchQuerySort(DocumentTypeField field, GeoPoint pin, SearchQuerySort.Order order)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
DocumentTypeField	getField()	Returns the field.
GeoPoint	getPin()	Returns the pin.

Methods inherited from class lumis.portal.bigdata.query.SearchQuerySort

getFieldId, getOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoDistanceSearchQuerySort

public GeoDistanceSearchQuerySort(DocumentTypeField field,
                                  GeoPoint pin,
                                  SearchQuerySort.Order order)

Creates a new instance.

Parameters:

field - the field to be used to calculate the geo distance to the given point.

pin - the point.

order - the order.

Since:

9.0.0

Method Detail

getPin

public GeoPoint getPin()

Returns the pin.

Returns:

the pin

Since:

9.0.0

getField

public DocumentTypeField getField()

Returns the field.

Returns:

the field

Since:

9.0.0