com.stratio.cassandra.lucene.search.condition.GeoDistanceCondition Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2014 Stratio (http://stratio.com)
*
* Licensed 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 com.stratio.cassandra.lucene.search.condition;
import com.google.common.base.MoreObjects;
import com.spatial4j.core.distance.DistanceUtils;
import com.spatial4j.core.shape.Circle;
import com.stratio.cassandra.lucene.IndexException;
import com.stratio.cassandra.lucene.common.GeoDistance;
import com.stratio.cassandra.lucene.common.GeoDistanceUnit;
import com.stratio.cassandra.lucene.common.GeospatialUtils;
import com.stratio.cassandra.lucene.schema.mapping.GeoPointMapper;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.Query;
import org.apache.lucene.spatial.SpatialStrategy;
import org.apache.lucene.spatial.query.SpatialArgs;
import org.apache.lucene.spatial.query.SpatialOperation;
import static com.stratio.cassandra.lucene.common.GeospatialUtils.CONTEXT;
import static org.apache.lucene.search.BooleanClause.Occur.FILTER;
import static org.apache.lucene.search.BooleanClause.Occur.MUST_NOT;
/**
* A {@link Condition} that matches documents containing a shape contained between two certain circles.
*
* @author Andres de la Pena {@literal }
*/
public class GeoDistanceCondition extends SingleMapperCondition {
/** The latitude of the reference point. */
public final double latitude;
/** The longitude of the reference point. */
public final double longitude;
/** The min allowed distance. */
public final GeoDistance minGeoDistance;
/** The max allowed distance. */
public final GeoDistance maxGeoDistance;
/**
* Constructor using the field name and the value to be matched.
*
* @param boost The boost for this query clause. Documents matching this clause will (in addition to the normal
* weightings) have their score multiplied by {@code boost}.
* @param field the name of the field to be matched
* @param latitude the latitude of the reference point
* @param longitude the longitude of the reference point
* @param minGeoDistance the min allowed distance
* @param maxGeoDistance the max allowed distance
*/
public GeoDistanceCondition(Float boost,
String field,
Double latitude,
Double longitude,
GeoDistance minGeoDistance,
GeoDistance maxGeoDistance) {
super(boost, field, GeoPointMapper.class);
this.latitude = GeospatialUtils.checkLatitude("latitude", latitude);
this.longitude = GeospatialUtils.checkLongitude("longitude", longitude);
if (maxGeoDistance == null) {
throw new IndexException("max_distance must be provided");
}
this.maxGeoDistance = maxGeoDistance;
this.minGeoDistance = minGeoDistance;
if (minGeoDistance != null && minGeoDistance.compareTo(maxGeoDistance) >= 0) {
throw new IndexException("min_distance must be lower than max_distance");
}
}
/** {@inheritDoc} */
@Override
public Query doQuery(GeoPointMapper mapper, Analyzer analyzer) {
SpatialStrategy spatialStrategy = mapper.strategy;
BooleanQuery.Builder builder = new BooleanQuery.Builder();
builder.add(query(maxGeoDistance, spatialStrategy), FILTER);
if (minGeoDistance != null) {
builder.add(query(minGeoDistance, spatialStrategy), MUST_NOT);
}
return builder.build();
}
private Query query(GeoDistance geoDistance, SpatialStrategy spatialStrategy) {
double kms = geoDistance.getValue(GeoDistanceUnit.KILOMETRES);
double distance = DistanceUtils.dist2Degrees(kms, DistanceUtils.EARTH_MEAN_RADIUS_KM);
Circle circle = CONTEXT.makeCircle(longitude, latitude, distance);
SpatialArgs args = new SpatialArgs(SpatialOperation.Intersects, circle);
return spatialStrategy.makeQuery(args);
}
/** {@inheritDoc} */
@Override
public MoreObjects.ToStringHelper toStringHelper() {
return toStringHelper(this).add("latitude", latitude)
.add("longitude", longitude)
.add("minGeoDistance", minGeoDistance)
.add("maxGeoDistance", maxGeoDistance);
}
}