GeoDistanceFilter

java.lang.Object
- lumis.portal.bigdata.query.GeoDistanceFilter

All Implemented Interfaces:

ISearchQueryFilter
```
@StableMinor(version="14.0",
             sinceVersion="9.0")
public class GeoDistanceFilter
extends Object
implements ISearchQueryFilter
```
Filter that filter documents by their distance to a given center 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.
Only the documents which distance is equal to or less than the given distance will be matched.

Since:

9.0.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

Constructor Summary

Constructors
Constructor Description

GeoDistanceFilter(DocumentTypeField field, GeoPoint pin, Distance distance)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Distance`	`getDistance()`	Returns the distance.
`DocumentTypeField`	`getField()`	Returns the field.
`GeoPoint`	`getPin()`	Returns the pin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GeoDistanceFilter
```
public GeoDistanceFilter(DocumentTypeField field,
                         GeoPoint pin,
                         Distance distance)
```
    Creates a new instance.
    
    Parameters:
    
    field - the field.
    
    pin - the point from which the distance will be calculated.
    
    distance - the maximum distance.
    
    Since:
    
    9.0.0
- Method Detail
  - getField
```
public DocumentTypeField getField()
```
    Returns the field.
    
    Returns:
    
    the field
    
    Since:
    
    9.0.0
  - getPin
```
public GeoPoint getPin()
```
    Returns the pin.
    
    Returns:
    
    the pin
    
    Since:
    
    9.0.0
  - getDistance
```
public Distance getDistance()
```
    Returns the distance.
    
    Returns:
    
    the distance
    
    Since:
    
    9.0.0