DATACOUCH-165 - Add geospatial support
Add support for geo queries through the use of Spatial Views. This needs the query method to be annotated with @Dimensional (or a meta-annotation of it that is runtime retained). See SpatialViewQueryCreator javadoc for supported part types and corresponding expected arguments (to be documented). In a nutshell WITHIN Box (other shapes supported but approximated to bounding box), NEAR Point+Distance (approximated to bounding box), plus a few simple operators for dimensions beyond 2. When approximating, a DEBUG log is made along the logging of the query. Conversion methods from Shapes to bounding boxes are done in a GeoUtils class. Unit and Integration test of the feature. Added documentation for @Dimensional query derivation.
This commit is contained in:
Simon Baslé
@@ -0,0 +1,353 @@
|
||||
package org.springframework.data.couchbase.repository.query.support;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
|
||||
import com.couchbase.client.java.document.json.JsonArray;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.data.geo.Box;
|
||||
import org.springframework.data.geo.Circle;
|
||||
import org.springframework.data.geo.Distance;
|
||||
import org.springframework.data.geo.Point;
|
||||
import org.springframework.data.geo.Polygon;
|
||||
import org.springframework.data.geo.Shape;
|
||||
|
||||
/**
|
||||
* Unit tests for the {@link GeoUtils} utility class.
|
||||
* @author Simon Baslé
|
||||
*/
|
||||
public class GeoUtilsTest {
|
||||
|
||||
@Test
|
||||
public void testGetBoundingBoxForNear() throws Exception {
|
||||
final Distance distance = new Distance(120);
|
||||
double[] bbox = GeoUtils.getBoundingBoxForNear(new Point(1, 1), distance);
|
||||
assertEquals(-119d, bbox[0], 0d); //xMin
|
||||
assertEquals(121d, bbox[2], 0d); //xMax
|
||||
assertEquals(-119d, bbox[1], 0d); //yMin
|
||||
assertEquals(121d, bbox[3], 0d); //yMax
|
||||
|
||||
bbox = GeoUtils.getBoundingBoxForNear(new Point(-3,-5), distance);
|
||||
assertEquals(-123d, bbox[0], 0d); //xMin
|
||||
assertEquals(117d, bbox[2], 0d); //xMax
|
||||
assertEquals(-125d, bbox[1], 0d); //yMin
|
||||
assertEquals(115d, bbox[3], 0d); //yMax
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetBoundingBoxForNearNegativeDistance() throws Exception {
|
||||
final Distance distance = new Distance(-120);
|
||||
double[] bbox = GeoUtils.getBoundingBoxForNear(new Point(1, 1), distance);
|
||||
assertEquals(-119d, bbox[0], 0d); //xMin
|
||||
assertEquals(121d, bbox[2], 0d); //xMax
|
||||
assertEquals(-119d, bbox[1], 0d); //yMin
|
||||
assertEquals(121d, bbox[3], 0d); //yMax
|
||||
|
||||
bbox = GeoUtils.getBoundingBoxForNear(new Point(-3,-5), distance);
|
||||
assertEquals(-123d, bbox[0], 0d); //xMin
|
||||
assertEquals(117d, bbox[2], 0d); //xMax
|
||||
assertEquals(-125d, bbox[1], 0d); //yMin
|
||||
assertEquals(115d, bbox[3], 0d); //yMax
|
||||
}
|
||||
|
||||
@Test(expected = NullPointerException.class)
|
||||
public void testGetBoundingBoxForNearNullOrigin() {
|
||||
GeoUtils.getBoundingBoxForNear(null, new Distance(100));
|
||||
}
|
||||
|
||||
@Test(expected = NullPointerException.class)
|
||||
public void testGetBoundingBoxForNearNullDistance() {
|
||||
GeoUtils.getBoundingBoxForNear(new Point(1, 1), null);
|
||||
}
|
||||
|
||||
@Test(expected = NullPointerException.class)
|
||||
public void testGetBoundingBoxForNearNullOriginAndDistance() {
|
||||
GeoUtils.getBoundingBoxForNear(null, null);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testConvertPointsTo2DRangesIsBoundingBoxFailsIfLessThan2Points() {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Point p1 = new Point(2,3);
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, true, p1);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testConvertPointsTo2DRangesIsBoundingBoxFailsIfMoreThan2Points() {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Point p1 = new Point(2,3);
|
||||
Point p2 = new Point(4,5);
|
||||
Point p3 = new Point(6,7);
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, true, p1, p2, p3);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testConvertPointsTo2DRangesIsBoundingBoxFailsIfNotOrderedPoints() {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Point p1 = new Point(2,3);
|
||||
Point p2 = new Point(4,5);
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, true, p2, p1);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertPointsTo2DRanges2PointsBoundingBox() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Point p1 = new Point(2,3);
|
||||
Point p2 = new Point(4,5);
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, true, p1, p2);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(2d, startRange.getDouble(0), 0d);
|
||||
assertEquals(3d, startRange.getDouble(1), 0d);
|
||||
assertEquals(4d, endRange.getDouble(0), 0d);
|
||||
assertEquals(5d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertPointsTo2DRanges2PointsPoly() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Point p1 = new Point(2,3);
|
||||
Point p2 = new Point(4,5);
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, false, p1, p2);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(2d, startRange.getDouble(0), 0d);
|
||||
assertEquals(3d, startRange.getDouble(1), 0d);
|
||||
assertEquals(4d, endRange.getDouble(0), 0d);
|
||||
assertEquals(5d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertPointsTo2DRanges3PointsPoly() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Point p1 = new Point(2,3);
|
||||
Point p2 = new Point(-4, 3);
|
||||
Point p3 = new Point(6, -12);
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, false, p1, p2, p3);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(-4d, startRange.getDouble(0), 0d);
|
||||
assertEquals(-12d, startRange.getDouble(1), 0d);
|
||||
assertEquals(6d, endRange.getDouble(0), 0d);
|
||||
assertEquals(3d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertPointsTo2DRanges8Points() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
//bounding box of (3,3)(9,9)
|
||||
GeoUtils.convertPointsTo2DRanges(startRange, endRange, false,
|
||||
new Point(3, 3),
|
||||
new Point(3, 7),
|
||||
new Point(6, 7),
|
||||
new Point(6, 9),
|
||||
new Point(9, 9),
|
||||
new Point(9, 5),
|
||||
new Point(6, 5),
|
||||
new Point(6, 3));
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(3d, startRange.getDouble(0), 0d);
|
||||
assertEquals(3d, startRange.getDouble(1), 0d);
|
||||
assertEquals(9d, endRange.getDouble(0), 0d);
|
||||
assertEquals(9d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testConvertPointsTo2DRangesNullPoints() throws Exception {
|
||||
GeoUtils.convertPointsTo2DRanges(JsonArray.empty(), JsonArray.empty(), false, null);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testConvertPointsTo2DRangesEmptyPoints() throws Exception {
|
||||
GeoUtils.convertPointsTo2DRanges(JsonArray.empty(), JsonArray.empty(), false, new Point[0]);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertShapeTo2DRangesBox() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Box box = new Box(new Point(0, 5), new Point(10, 30));
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, box);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(0d, startRange.getDouble(0), 0d);
|
||||
assertEquals(5d, startRange.getDouble(1), 0d);
|
||||
assertEquals(10d, endRange.getDouble(0), 0d);
|
||||
assertEquals(30, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertShapeTo2DRangesBoxIsNotReordered() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Box box = new Box(new Point(0, 5), new Point(10, -3));
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, box);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(0d, startRange.getDouble(0), 0d);
|
||||
assertEquals(5d, startRange.getDouble(1), 0d);
|
||||
assertEquals(10d, endRange.getDouble(0), 0d);
|
||||
assertEquals(-3d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertPolygonBoxTo2DRangesIsReordered() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Polygon box = new Polygon(new Point(0, 5), new Point(10, -3), new Point(0, 5));
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, box);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(0d, startRange.getDouble(0), 0d);
|
||||
assertEquals(-3d, startRange.getDouble(1), 0d);
|
||||
assertEquals(10d, endRange.getDouble(0), 0d);
|
||||
assertEquals(5d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertShapeTo2DRangesPolygon() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Polygon polygon = new Polygon(
|
||||
new Point(3, 3),
|
||||
new Point(3, 7),
|
||||
new Point(6, 7),
|
||||
new Point(6, 9),
|
||||
new Point(9, 9),
|
||||
new Point(9, 5),
|
||||
new Point(6, 5),
|
||||
new Point(6, 3)
|
||||
);
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, polygon);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(3d, startRange.getDouble(0), 0d);
|
||||
assertEquals(3d, startRange.getDouble(1), 0d);
|
||||
assertEquals(9d, endRange.getDouble(0), 0d);
|
||||
assertEquals(9d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertShapeTo2DRangesPolygonIsSameAsMultiplePointsTo2DRanges() throws Exception {
|
||||
JsonArray startRangePoints = JsonArray.create();
|
||||
JsonArray endRangePoints = JsonArray.create();
|
||||
JsonArray startRangePolygon = JsonArray.create();
|
||||
JsonArray endRangePolygon = JsonArray.create();
|
||||
|
||||
GeoUtils.convertPointsTo2DRanges(startRangePoints, endRangePoints, false,
|
||||
new Point(3, 3),
|
||||
new Point(3, 7),
|
||||
new Point(6, 7),
|
||||
new Point(6, 9),
|
||||
new Point(9, 9),
|
||||
new Point(9, 5),
|
||||
new Point(6, 5),
|
||||
new Point(6, 3));
|
||||
|
||||
Polygon polygon = new Polygon(
|
||||
new Point(3, 3),
|
||||
new Point(3, 7),
|
||||
new Point(6, 7),
|
||||
new Point(6, 9),
|
||||
new Point(9, 9),
|
||||
new Point(9, 5),
|
||||
new Point(6, 5),
|
||||
new Point(6, 3));
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRangePolygon, endRangePolygon, polygon);
|
||||
|
||||
assertEquals(2, startRangePoints.size());
|
||||
assertEquals(2, endRangePoints.size());
|
||||
assertEquals(3d, startRangePoints.getDouble(0), 0d);
|
||||
assertEquals(3d, startRangePoints.getDouble(1), 0d);
|
||||
assertEquals(9d, endRangePoints.getDouble(0), 0d);
|
||||
assertEquals(9d, endRangePoints.getDouble(1), 0d);
|
||||
assertEquals(endRangePoints, endRangePolygon);
|
||||
assertEquals(startRangePoints, startRangePolygon);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testConvertShapeTo2DRangesCircle() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
Circle circle = new Circle(new Point(0, 0), new Distance(3));
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, circle);
|
||||
|
||||
assertEquals(2, startRange.size());
|
||||
assertEquals(2, endRange.size());
|
||||
assertEquals(-3d, startRange.getDouble(0), 0d);
|
||||
assertEquals(-3d, startRange.getDouble(1), 0d);
|
||||
assertEquals(3d, endRange.getDouble(0), 0d);
|
||||
assertEquals(3d, endRange.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCircleApproximationIsSameAsNearApproximation() throws Exception {
|
||||
JsonArray startRangeCircle = JsonArray.create();
|
||||
JsonArray endRangeCircle = JsonArray.create();
|
||||
Point origin = new Point(0, 0);
|
||||
Distance distance = new Distance(3);
|
||||
Circle circle = new Circle(origin, distance);
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRangeCircle, endRangeCircle, circle);
|
||||
double[] bbox = GeoUtils.getBoundingBoxForNear(origin, distance);
|
||||
|
||||
assertEquals(2, startRangeCircle.size());
|
||||
assertEquals(2, endRangeCircle.size());
|
||||
|
||||
assertEquals(-3d, bbox[0], 0d);
|
||||
assertEquals(-3d, bbox[1], 0d);
|
||||
assertEquals(3d, bbox[2], 0d);
|
||||
assertEquals(3d, bbox[3], 0d);
|
||||
|
||||
assertEquals(bbox[0], startRangeCircle.getDouble(0), 0d);
|
||||
assertEquals(bbox[1], startRangeCircle.getDouble(1), 0d);
|
||||
assertEquals(bbox[2], endRangeCircle.getDouble(0), 0d);
|
||||
assertEquals(bbox[3], endRangeCircle.getDouble(1), 0d);
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testConvertShapeTo2DRangesOtherShape() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
|
||||
Shape customShape = new Shape() {};
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, customShape);
|
||||
}
|
||||
|
||||
@Test(expected = NullPointerException.class)
|
||||
public void testConvertShapeTo2DRangesNullShape() throws Exception {
|
||||
JsonArray startRange = JsonArray.create();
|
||||
JsonArray endRange = JsonArray.create();
|
||||
|
||||
GeoUtils.convertShapeTo2DRanges(startRange, endRange, null);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user