org.apache.lucene.search

Class GeoPointInPolygonQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.MultiTermQuery

org.apache.lucene.search.GeoPointInPolygonQuery

All Implemented Interfaces:

Cloneable

public final class GeoPointInPolygonQuery
extends MultiTermQuery

Implements a simple point in polygon query on a GeoPoint field. This is based on GeoPointInBBoxQueryImpl and is implemented using a three phase approach. First, like GeoPointInBBoxQueryImpl candidate terms are queried using a numeric range based on the morton codes of the min and max lat/lon pairs. Terms passing this initial filter are passed to a secondary filter that verifies whether the decoded lat/lon point falls within (or on the boundary) of the bounding box query. Finally, the remaining candidate term is passed to the final point in polygon check. All value comparisons are subject to the same precision tolerance defined in 1.0E-6 NOTES: 1. The polygon coordinates need to be in either clockwise or counter-clockwise order. 2. The polygon must not be self-crossing, otherwise the query may result in unexpected behavior 3. All latitude/longitude values must be in decimal degrees. 4. Complex computational geometry (e.g., dateline wrapping, polygon with holes) is not supported 5. For more advanced GeoSpatial indexing and query operations see spatial module

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.MultiTermQuery

MultiTermQuery.RewriteMethod, MultiTermQuery.TopTermsBlendedFreqScoringRewrite, MultiTermQuery.TopTermsBoostOnlyBooleanQueryRewrite, MultiTermQuery.TopTermsScoringBooleanQueryRewrite

Field Summary

Fields

Modifier and Type	Field and Description
static MultiTermQuery.RewriteMethod	GEO_CONSTANT_SCORE_REWRITE
protected double	maxLat
protected double	maxLon
protected double	minLat
protected double	minLon

Fields inherited from class org.apache.lucene.search.MultiTermQuery

CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE, CONSTANT_SCORE_BOOLEAN_REWRITE, CONSTANT_SCORE_FILTER_REWRITE, CONSTANT_SCORE_REWRITE, field, rewriteMethod, SCORING_BOOLEAN_QUERY_REWRITE, SCORING_BOOLEAN_REWRITE

Constructor Summary

Constructors

Constructor and Description
GeoPointInPolygonQuery(String field, double[] polyLons, double[] polyLats) Constructs a new GeoPolygonQuery that will match encoded GeoPointField terms that fall within or on the boundary of the polygon defined by the input parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
double[]	getLats() API utility method for returning the array of latitudinal values for this GeoPolygon The returned array is not a copy so do not change it!
double[]	getLons() API utility method for returning the array of longitudinal values for this GeoPolygon The returned array is not a copy so do not change it!
protected TermsEnum	getTermsEnum(Terms terms, AttributeSource atts)
int	hashCode()
void	setRewriteMethod(MultiTermQuery.RewriteMethod method)
String	toString(String field)

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

getField, getRewriteMethod, getTermsEnum, rewrite

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

clone, createWeight, getBoost, setBoost, toString

Methods inherited from class java.lang.Object

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

Field Detail

minLon

protected final double minLon

minLat

protected final double minLat

maxLon

protected final double maxLon

maxLat

protected final double maxLat

GEO_CONSTANT_SCORE_REWRITE

public static final MultiTermQuery.RewriteMethod GEO_CONSTANT_SCORE_REWRITE

Constructor Detail

GeoPointInPolygonQuery

public GeoPointInPolygonQuery(String field,
                      double[] polyLons,
                      double[] polyLats)

Constructs a new GeoPolygonQuery that will match encoded GeoPointField terms that fall within or on the boundary of the polygon defined by the input parameters.

Method Detail

getTermsEnum

protected TermsEnum getTermsEnum(Terms terms,
                     AttributeSource atts)
                          throws IOException

Throws:

IOException

setRewriteMethod

public void setRewriteMethod(MultiTermQuery.RewriteMethod method)

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString(String field)

getLons

public double[] getLons()

API utility method for returning the array of longitudinal values for this GeoPolygon The returned array is not a copy so do not change it!

getLats

public double[] getLats()

API utility method for returning the array of latitudinal values for this GeoPolygon The returned array is not a copy so do not change it!