org.apache.lucene.spatial.geopoint.search

Class XGeoPointDistanceRangeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.spatial.geopoint.search.GeoPointInBBoxQuery

org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery

org.apache.lucene.spatial.geopoint.search.XGeoPointDistanceRangeQuery

public final class XGeoPointDistanceRangeQuery
extends org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery

Implements a point distance range query on a GeoPoint field. This is based on org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery and is implemented using a org.apache.lucene.search.BooleanClause.MUST_NOT clause to exclude any points that fall within minRadiusMeters from the provided point.

NOTE: this query does not correctly support multi-value docs (see: https://issues.apache.org/jira/browse/LUCENE-7126)
TODO: remove this per ISSUE #17658

Field Summary

Fields

Modifier and Type	Field and Description
protected double	minRadiusMeters minimum distance range (in meters) from lat, lon center location, maximum is inherited

Fields inherited from class org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery

centerLat, centerLon, radiusMeters, sortKey

Fields inherited from class org.apache.lucene.spatial.geopoint.search.GeoPointInBBoxQuery

field, maxLat, maxLon, minLat, minLon, termEncoding

Constructor Summary

Constructors

Constructor and Description
XGeoPointDistanceRangeQuery(java.lang.String field, double centerLat, double centerLon, double minRadiusMeters, double maxRadiusMeters) Constructs a query for all GeoPointField types within a minimum / maximum distance (in meters) range from a given point
XGeoPointDistanceRangeQuery(java.lang.String field, org.apache.lucene.spatial.geopoint.document.GeoPointField.TermEncoding termEncoding, double centerLat, double centerLon, double minRadiusMeters, double maxRadius) Constructs a query for all GeoPointField types within a minimum / maximum distance (in meters) range from a given point.

Method Summary

Modifier and Type	Method and Description
double	getMaxRadiusMeters() getter method for maximum distance
double	getMinRadiusMeters() getter method for minimum distance
org.apache.lucene.search.Query	rewrite(org.apache.lucene.index.IndexReader reader)
java.lang.String	toString(java.lang.String field)

Methods inherited from class org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery

equals, getCenterLat, getCenterLon, getRadiusMeters, hashCode

Methods inherited from class org.apache.lucene.spatial.geopoint.search.GeoPointInBBoxQuery

getField, getMaxLat, getMaxLon, getMinLat, getMinLon

Methods inherited from class org.apache.lucene.search.Query

classHash, createWeight, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Field Detail

minRadiusMeters

protected final double minRadiusMeters

minimum distance range (in meters) from lat, lon center location, maximum is inherited

Constructor Detail

XGeoPointDistanceRangeQuery

public XGeoPointDistanceRangeQuery(java.lang.String field,
                                   double centerLat,
                                   double centerLon,
                                   double minRadiusMeters,
                                   double maxRadiusMeters)

Constructs a query for all GeoPointField types within a minimum / maximum distance (in meters) range from a given point

XGeoPointDistanceRangeQuery

public XGeoPointDistanceRangeQuery(java.lang.String field,
                                   org.apache.lucene.spatial.geopoint.document.GeoPointField.TermEncoding termEncoding,
                                   double centerLat,
                                   double centerLon,
                                   double minRadiusMeters,
                                   double maxRadius)

Constructs a query for all GeoPointField types within a minimum / maximum distance (in meters) range from a given point. Accepts an optional GeoPointField.TermEncoding

Method Detail

rewrite

public org.apache.lucene.search.Query rewrite(org.apache.lucene.index.IndexReader reader)

Overrides:

rewrite in class org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery

toString

public java.lang.String toString(java.lang.String field)

Overrides:

toString in class org.apache.lucene.spatial.geopoint.search.GeoPointDistanceQuery

getMinRadiusMeters

public double getMinRadiusMeters()

getter method for minimum distance

getMaxRadiusMeters

public double getMaxRadiusMeters()

getter method for maximum distance