Use Envelope in API; move Bbox to core

Author: michaz

api/src/main/java/com/graphhopper/ResponsePath.java

@@ -20,7 +20,7 @@
 import com.graphhopper.util.InstructionList;
 import com.graphhopper.util.PointList;
 import com.graphhopper.util.details.PathDetail;
-import com.graphhopper.util.shapes.BBox;
+import org.locationtech.jts.geom.Envelope;
 
 import java.math.BigDecimal;
 import java.util.*;
@@ -210,11 +210,11 @@ public ResponsePath setRouteWeight(double weight) {
     /**
      * Calculates the 2D bounding box of this route
      */
-    public BBox calcBBox2D() {
+    public Envelope calcBBox2D() {
         check("calcRouteBBox");
-        BBox bounds = BBox.createInverse(false);
+        Envelope bounds = new Envelope();
         for (int i = 0; i < pointList.getSize(); i++) {
-            bounds.update(pointList.getLatitude(i), pointList.getLongitude(i));
+            bounds.expandToInclude(pointList.getLongitude(i), pointList.getLatitude(i));
         }
         return bounds;
     }

api/src/main/java/com/graphhopper/json/geo/JsonFeature.java

@@ -17,7 +17,7 @@
  */
 package com.graphhopper.json.geo;
 
-import com.graphhopper.util.shapes.BBox;
+import org.locationtech.jts.geom.Envelope;
 import org.locationtech.jts.geom.Geometry;
 
 import java.util.Map;
@@ -30,14 +30,14 @@
 public class JsonFeature {
     private String id;
     private String type = "Feature";
-    private BBox bbox;
+    private Envelope bbox;
     private Geometry geometry;
     private Map<String, Object> properties;
 
     public JsonFeature() {
     }
 
-    public JsonFeature(String id, String type, BBox bbox, Geometry geometry, Map<String, Object> properties) {
+    public JsonFeature(String id, String type, Envelope bbox, Geometry geometry, Map<String, Object> properties) {
         this.id = id;
         this.type = type;
         this.bbox = bbox;
@@ -53,7 +53,7 @@ public String getType() {
         return type;
     }
 
-    public BBox getBBox() {
+    public Envelope getBBox() {
         return bbox;
     }
 
@@ -81,7 +81,7 @@ public void setId(String id) {
         this.id = id;
     }
 
-    public void setBbox(BBox bbox) {
+    public void setBbox(Envelope bbox) {
         this.bbox = bbox;
     }
 

client-hc/pom.xml

@@ -49,13 +49,8 @@
             <artifactId>slf4j-api</artifactId>
         </dependency>
         <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-log4j12</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>log4j</groupId>
-            <artifactId>log4j</artifactId>
+            <groupId>io.dropwizard</groupId>
+            <artifactId>dropwizard-testing</artifactId>
             <scope>test</scope>
         </dependency>
     </dependencies>

client-hc/src/main/java/com/graphhopper/api/model/GHGeocodingEntry.java

@@ -20,7 +20,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.graphhopper.util.shapes.BBox;
+import org.locationtech.jts.geom.Envelope;
 
 /**
  * Contains the results of a geocoding request.
@@ -48,9 +48,9 @@ public class GHGeocodingEntry {
     private String osmKey;
     private String osmValue;
 
-    private BBox extent;
+    private Envelope extent;
 
-    public GHGeocodingEntry(Long osmId, String type, double lat, double lng, String name, String osmKey, String osmValue, String country, String city, String state, String street, String houseNumber, String postcode, BBox extent) {
+    public GHGeocodingEntry(Long osmId, String type, double lat, double lng, String name, String osmKey, String osmValue, String country, String city, String state, String street, String houseNumber, String postcode, Envelope extent) {
         this.osmId = osmId;
         this.osmType = type;
         this.point = new Point(lat, lng);
@@ -189,27 +189,17 @@ public void setOsmValue(String osmValue) {
         this.osmValue = osmValue;
     }
 
-    @JsonProperty
-    public Double[] getExtent() {
-        if (this.extent == null) {
-            // TODO should we return null instead?
-            return new Double[0];
-        }
-        return this.extent.toGeoJson().toArray(new Double[4]);
-    }
-
-    public BBox getExtendBBox(){
+    public Envelope getExtent(){
         return this.extent;
     }
 
     @JsonProperty
     public void setExtent(Double[] extent) {
-        if (extent == null || extent.length == 0) {
-            return;
-        }
-        if (extent.length == 4) {
+        if (extent == null) {
+            this.extent = null;
+        } else if (extent.length == 4) {
             // Extend is in Left, Top, Right, Bottom; which is very uncommon, Photon uses the same
-            this.extent = new BBox(extent[0], extent[2], extent[3], extent[1]);
+            this.extent = new Envelope(extent[0], extent[2], extent[3], extent[1]);
         } else {
             throw new RuntimeException("Extent had an unexpected length: " + extent.length);
         }

client-hc/src/test/java/com/graphhopper/api/GraphHopperWebTest.java

@@ -1,19 +1,10 @@
 package com.graphhopper.api;
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.graphhopper.GHRequest;
-import com.graphhopper.ResponsePath;
-import com.graphhopper.jackson.Jackson;
-import com.graphhopper.jackson.ResponsePathDeserializer;
 import com.graphhopper.util.shapes.GHPoint;
-import org.junit.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
-import java.io.IOException;
-
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
@@ -34,24 +25,4 @@ public void testGetClientForRequest(boolean usePost) {
         assertEquals(5, gh.getClientForRequest(req).connectTimeoutMillis());
     }
 
-    @Test
-    public void testPutPOJO() {
-        ObjectNode requestJson = new ObjectMapper().createObjectNode();
-        requestJson.putPOJO("double", 1.0);
-        requestJson.putPOJO("int", 1);
-        requestJson.putPOJO("boolean", true);
-        // does not work requestJson.putPOJO("string", "test");
-        assertEquals("{\"double\":1.0,\"int\":1,\"boolean\":true}", requestJson.toString());
-    }
-
-    @Test
-    public void testUnknownInstructionSign() throws IOException {
-        // Modified the sign though
-        ObjectMapper objectMapper = Jackson.newObjectMapper();
-        JsonNode json = objectMapper.readTree("{\"instructions\":[{\"distance\":1.073,\"sign\":741,\"interval\":[0,1],\"text\":\"Continue onto A 81\",\"time\":32,\"street_name\":\"A 81\"},{\"distance\":0,\"sign\":4,\"interval\":[1,1],\"text\":\"Finish!\",\"time\":0,\"street_name\":\"\"}],\"descend\":0,\"ascend\":0,\"distance\":1.073,\"bbox\":[8.676286,48.354446,8.676297,48.354453],\"weight\":0.032179,\"time\":32,\"points_encoded\":true,\"points\":\"gfcfHwq}s@}c~AAA?\",\"snapped_waypoints\":\"gfcfHwq}s@}c~AAA?\"}");
-        ResponsePath responsePath = ResponsePathDeserializer.createResponsePath(objectMapper, json, true, true);
-
-        assertEquals(741, responsePath.getInstructions().get(0).getSign());
-        assertEquals("Continue onto A 81", responsePath.getInstructions().get(0).getName());
-    }
 }

client-hc/src/test/java/com/graphhopper/api/model/GHGeocodingResponseRepresentationTest.java

@@ -0,0 +1,45 @@
+/*
+ *  Licensed to GraphHopper GmbH under one or more contributor
+ *  license agreements. See the NOTICE file distributed with this work for
+ *  additional information regarding copyright ownership.
+ *
+ *  GraphHopper GmbH 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.graphhopper.api.model;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.graphhopper.jackson.Jackson;
+import org.junit.Assert;
+import org.junit.jupiter.api.Test;
+import org.locationtech.jts.geom.Envelope;
+
+import static io.dropwizard.testing.FixtureHelpers.fixture;
+
+
+public class GHGeocodingResponseRepresentationTest {
+
+    @Test
+    public void testGeocodingRepresentation() throws JsonProcessingException {
+        ObjectMapper objectMapper = Jackson.newObjectMapper();
+        GHGeocodingResponse geocodingResponse = objectMapper.readValue(fixture("fixtures/geocoding-response.json"), GHGeocodingResponse.class);
+        Envelope extent = geocodingResponse.getHits().get(0).getExtent();
+        // Despite the unusual representation of the bounding box...
+        Assert.assertEquals(10.0598605, extent.getMinX(), 0.0);
+        Assert.assertEquals(10.0612079, extent.getMaxX(), 0.0);
+        Assert.assertEquals(53.7445489, extent.getMinY(), 0.0);
+        Assert.assertEquals(53.7456315, extent.getMaxY(), 0.0);
+    }
+
+}

client-hc/src/test/resources/fixtures/geocoding-response.json

@@ -0,0 +1,32 @@
+{
+  "copyrights": [
+    "OpenCageData",
+    "OpenStreetMap",
+    "GraphHopper"
+  ],
+  "hits": [
+    {
+      "point": {
+        "lat": 53.7445489,
+        "lng": 10.0612079
+      },
+      "extent": [
+        10.0598605,
+        53.7445489,
+        10.0612079,
+        53.7456315
+      ],
+      "name": "Am Heidberg, 22889 Tangstedt, Germany",
+      "country": "Germany",
+      "city": "Tangstedt",
+      "state": "Schleswig-Holstein",
+      "county": "Stormarn",
+      "street": "Am Heidberg",
+      "postcode": "22889",
+      "osm_id": 25014113,
+      "osm_type": "W",
+      "osm_value": "road"
+    }
+  ],
+  "locale": "en"
+}

client-hc/src/test/resources/log4j.xml

@@ -30,7 +30,6 @@
 import com.graphhopper.util.*;
 import com.graphhopper.util.shapes.BBox;
 import com.graphhopper.util.shapes.GHPoint;
-import com.graphhopper.util.shapes.Shape;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -465,7 +464,7 @@ public void onNode(int nodeId) {
                 }, 0);
     }
 
-    final void query(int intPointer, Shape queryBBox,
+    final void query(int intPointer, BBox queryBBox,
                      double minLat, double minLon,
                      double deltaLatPerDepth, double deltaLonPerDepth,
                      Visitor function, int depth) {

core/src/main/java/com/graphhopper/storage/index/LocationIndexTree.java

@@ -142,24 +142,6 @@ public BBox clone() {
         return new BBox(minLon, maxLon, minLat, maxLat, minEle, maxEle, elevation);
     }
 
-    @Override
-    public boolean intersects(Shape s) {
-        if (s instanceof BBox) {
-            return intersects((BBox) s);
-        }
-
-        throw new UnsupportedOperationException("unsupported shape");
-    }
-
-    @Override
-    public boolean contains(Shape s) {
-        if (s instanceof BBox) {
-            return contains((BBox) s);
-        }
-
-        throw new UnsupportedOperationException("unsupported shape");
-    }
-
     public static boolean intersects(RectangleLineIntersector intersector, PointList pointList) {
         int len = pointList.getSize();
         if (len == 0)

api/src/main/java/com/graphhopper/util/shapes/BBox.java renamed to core/src/main/java/com/graphhopper/util/shapes/BBox.java

@@ -65,17 +65,6 @@ private double normDist(double lat1, double lon1) {
         return calc.calcNormalizedDist(lat, lon, lat1, lon1);
     }
 
-    @Override
-    public boolean intersects(Shape o) {
-        if (o instanceof Circle) {
-            return intersects((Circle) o);
-        } else if (o instanceof BBox) {
-            return intersects((BBox) o);
-        }
-
-        return o.intersects(this);
-    }
-
     @Override
     public boolean intersects(PointList pointList) {
         // similar code to LocationIndexTree.checkAdjacent
@@ -106,17 +95,6 @@ public boolean intersects(PointList pointList) {
         return false;
     }
 
-    @Override
-    public boolean contains(Shape o) {
-        if (o instanceof Circle) {
-            return contains((Circle) o);
-        } else if (o instanceof BBox) {
-            return contains((BBox) o);
-        }
-
-        throw new UnsupportedOperationException("unsupported shape");
-    }
-
     public boolean intersects(BBox b) {
         // test top intersects
         if (lat > b.maxLat) {
@@ -150,15 +128,6 @@ public boolean intersects(BBox b) {
         return true;
     }
 
-    public boolean intersects(Circle c) {
-        // necessary to improve speed?
-        if (!getBounds().intersects(c.getBounds())) {
-            return false;
-        }
-
-        return normDist(c.lat, c.lon) <= calc.calcNormalizedDist(radiusInMeter + c.radiusInMeter);
-    }
-
     public boolean contains(BBox b) {
         if (bbox.contains(b)) {
             return contains(b.maxLat, b.minLon) && contains(b.minLat, b.minLon)