com.stratio.cassandra.lucene.search.condition.GeoBBoxCondition Maven / Gradle / Ivy
/*
* Licensed to STRATIO (C) under one or more contributor license agreements.
* See the NOTICE file distributed with this work for additional information
* regarding copyright ownership. The STRATIO (C) 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 com.stratio.cassandra.lucene.search.condition;
import com.spatial4j.core.context.SpatialContext;
import com.spatial4j.core.shape.Rectangle;
import com.stratio.cassandra.lucene.IndexException;
import com.stratio.cassandra.lucene.schema.mapping.GeoPointMapper;
import org.apache.lucene.analysis.Analyzer;
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;
/**
* A {@link Condition} that matches documents containing a shape contained in a certain bounding box.
*
* @author Andres de la Pena {@literal }
*/
public class GeoBBoxCondition extends SingleMapperCondition {
/** The minimum accepted latitude. */
public final double minLatitude;
/** The maximum accepted latitude. */
public final double maxLatitude;
/** The minimum accepted longitude. */
public final double minLongitude;
/** The maximum accepted longitude. */
public final double maxLongitude;
/**
* 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}. If {@code null}, then {@link
* #DEFAULT_BOOST} is used as default.
* @param field The name of the field to be matched.
* @param minLatitude The minimum accepted latitude.
* @param maxLatitude The maximum accepted latitude.
* @param minLongitude The minimum accepted longitude.
* @param maxLongitude The maximum accepted longitude.
*/
public GeoBBoxCondition(Float boost,
String field,
Double minLatitude,
Double maxLatitude,
Double minLongitude,
Double maxLongitude) {
super(boost, field, GeoPointMapper.class);
this.minLatitude = GeoPointMapper.checkLatitude("min_latitude", minLatitude);
this.maxLatitude = GeoPointMapper.checkLatitude("max_latitude", maxLatitude);
this.minLongitude = GeoPointMapper.checkLongitude("min_longitude", minLongitude);
this.maxLongitude = GeoPointMapper.checkLongitude("max_longitude", maxLongitude);
if (minLongitude > maxLongitude) {
throw new IndexException("min_longitude must be lower than max_longitude");
}
if (minLatitude > maxLatitude) {
throw new IndexException("min_latitude must be lower than max_latitude");
}
}
/** {@inheritDoc} */
@Override
public Query query(GeoPointMapper mapper, Analyzer analyzer) {
SpatialStrategy spatialStrategy = mapper.bboxStrategy;
SpatialContext context = GeoPointMapper.SPATIAL_CONTEXT;
Rectangle rectangle = context.makeRectangle(minLongitude, maxLongitude, minLatitude, maxLatitude);
SpatialArgs args = new SpatialArgs(SpatialOperation.BBoxIntersects, rectangle);
Query query = spatialStrategy.makeQuery(args);
query.setBoost(boost);
return query;
}
/** {@inheritDoc} */
@Override
public String toString() {
return toStringHelper(this).add("minLatitude", minLatitude)
.add("maxLatitude", maxLatitude)
.add("minLongitude", minLongitude)
.add("maxLongitude", maxLongitude)
.toString();
}
}