Add option for polygon/linestring in results (#823)

At the moment, photon only returns the point of a location, and not the polygon (see #259). This PR will add the option to add the polygon (i.e. geometry) to the Elasticsearch Index and a API parameter polygon to return said polygon. If no polygon exists, the point is returned.

WARNING: This will increase the Elasticsearch Index size! (~575GB for a Planet import).

To enable: add the command line argument -use-geometry-column whilst importing and add &geometry=true to the API call.

Author: red-fenix

app/es_embedded/es/mappings.json

@@ -49,6 +49,9 @@
 			"coordinate": {
 				"type": "geo_point"
 			},
+			"geometry": {
+				"type": "geo_shape"
+			},
 			"country": {
 				"properties": {
 					"default": {

app/es_embedded/src/main/java/de/komoot/photon/Server.java

@@ -56,6 +56,7 @@ public class Server {
     private static final String FIELD_VERSION = "database_version";
     private static final String FIELD_LANGUAGES = "indexed_languages";
     private static final String FIELD_IMPORT_DATE = "import_date";
+    private static final String FIELD_SUPPORT_GEOMETRIES = "support_geometries";
 
     private Node esNode;
 
@@ -177,14 +178,18 @@ private void setupDirectories(URL directoryName) throws IOException, URISyntaxEx
 
     }
 
-    public DatabaseProperties recreateIndex(String[] languages, Date importDate, boolean supportStructuredQueries) throws IOException {
+    public DatabaseProperties recreateIndex(String[] languages, Date importDate, boolean supportStructuredQueries, boolean supportGeometries) throws IOException {
         deleteIndex();
 
         loadIndexSettings().createIndex(esClient, PhotonIndex.NAME);
 
         createAndPutIndexMapping(languages, supportStructuredQueries);
 
-        DatabaseProperties dbProperties = new DatabaseProperties(languages, importDate, false);
+        DatabaseProperties dbProperties = new DatabaseProperties()
+            .setLanguages(languages)
+            .setImportDate(importDate)
+            .setSupportGeometries(supportGeometries);
+
         saveToDatabase(dbProperties);
 
         return dbProperties;
@@ -239,6 +244,7 @@ public void saveToDatabase(DatabaseProperties dbProperties) throws IOException
                         .field(FIELD_VERSION, DATABASE_VERSION)
                         .field(FIELD_LANGUAGES, String.join(",", dbProperties.getLanguages()))
                         .field(FIELD_IMPORT_DATE, dbProperties.getImportDate() instanceof Date ? dbProperties.getImportDate().toInstant() : null)
+                        .field(FIELD_SUPPORT_GEOMETRIES, Boolean.toString(dbProperties.getSupportGeometries()))
                         .endObject().endObject();
 
         esClient.prepareIndex(PhotonIndex.NAME, PhotonIndex.TYPE).
@@ -276,11 +282,15 @@ public DatabaseProperties loadFromDatabase() {
         }
 
         String langString = properties.get(FIELD_LANGUAGES);
+
         String importDateString = properties.get(FIELD_IMPORT_DATE);
 
+        String supportGeometries = properties.get(FIELD_SUPPORT_GEOMETRIES);
+
         return new DatabaseProperties(langString == null ? null : langString.split(","),
-                                      importDateString == null ? null : Date.from(Instant.parse(importDateString)),
-                                      false);
+                importDateString == null ? null : Date.from(Instant.parse(importDateString)),
+                false,
+                Boolean.parseBoolean(supportGeometries));
     }
 
     public Importer createImporter(String[] languages, String[] extraTags) {

app/es_embedded/src/main/java/de/komoot/photon/elasticsearch/ElasticResult.java

@@ -66,6 +66,11 @@ public double[] getCoordinates() {
         return new double[]{coordinate.get(Constants.LON), coordinate.get(Constants.LAT)};
     }
 
+    @Override
+    public String getGeometry() {
+        return (String) result.getSource().get("geometry");
+    }
+
     @Override
     public double[] getExtent() {
         final Map<String, Object> extent = (Map<String, Object>) result.getSource().get("extent");

app/es_embedded/src/main/java/de/komoot/photon/elasticsearch/PhotonDocConverter.java

@@ -3,9 +3,11 @@
 import de.komoot.photon.Constants;
 import de.komoot.photon.PhotonDoc;
 import de.komoot.photon.nominatim.model.AddressType;
-import org.elasticsearch.common.xcontent.XContentBuilder;
-import org.elasticsearch.common.xcontent.XContentFactory;
+
+import org.elasticsearch.common.xcontent.*;
+import org.elasticsearch.common.xcontent.json.JsonXContent;
 import org.locationtech.jts.geom.Envelope;
+import org.locationtech.jts.io.geojson.GeoJsonWriter;
 
 import java.io.IOException;
 import java.util.HashMap;
@@ -38,6 +40,17 @@ public static XContentBuilder convert(PhotonDoc doc, String[] languages, String[
                     .endObject();
         }
 
+        if (doc.getGeometry() != null) {
+            GeoJsonWriter g = new GeoJsonWriter();
+
+            XContentParser parser = JsonXContent
+                .jsonXContent
+                .createParser(NamedXContentRegistry.EMPTY, g.write(doc.getGeometry()));
+
+            builder.field("geometry");
+            builder.copyCurrentStructure(parser);
+        }
+
         if (doc.getHouseNumber() != null) {
             builder.field("housenumber", doc.getHouseNumber());
         }

app/es_embedded/src/test/java/de/komoot/photon/ESBaseTester.java

@@ -7,6 +7,8 @@
 import de.komoot.photon.searcher.PhotonResult;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.io.TempDir;
+import org.locationtech.jts.io.ParseException;
+import org.locationtech.jts.io.WKTReader;
 
 import java.io.IOException;
 import java.nio.file.Path;
@@ -25,9 +27,9 @@ public class ESBaseTester {
 
     private ElasticTestServer server;
 
-    protected PhotonDoc createDoc(double lon, double lat, int id, int osmId, String key, String value) {
+    protected PhotonDoc createDoc(double lon, double lat, int id, int osmId, String key, String value) throws ParseException {
         Point location = FACTORY.createPoint(new Coordinate(lon, lat));
-        return new PhotonDoc(id, "W", osmId, key, value).names(Collections.singletonMap("name", "berlin")).centroid(location);
+        return new PhotonDoc(id, "W", osmId, key, value).names(Collections.singletonMap("name", "berlin")).centroid(location).geometry(new WKTReader().read("POLYGON ((6.4440619 52.1969454, 6.4441094 52.1969158, 6.4441408 52.1969347, 6.4441138 52.1969516, 6.4440933 52.1969643, 6.4440619 52.1969454))"));
     }
 
     protected PhotonResult getById(int id) {
@@ -45,17 +47,21 @@ public void tearDown() throws IOException {
     }
 
     public void setUpES() throws IOException {
-        setUpES(dataDirectory, "en");
+        setUpES(dataDirectory, false,"en");
+    }
+
+    public void setUpESWithGeometry() throws IOException {
+        setUpES(dataDirectory, true,"en");
     }
     /**
      * Setup the ES server
      *
      * @throws IOException
      */
-    public void setUpES(Path testDirectory, String... languages) throws IOException {
+    public void setUpES(Path testDirectory, boolean supportGeometries, String... languages) throws IOException {
         server = new ElasticTestServer(testDirectory.toString());
         server.start(TEST_CLUSTER_NAME, new String[]{});
-        server.recreateIndex(languages, new Date(), false);
+        server.recreateIndex(languages, new Date(), false, supportGeometries);
         refresh();
     }
 

app/es_embedded/src/test/java/de/komoot/photon/elasticsearch/ElasticGetIdResult.java

@@ -34,6 +34,10 @@ public double[] getCoordinates() {
         throw new NotImplementedException();
     }
 
+    public String getGeometry() {
+        throw new NotImplementedException();
+    }
+
     @Override
     public double[] getExtent() {
         throw new NotImplementedException();

app/es_embedded/src/test/java/de/komoot/photon/elasticsearch/ElasticResultTest.java

@@ -44,7 +44,7 @@ protected PhotonDoc createDoc(double lon, double lat, int id, int osmId, String
 
     @BeforeAll
     void setUp() throws Exception {
-        setUpES(instanceTestDirectory, "en", "de", "fr", "it");
+        setUpES(instanceTestDirectory, false, "en", "de", "fr", "it");
         Importer instance = getServer().createImporter(new String[]{"en", "de", "fr", "it"},
                  new String[]{"population",  "capital"});
 

app/es_embedded/src/test/java/de/komoot/photon/elasticsearch/ImporterTest.java

@@ -6,6 +6,8 @@
 import de.komoot.photon.searcher.PhotonResult;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.locationtech.jts.io.ParseException;
+import org.locationtech.jts.io.WKTReader;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -22,10 +24,11 @@ public void setUp() throws IOException {
     }
 
     @Test
-    void testAddSimpleDoc() {
+    void testAddSimpleDoc() throws ParseException {
         Importer instance = makeImporterWithExtra("");
 
         instance.add(new PhotonDoc(1234, "N", 1000, "place", "city")
+                .geometry(new WKTReader().read("MULTIPOLYGON (((6.111933 51.2659309, 6.1119417 51.2659247, 6.1119554 51.2659249, 6.1119868 51.2659432, 6.111964 51.2659591, 6.1119333 51.2659391, 6.111933 51.2659309)))"))
                 .extraTags(Collections.singletonMap("maxspeed", "100")), 0);
         instance.finish();
         refresh();

app/es_embedded/src/test/java/de/komoot/photon/elasticsearch/ServerTest.java

@@ -16,7 +16,7 @@ void testSaveAndLoadFromDatabase() throws IOException {
         setUpES();
 
         Date now = new Date();
-        DatabaseProperties prop = new DatabaseProperties(new String[]{"en", "de", "fr"}, now, false);
+        DatabaseProperties prop = new DatabaseProperties(new String[]{"en", "de", "fr"}, now, false, false);
         getServer().saveToDatabase(prop);
 
         prop = getServer().loadFromDatabase();

app/opensearch/build.gradle

@@ -22,7 +22,7 @@ dependencies {
     implementation 'org.apache.httpcomponents.client5:httpclient5:5.4.1'
     implementation 'com.fasterxml.jackson.core:jackson-databind:2.18.2'
 
-    implementation('org.codelibs.opensearch:opensearch-runner:2.18.0.0') {
+    implementation('org.codelibs.opensearch:opensearch-runner:2.18.0.1') {
         exclude(module: 'repository-url')
         exclude(module: 'reindex-client')
         exclude(module: 'rank-eval-client')