SQL source for weather coordinates using PostGIS

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `ThermalGrid` as a container for a completely connected thermal grid
 - `EmResult` and `FlexOptionsResult` for Energy Management Systems [#651](https://github.com/ie3-institute/PowerSystemDataModel/issues/651)
 - `EvcsInput` now has a parameter for enabling and disabling vehicle to grid support [#681](https://github.com/ie3-institute/PowerSystemDataModel/issues/681)
+- Adding SQL id coordinate sources (``IdCoordinateSource``) [#689](https://github.com/ie3-institute/PowerSystemDataModel/issues/689)
 
 ### Fixed
 - Reduced code smells [#492](https://github.com/ie3-institute/PowerSystemDataModel/issues/492)

src/main/java/edu/ie3/datamodel/io/factory/timeseries/CosmoIdCoordinateFactory.java

@@ -22,6 +22,7 @@ public class CosmoIdCoordinateFactory extends IdCoordinateFactory {
   private static final String LAT_GEO = "latgeo";
   private static final String LONG_ROT = "longrot";
   private static final String LAT_ROT = "latrot";
+  private static final String Point = "point";
 
   @Override
   protected Pair<Integer, Point> buildModel(SimpleFactoryData data) {
@@ -51,4 +52,9 @@ public String getLatField() {
   public String getLonField() {
     return LONG_GEO;
   }
+
+  @Override
+  public String getPointField() {
+    return Point;
+  }
 }

src/main/java/edu/ie3/datamodel/io/factory/timeseries/IconIdCoordinateFactory.java

@@ -22,6 +22,7 @@ public class IconIdCoordinateFactory extends IdCoordinateFactory {
   private static final String LONG = "longitude";
   private static final String LAT = "latitude";
   private static final String TYPE = "coordinatetype";
+  private static final String Point = "point";
 
   @Override
   protected Pair<Integer, Point> buildModel(SimpleFactoryData data) {
@@ -50,4 +51,9 @@ public String getLatField() {
   public String getLonField() {
     return LONG;
   }
+
+  @Override
+  public String getPointField() {
+    return Point;
+  }
 }

src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java

@@ -28,4 +28,7 @@ protected IdCoordinateFactory() {
 
   /** @return the field id for the coordinate longitude */
   public abstract String getLonField();
+
+  /** @return the filed id for the coordinate point */
+  public abstract String getPointField();
 }

src/main/java/edu/ie3/datamodel/io/source/IdCoordinateSource.java

@@ -8,14 +8,17 @@
 import edu.ie3.util.geo.CoordinateDistance;
 import edu.ie3.util.geo.GeoUtils;
 import java.util.*;
+import javax.measure.quantity.Length;
 import org.locationtech.jts.geom.Point;
+import tech.units.indriya.ComparableQuantity;
 
 /**
  * This class serves mapping purposes between the ID of a coordinate and the actual coordinate with
  * latitude and longitude values, which is especially needed for data source that don't offer
  * combined primary or foreign keys.
  */
 public interface IdCoordinateSource extends DataSource {
+  double earthRadius = 6378137.0;
 
   /**
    * Get the matching coordinate for the given ID
@@ -56,9 +59,8 @@ public interface IdCoordinateSource extends DataSource {
    * @param n how many neighbours to look up
    * @return the n nearest coordinates to the given point
    */
-  default List<CoordinateDistance> getNearestCoordinates(Point coordinate, int n) {
-    return getNearestCoordinates(coordinate, n, getAllCoordinates());
-  }
+  List<CoordinateDistance> getNearestCoordinates(
+      Point coordinate, int n, ComparableQuantity<Length> distance);
 
   /**
    * Returns the nearest n coordinate points to the given coordinate from a given collection of
@@ -75,6 +77,94 @@ default List<CoordinateDistance> getNearestCoordinates(
         GeoUtils.calcOrderedCoordinateDistances(
             coordinate,
             (coordinates != null && !coordinates.isEmpty()) ? coordinates : getAllCoordinates());
-    return sortedDistances.stream().limit(n).toList();
+    return restrictToBoundingBoxWithSetNumberOfCorner(coordinate, sortedDistances, n);
+  }
+
+  /**
+   * Method to turn a distance into a latitude and longitude deltas. The methode can be found here:
+   * <a href="https://math.stackexchange.com/questions/474602/reverse-use-of-haversine-formula">
+   *
+   * @param coordinate the coordinate at the center of the bounding box.
+   * @return x- and y-delta in degree
+   */
+  default double[] calculateXYDelta(Point coordinate, ComparableQuantity<Length> distance) {
+    // y-degrees are evenly spaced, so we can just divide a distance
+    // by the earth's radius to get a y-delta in radians
+    double deltaY = distance.getValue().doubleValue() / earthRadius;
+
+    // because the spacing between x-degrees change between the equator
+    // and the poles, we need to calculate the x-delta using the inverse
+    // haversine formula
+    double sinus = Math.sin(deltaY / 2);
+    double squaredSinus = sinus * sinus;
+    double cosine = Math.cos(Math.toRadians(coordinate.getY()));
+    double squaredCosine = cosine * cosine;
+
+    double deltaX = 2 * Math.asin(Math.sqrt(squaredSinus / squaredCosine));
+
+    // converting the deltas to degree and returning them
+    return new double[] {Math.toDegrees(deltaX), Math.toDegrees(deltaY)};
+  }
+
+  /**
+   * Method for evaluating the found points and returning the n corner points of the bounding box.
+   *
+   * @param coordinate at the center of the bounding box
+   * @param distances list of found points with their distances
+   * @param numberOfPoints that should be returned
+   * @return list of distances
+   */
+  default List<CoordinateDistance> restrictToBoundingBoxWithSetNumberOfCorner(
+      Point coordinate, Collection<CoordinateDistance> distances, int numberOfPoints) {
+    boolean topLeft = false;
+    boolean topRight = false;
+    boolean bottomLeft = false;
+    boolean bottomRight = false;
+
+    List<CoordinateDistance> resultingDistances = new ArrayList<>();
+    List<CoordinateDistance> other = new ArrayList<>();
+
+    // search for smallest bounding box
+    for (CoordinateDistance distance : distances) {
+      Point point = distance.getCoordinateB();
+
+      // check for bounding box
+      if (!topLeft && (point.getX() < coordinate.getX() && point.getY() > coordinate.getY())) {
+        resultingDistances.add(distance);
+        topLeft = true;
+      } else if (!topRight
+          && (point.getX() > coordinate.getX() && point.getY() > coordinate.getY())) {
+        resultingDistances.add(distance);
+        topRight = true;
+      } else if (!bottomLeft
+          && (point.getX() < coordinate.getX() && point.getY() < coordinate.getY())) {
+        resultingDistances.add(distance);
+        bottomLeft = true;
+      } else if (!bottomRight
+          && (point.getX() > coordinate.getX() && point.getY() < coordinate.getY())) {
+        resultingDistances.add(distance);
+        bottomRight = true;
+      } else if (coordinate.equalsExact(point, 1e-6)) {
+        // if current point is matching the given coordinate, we need to return only the current
+        // point
+
+        resultingDistances.clear();
+        resultingDistances.add(distance);
+        return resultingDistances;
+      } else {
+        other.add(distance);
+      }
+    }
+
+    // check if n distances are found
+    int diff = numberOfPoints - resultingDistances.size();
+
+    if (diff > 0) {
+      resultingDistances.addAll(other.stream().limit(diff).toList());
+    } else if (diff < 0) {
+      return resultingDistances.stream().limit(numberOfPoints).toList();
+    }
+
+    return resultingDistances;
   }
 }

src/main/java/edu/ie3/datamodel/io/source/csv/CsvIdCoordinateSource.java

@@ -9,14 +9,17 @@
 import edu.ie3.datamodel.io.factory.timeseries.IdCoordinateFactory;
 import edu.ie3.datamodel.io.naming.FileNamingStrategy;
 import edu.ie3.datamodel.io.source.IdCoordinateSource;
+import edu.ie3.util.geo.CoordinateDistance;
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import javax.measure.quantity.Length;
 import org.apache.commons.lang3.tuple.Pair;
 import org.locationtech.jts.geom.Point;
+import tech.units.indriya.ComparableQuantity;
 
 /**
  * Implementation of {@link IdCoordinateSource} to read the mapping between coordinate id and actual
@@ -38,7 +41,7 @@ public CsvIdCoordinateSource(
 
     this.factory = factory;
 
-    /* setup the coordinate id to lat/long mapping */
+    /* set up the coordinate id to lat/long mapping */
     idToCoordinate = setupIdToCoordinateMap();
     coordinateToId = invert(idToCoordinate);
   }
@@ -93,6 +96,32 @@ public Collection<Point> getAllCoordinates() {
     return coordinateToId.keySet();
   }
 
+  @Override
+  public List<CoordinateDistance> getNearestCoordinates(
+      Point coordinate, int n, ComparableQuantity<Length> distance) {
+    Set<Point> points = coordinateToId.keySet();
+
+    double[] deltas = calculateXYDelta(coordinate, distance);
+
+    double xMin = coordinate.getX() - deltas[0];
+    double xMax = coordinate.getX() + deltas[0];
+    double yMin = coordinate.getY() - deltas[1];
+    double yMax = coordinate.getY() + deltas[1];
+
+    Set<Point> reducedPoints = new HashSet<>();
+
+    for (Point point : points) {
+      double x = point.getX();
+      double y = point.getY();
+
+      if (xMin <= x && x <= xMax && yMin <= y && y <= yMax) {
+        reducedPoints.add(point);
+      }
+    }
+
+    return getNearestCoordinates(coordinate, n, reducedPoints);
+  }
+
   public int getCoordinateCount() {
     return idToCoordinate.keySet().size();
   }

src/main/java/edu/ie3/datamodel/io/source/sql/SqlDataSource.java

@@ -37,6 +37,33 @@ protected static String createBaseQueryString(String schemaName, String tableNam
     return "SELECT * FROM " + schemaName + ".\"" + tableName + "\"";
   }
 
+  /**
+   * Creates a base query string without closing semicolon of the following pattern: <br>
+   * {@code SELECT 'idColumnName', ST_X('geomColumnName'), ST_Y('geomColumnName') FROM
+   * <schema>.<table>}
+   *
+   * @param schemaName the name of the database schema
+   * @param tableName the name of the database table
+   * @param idColumnName the name of the id column
+   * @param geomColumnName the name of the geometry column
+   * @return basic query string without semicolon
+   */
+  protected static String createBaseGisQueryString(
+      String schemaName, String tableName, String idColumnName, String geomColumnName) {
+    return "SELECT "
+        + idColumnName
+        + ", ST_X("
+        + geomColumnName
+        + "), ST_Y("
+        + geomColumnName
+        + ")"
+        + " FROM "
+        + schemaName
+        + ".\""
+        + tableName
+        + "\"";
+  }
+
   /**
    * Determine the corresponding database column name based on the provided factory field parameter
    * name. Needed to support camel as well as snake case database column names.