Query: Updates to insidePolygon and insideBoundingBox (#229)

* Query: Migrate insidePolygon to handle several polygons

* Query: Update documentation for insideBoundingBox [ci skip]

* Query: Catch eventual NFEs in getInsidePolygon

Author: PLNech

algoliasearch/src/main/java/com/algolia/search/saas/Query.java

@@ -618,12 +618,8 @@ public int hashCode() {
     private static final String KEY_INSIDE_BOUNDING_BOX = "insideBoundingBox";
 
     /**
-     * Search for entries inside a given area defined by the two extreme points
-     * of a rectangle. At indexing, geoloc of an object should be set with
-     * _geoloc attribute containing lat and lng attributes (for example
-     * {"_geoloc":{"lat":48.853409, "lng":2.348800}})
-     * <p>
-     * You can use several bounding boxes (OR) by calling this method several times.
+     * Search for entries inside one area or the union of several areas
+     * defined by the two extreme points of a rectangle.
      */
     public @NonNull Query setInsideBoundingBox(@Nullable GeoRect... boxes) {
         if (boxes == null) {
@@ -674,19 +670,46 @@ public int hashCode() {
         }
     }
 
-    private static final String KEY_INSIDE_POLYGON = "insidePolygon";
-
     /**
-     * Add a point to the polygon of geo-search (requires a minimum of three points to define a valid polygon)
-     * At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form "_geoloc":{"lat":48.853409, "lng":2.348800} or
-     * "_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}] if you have several geo-locations in your record).
+     * A polygon in geo coordinates.
+     * Used in geo-search.
      */
-    public @NonNull Query setInsidePolygon(@Nullable LatLng... points) {
-        if (points == null) {
-            set(KEY_INSIDE_POLYGON, null);
-        } else if (points.length < 3) {
-            throw new IllegalArgumentException("A polygon must have at least three vertices");
-        } else {
+    public static final class Polygon {
+        @NonNull
+        public final LatLng[] points;
+
+        public Polygon(@NonNull LatLng... points) {
+            if (points.length < 3) {
+                throw new IllegalArgumentException("A polygon must have at least three vertices");
+            }
+            this.points = points;
+        }
+
+        public Polygon(String value) {
+            this(parse(value));
+        }
+
+        public Polygon(Polygon other) {
+            this.points = other.points;
+        }
+
+        @Override public boolean equals(Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
+
+            Polygon polygon = (Polygon) o;
+            return Arrays.equals(points, polygon.points);
+        }
+
+        @Override public int hashCode() {
+            return Arrays.hashCode(points);
+        }
+
+        @Override public String toString() {
             StringBuilder sb = new StringBuilder();
             for (LatLng point : points) {
                 if (sb.length() != 0) {
@@ -696,14 +719,10 @@ public int hashCode() {
                 sb.append(',');
                 sb.append(point.lng);
             }
-            set(KEY_INSIDE_POLYGON, sb.toString());
+            return sb.toString();
         }
-        return this;
-    }
 
-    public @Nullable LatLng[] getInsidePolygon() {
-        try {
-            String value = get(KEY_INSIDE_POLYGON);
+        public static @Nullable Polygon parse(String value) {
             if (value != null) {
                 String[] fields = value.split(",");
                 if (fields.length % 2 == 0 && fields.length / 2 >= 3) {
@@ -714,10 +733,65 @@ public int hashCode() {
                                 Double.parseDouble(fields[2 * i + 1])
                         );
                     }
-                    return result;
+                    return new Polygon(result);
                 }
             }
             return null;
+        }
+    }
+
+    private static final String KEY_INSIDE_POLYGON = "insidePolygon";
+
+    /**
+     * Search for entries inside a given area defined by the points of a polygon.
+     */
+    public @NonNull Query setInsidePolygon(@Nullable LatLng... points) {
+        set(KEY_INSIDE_POLYGON, points == null ? null : new Polygon(points).toString());
+        return this;
+    }
+
+    /**
+     * Search for entries inside a given area defined by several polygons.
+     */
+    public @NonNull Query setInsidePolygon(@Nullable Polygon... polygons) {
+        String insidePolygon = null;
+        if (polygons == null) {
+            insidePolygon = null;
+        } else if (polygons.length == 1) {
+            insidePolygon = polygons[0].toString();
+        } else {
+            for (Polygon polygon : polygons) {
+                String polygonStr = "[" + polygon + "]";
+                if (insidePolygon == null) {
+                    insidePolygon = "[";
+                } else {
+                    insidePolygon += ",";
+                }
+                insidePolygon += polygonStr;
+            }
+            insidePolygon += "]";
+        }
+        set(KEY_INSIDE_POLYGON, insidePolygon);
+        return this;
+    }
+
+    public @Nullable Polygon[] getInsidePolygon() {
+        try {
+            String value = get(KEY_INSIDE_POLYGON);
+            Polygon[] polygons;
+            if (value == null) {
+                return null;
+            } else if (value.startsWith("[")) {
+                String[] values = parseArray(value);
+                polygons = new Polygon[values.length];
+                for (int i = 0; i < values.length; i++) {
+                    polygons[i] = new Polygon(values[i].replace("[", "").replace("]", ""));
+                }
+                return polygons;
+            } else {
+                final Polygon polygon = Polygon.parse(value);
+                return new Polygon[]{polygon};
+            }
         } catch (NumberFormatException e) {
             return null;
         }

algoliasearch/src/test/java/com/algolia/search/saas/QueryTest.java

@@ -563,11 +563,19 @@ public void insideBoundingBox() {
     public void insidePolygon() {
         Query query = new Query();
         assertNull(query.getInsidePolygon());
-        final Query.LatLng[] box = { new Query.LatLng(11.111111, 22.222222), new Query.LatLng(33.333333, 44.444444), new Query.LatLng(-55.555555, -66.666666) };
-        query.setInsidePolygon(box);
-        assertArrayEquals(box, query.getInsidePolygon());
+        final Query.Polygon polygon = new Query.Polygon(new Query.LatLng(11.111111, 22.222222), new Query.LatLng(33.333333, 44.444444), new Query.LatLng(-55.555555, -66.666666));
+        Query.Polygon[] polygons = {polygon};
+        query.setInsidePolygon(polygons);
+        assertArrayEquals(polygons, query.getInsidePolygon());
         assertEquals("11.111111,22.222222,33.333333,44.444444,-55.555555,-66.666666", query.get("insidePolygon"));
         assertArrayEquals(query.getInsidePolygon(), Query.parse(query.build()).getInsidePolygon());
+
+        final Query.Polygon polygon2 = new Query.Polygon(new Query.LatLng(77.777777, 88.888888), new Query.LatLng(99.999999, 11.111111), new Query.LatLng(-11.111111, -22.222222));
+        polygons = new Query.Polygon[]{polygon, polygon2};
+        query.setInsidePolygon(polygons);
+        assertArrayEquals(polygons, query.getInsidePolygon());
+        assertEquals("[[11.111111,22.222222,33.333333,44.444444,-55.555555,-66.666666],[77.777777,88.888888,99.999999,11.111111,-11.111111,-22.222222]]", query.get("insidePolygon"));
+        assertArrayEquals(query.getInsidePolygon(), Query.parse(query.build()).getInsidePolygon());
     }
 
     @Test