Skip to content

Commit

Permalink
Query DSL: Geo Distance Range filter, closes #856.
Browse files Browse the repository at this point in the history
  • Loading branch information
kimchy committed Apr 14, 2011
1 parent 7874291 commit 7c38f20
Show file tree
Hide file tree
Showing 6 changed files with 579 additions and 0 deletions.
Expand Up @@ -258,6 +258,7 @@ private static class DefaultQueryProcessors extends QueryParsersProcessor {
bindings.processXContentQueryFilter(PrefixFilterParser.NAME, PrefixFilterParser.class);
bindings.processXContentQueryFilter(ScriptFilterParser.NAME, ScriptFilterParser.class);
bindings.processXContentQueryFilter(GeoDistanceFilterParser.NAME, GeoDistanceFilterParser.class);
bindings.processXContentQueryFilter(GeoDistanceRangeFilterParser.NAME, GeoDistanceRangeFilterParser.class);
bindings.processXContentQueryFilter(GeoBoundingBoxFilterParser.NAME, GeoBoundingBoxFilterParser.class);
bindings.processXContentQueryFilter(GeoPolygonFilterParser.NAME, GeoPolygonFilterParser.class);
bindings.processXContentQueryFilter(QueryFilterParser.NAME, QueryFilterParser.class);
Expand Down
Expand Up @@ -270,6 +270,15 @@ public static GeoDistanceFilterBuilder geoDistanceFilter(String name) {
return new GeoDistanceFilterBuilder(name);
}

/**
* A filter to filter based on a specific range from a specific geo location / point.
*
* @param name The location field name.
*/
public static GeoDistanceRangeFilterBuilder geoDistanceRangeFilter(String name) {
return new GeoDistanceRangeFilterBuilder(name);
}

/**
* A filter to filter based on a bounding box defined by top left and bottom right locations / points
*
Expand Down
@@ -0,0 +1,163 @@
/*
* Licensed to Elastic Search and Shay Banon under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. Elastic Search licenses this
* file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.elasticsearch.index.query.xcontent;

import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.index.search.geo.GeoDistance;

import java.io.IOException;

/**
* @author kimchy (shay.banon)
*/
public class GeoDistanceRangeFilterBuilder extends BaseFilterBuilder {

private final String name;

private Object from;
private Object to;
private boolean includeLower = true;
private boolean includeUpper = true;

private double lat;

private double lon;

private String geohash;

private GeoDistance geoDistance;

private Boolean cache;

private String filterName;

public GeoDistanceRangeFilterBuilder(String name) {
this.name = name;
}

public GeoDistanceRangeFilterBuilder point(double lat, double lon) {
this.lat = lat;
this.lon = lon;
return this;
}

public GeoDistanceRangeFilterBuilder lat(double lat) {
this.lat = lat;
return this;
}

public GeoDistanceRangeFilterBuilder lon(double lon) {
this.lon = lon;
return this;
}

public GeoDistanceRangeFilterBuilder from(Object from) {
this.from = from;
return this;
}

public GeoDistanceRangeFilterBuilder to(Object to) {
this.to = to;
return this;
}

public GeoDistanceRangeFilterBuilder gt(Object from) {
this.from = from;
this.includeLower = false;
return this;
}

public GeoDistanceRangeFilterBuilder gte(Object from) {
this.from = from;
this.includeLower = true;
return this;
}

public GeoDistanceRangeFilterBuilder lt(Object to) {
this.to = to;
this.includeUpper = false;
return this;
}

public GeoDistanceRangeFilterBuilder lte(Object to) {
this.to = to;
this.includeUpper = true;
return this;
}

public GeoDistanceRangeFilterBuilder includeLower(boolean includeLower) {
this.includeLower = includeLower;
return this;
}

public GeoDistanceRangeFilterBuilder includeUpper(boolean includeUpper) {
this.includeUpper = includeUpper;
return this;
}

public GeoDistanceRangeFilterBuilder geohash(String geohash) {
this.geohash = geohash;
return this;
}

public GeoDistanceRangeFilterBuilder geoDistance(GeoDistance geoDistance) {
this.geoDistance = geoDistance;
return this;
}

/**
* Sets the filter name for the filter that can be used when searching for matched_filters per hit.
*/
public GeoDistanceRangeFilterBuilder filterName(String filterName) {
this.filterName = filterName;
return this;
}

/**
* Should the filter be cached or not. Defaults to <tt>false</tt>.
*/
public GeoDistanceRangeFilterBuilder cache(boolean cache) {
this.cache = cache;
return this;
}

@Override protected void doXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject(GeoDistanceRangeFilterParser.NAME);
if (geohash != null) {
builder.field(name, geohash);
} else {
builder.startArray(name).value(lon).value(lat).endArray();
}
builder.field("from", from);
builder.field("to", to);
builder.field("include_lower", includeLower);
builder.field("include_upper", includeUpper);
if (geoDistance != null) {
builder.field("distance_type", geoDistance.name().toLowerCase());
}
if (filterName != null) {
builder.field("_name", filterName);
}
if (cache != null) {
builder.field("_cache", cache);
}
builder.endObject();
}
}

0 comments on commit 7c38f20

Please sign in to comment.