org.hibernate.search.spatial.impl

Class DistanceQuery

java.lang.Object

org.apache.lucene.search.Query

org.hibernate.search.spatial.impl.DistanceQuery

All Implemented Interfaces:

Cloneable

public final class DistanceQuery
extends org.apache.lucene.search.Query

Lucene distance Query for documents which have been indexed with SpatialFieldBridgeByRange Use double lat,long field in the index from a Coordinates field declaration

Author:

Nicolas Helleringer

See Also:

SpatialFieldBridgeByHash, SpatialFieldBridgeByRange, Coordinates

Constructor Summary

Constructors

Constructor and Description
DistanceQuery(org.apache.lucene.search.Query approximationQuery, Coordinates centerCoordinates, double radius, String coordinatesField) Construct a distance query to match document distant at most of radius from center Point
DistanceQuery(org.apache.lucene.search.Query approximationQuery, Coordinates centerCoordinates, double radius, String latitudeField, String longitudeField) Construct a distance query to match document distant at most of radius from center Point

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Weight	createWeight(org.apache.lucene.search.IndexSearcher searcher, boolean needsScores)
boolean	equals(Object obj)
org.apache.lucene.search.Query	getApproximationQuery()
Point	getCenter()
String	getCoordinatesField()
double	getRadius()
int	hashCode()
org.apache.lucene.search.Query	rewrite(org.apache.lucene.index.IndexReader reader)
String	toString(String field)

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

clone, getBoost, setBoost, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DistanceQuery

public DistanceQuery(org.apache.lucene.search.Query approximationQuery,
                     Coordinates centerCoordinates,
                     double radius,
                     String coordinatesField)

Construct a distance query to match document distant at most of radius from center Point

Parameters:

approximationQuery - an approximation for this distance query (i.e. a query that produces no false-negatives, but may produce false-positives), or null. If non-null, only documents returned by the approximation query will be considered, which will enhance performance.

centerCoordinates - center of the search perimeter

radius - radius of the search perimeter

coordinatesField - name of the field implementing Coordinates

See Also:

Coordinates

DistanceQuery

public DistanceQuery(org.apache.lucene.search.Query approximationQuery,
                     Coordinates centerCoordinates,
                     double radius,
                     String latitudeField,
                     String longitudeField)

Construct a distance query to match document distant at most of radius from center Point

Parameters:

approximationQuery - an approximation for this distance query (i.e. a query that produces no false-negatives, but may produce false-positives), or null. If non-null, only documents returned by the approximation query will be considered, which will enhance performance.

centerCoordinates - center of the search perimeter

radius - radius of the search perimeter

latitudeField - name of the field hosting latitude

longitudeField - name of the field hosting longitude

See Also:

Coordinates

Method Detail

rewrite

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

Overrides:

rewrite in class org.apache.lucene.search.Query

Throws:

IOException

createWeight

public org.apache.lucene.search.Weight createWeight(org.apache.lucene.search.IndexSearcher searcher,
                                                    boolean needsScores)
                                             throws IOException

Overrides:

createWeight in class org.apache.lucene.search.Query

Throws:

IOException

getCoordinatesField

public String getCoordinatesField()

getRadius

public double getRadius()

getCenter

public Point getCenter()

getApproximationQuery

public org.apache.lucene.search.Query getApproximationQuery()

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.lucene.search.Query

equals

public boolean equals(Object obj)

Overrides:

equals in class org.apache.lucene.search.Query

toString

public String toString(String field)

Specified by:

toString in class org.apache.lucene.search.Query