[DE-376] geo index legacy polygons

(cherry picked from commit 901550d)

Author: rashtao

src/main/java/com/arangodb/entity/IndexEntity.java

@@ -42,8 +42,8 @@ public final class IndexEntity {
     private Integer expireAfter;
     private Boolean inBackground;
     private Boolean estimates;
-
     private Boolean cacheEnabled;
+    private Boolean legacyPolygons;
 
     public IndexEntity() {
         super();
@@ -113,4 +113,8 @@ public Boolean getCacheEnabled() {
         return cacheEnabled;
     }
 
+    public Boolean getLegacyPolygons() {
+        return legacyPolygons;
+    }
+
 }

src/main/java/com/arangodb/model/GeoIndexOptions.java

@@ -32,6 +32,7 @@ public final class GeoIndexOptions extends IndexOptions<GeoIndexOptions> {
     private final IndexType type = IndexType.geo;
     private Iterable<String> fields;
     private Boolean geoJson;
+    private Boolean legacyPolygons;
 
     public GeoIndexOptions() {
         super();
@@ -73,4 +74,21 @@ public GeoIndexOptions geoJson(final Boolean geoJson) {
         return this;
     }
 
+    public Boolean getLegacyPolygons() {
+        return legacyPolygons;
+    }
+
+    /**
+     * @param legacyPolygons If `true` will use the old rules (pre-3.10) for the parsing GeoJSON polygons. This
+     *                       allows you to let old indexes produce the same, potentially wrong results as before an
+     *                       upgrade. A geo index with `legacyPolygons` set to `false` will use the new, correct and
+     *                       consistent method for parsing of GeoJSON polygons.
+     *                       See <a href="https://www.arangodb.com/docs/stable/indexing-geo.html#legacy-polygons">Legacy Polygons</a>.
+     * @return options
+     * @since ArangoDB 3.10
+     */
+    public GeoIndexOptions legacyPolygons(final Boolean legacyPolygons) {
+        this.legacyPolygons = legacyPolygons;
+        return this;
+    }
 }

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -1302,6 +1302,9 @@ void createGeoIndex(ArangoCollection collection) {
         } else {
             assertThat(indexResult.getType()).isEqualTo(IndexType.geo1);
         }
+        if (isAtLeastVersion(3, 10)) {
+            assertThat(indexResult.getLegacyPolygons()).isFalse();
+        }
     }
 
     @ParameterizedTest(name = "{index}")
@@ -1329,6 +1332,40 @@ void createGeoIndexWithOptions(ArangoCollection collection) {
             assertThat(indexResult.getType()).isEqualTo(IndexType.geo1);
         }
         assertThat(indexResult.getName()).isEqualTo(name);
+        if (isAtLeastVersion(3, 10)) {
+            assertThat(indexResult.getLegacyPolygons()).isFalse();
+        }
+    }
+
+    @ParameterizedTest(name = "{index}")
+    @MethodSource("cols")
+    void createGeoIndexLegacyPolygons(ArangoCollection collection) {
+        assumeTrue(isAtLeastVersion(3, 10));
+
+        String name = "geoIndex-" + rnd();
+        final GeoIndexOptions options = new GeoIndexOptions();
+        options.name(name);
+        options.legacyPolygons(true);
+
+        String f1 = "field-" + rnd();
+        final Collection<String> fields = Collections.singletonList(f1);
+        final IndexEntity indexResult = collection.ensureGeoIndex(fields, options);
+        assertThat(indexResult).isNotNull();
+        assertThat(indexResult.getFields()).contains(f1);
+        assertThat(indexResult.getId()).startsWith(COLLECTION_NAME);
+        assertThat(indexResult.getIsNewlyCreated()).isTrue();
+        assertThat(indexResult.getMinLength()).isNull();
+        assertThat(indexResult.getSparse()).isTrue();
+        assertThat(indexResult.getUnique()).isFalse();
+        if (isAtLeastVersion(3, 4)) {
+            assertThat(indexResult.getType()).isEqualTo(IndexType.geo);
+        } else {
+            assertThat(indexResult.getType()).isEqualTo(IndexType.geo1);
+        }
+        assertThat(indexResult.getName()).isEqualTo(name);
+        if (isAtLeastVersion(3, 10)) {
+            assertThat(indexResult.getLegacyPolygons()).isTrue();
+        }
     }
 
     @ParameterizedTest(name = "{index}")