Small improvements to IdCoordinateInput.

staudtMarius · staudtMarius · commit dd6b1115fa08 · 2024-02-27T07:49:45.000+01:00
diff --git a/docs/readthedocs/io/ValidationUtils.md b/docs/readthedocs/io/ValidationUtils.md
@@ -65,7 +65,7 @@ The ValidationUtils include validation checks for...
         - PvInput
         - StorageInput
         - WecInput
-        - EvcsInput (also checks EvcsTypeInput/ChargingPointType)
+        - EvcsInput (also checks ChargingPointType)
     - SystemParticipantTypeInput
         - BmTypeInput
         - ChpTypeInput
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/CosmoIdCoordinateFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/CosmoIdCoordinateFactory.java
@@ -6,7 +6,7 @@
 package edu.ie3.datamodel.io.factory.timeseries;
 
 import edu.ie3.datamodel.io.factory.SimpleFactoryData;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import java.util.Collections;
 import java.util.List;
 import java.util.Set;
@@ -24,11 +24,11 @@ public class CosmoIdCoordinateFactory extends IdCoordinateFactory {
   private static final String LAT_ROT = "latRot";
 
   @Override
-  protected IdCoordinatePair buildModel(SimpleFactoryData data) {
+  protected IdCoordinateInput buildModel(SimpleFactoryData data) {
     int coordinateId = data.getInt(COORDINATE_ID);
     double lat = data.getDouble(LAT_GEO);
     double lon = data.getDouble(LONG_GEO);
-    return IdCoordinatePair.of(coordinateId, lat, lon);
+    return new IdCoordinateInput(coordinateId, lat, lon);
   }
 
   @Override
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IconIdCoordinateFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IconIdCoordinateFactory.java
@@ -6,7 +6,7 @@
 package edu.ie3.datamodel.io.factory.timeseries;
 
 import edu.ie3.datamodel.io.factory.SimpleFactoryData;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import java.util.Collections;
 import java.util.List;
 import java.util.Set;
@@ -22,11 +22,11 @@ public class IconIdCoordinateFactory extends IdCoordinateFactory {
   private static final String TYPE = "coordinateType";
 
   @Override
-  protected IdCoordinatePair buildModel(SimpleFactoryData data) {
+  protected IdCoordinateInput buildModel(SimpleFactoryData data) {
     int coordinateId = data.getInt(COORDINATE_ID);
     double lat = data.getDouble(LAT);
     double lon = data.getDouble(LONG);
-    return IdCoordinatePair.of(coordinateId, lat, lon);
+    return new IdCoordinateInput(coordinateId, lat, lon);
   }
 
   @Override
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/IdCoordinateFactory.java
@@ -7,16 +7,16 @@
 
 import edu.ie3.datamodel.io.factory.Factory;
 import edu.ie3.datamodel.io.factory.SimpleFactoryData;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 
 /**
  * Abstract class definition for a factory, that is able to build single mapping entries from
  * coordinate identifier to actual coordinate
  */
 public abstract class IdCoordinateFactory
-    extends Factory<IdCoordinatePair, SimpleFactoryData, IdCoordinatePair> {
+    extends Factory<IdCoordinateInput, SimpleFactoryData, IdCoordinateInput> {
   protected IdCoordinateFactory() {
-    super(IdCoordinatePair.class);
+    super(IdCoordinateInput.class);
   }
 
   /** @return the field id for the coordinate id */
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/timeseries/SqlIdCoordinateFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/timeseries/SqlIdCoordinateFactory.java
@@ -7,7 +7,7 @@
 
 import edu.ie3.datamodel.exceptions.FactoryException;
 import edu.ie3.datamodel.io.factory.SimpleFactoryData;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import edu.ie3.util.geo.GeoUtils;
 import java.util.Collections;
 import java.util.List;
@@ -23,15 +23,15 @@ public class SqlIdCoordinateFactory extends IdCoordinateFactory {
   private final WKBReader reader = new WKBReader();
 
   @Override
-  protected IdCoordinatePair buildModel(SimpleFactoryData data) {
+  protected IdCoordinateInput buildModel(SimpleFactoryData data) {
     try {
       int coordinateId = data.getInt(COORDINATE_ID);
       byte[] byteArr = WKBReader.hexToBytes(data.getField(COORDINATE));
 
       Coordinate coordinate = reader.read(byteArr).getCoordinate();
 
       Point point = GeoUtils.buildPoint(coordinate);
-      return IdCoordinatePair.of(coordinateId, point);
+      return new IdCoordinateInput(coordinateId, point);
 
     } catch (ParseException e) {
       throw new FactoryException(e);
diff --git a/src/main/java/edu/ie3/datamodel/io/processor/input/InputEntityProcessor.java b/src/main/java/edu/ie3/datamodel/io/processor/input/InputEntityProcessor.java
@@ -37,6 +37,7 @@ public class InputEntityProcessor extends EntityProcessor<InputEntity> {
           OperatorInput.class,
           RandomLoadParameters.class,
           TimeSeriesMappingSource.MappingEntry.class,
+          IdCoordinateInput.class,
           /* - AssetInput */
           NodeInput.class,
           LineInput.class,
diff --git a/src/main/java/edu/ie3/datamodel/io/source/csv/CsvIdCoordinateSource.java b/src/main/java/edu/ie3/datamodel/io/source/csv/CsvIdCoordinateSource.java
@@ -11,7 +11,7 @@
 import edu.ie3.datamodel.io.factory.SimpleFactoryData;
 import edu.ie3.datamodel.io.factory.timeseries.IdCoordinateFactory;
 import edu.ie3.datamodel.io.source.IdCoordinateSource;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import edu.ie3.datamodel.utils.Try;
 import edu.ie3.datamodel.utils.Try.*;
 import edu.ie3.datamodel.utils.validation.UniquenessValidationUtils;
@@ -24,7 +24,6 @@
 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.Envelope;
 import org.locationtech.jts.geom.Point;
 import org.slf4j.Logger;
@@ -65,13 +64,13 @@ public CsvIdCoordinateSource(IdCoordinateFactory factory, CsvDataSource dataSour
    * @return Mapping from coordinate id to coordinate
    */
   private Map<Integer, Point> setupIdToCoordinateMap() throws SourceException {
-    List<IdCoordinatePair> pairs =
+    List<IdCoordinateInput> idCoordinates =
         buildStreamWithFieldsToAttributesMap()
             .map(
                 data ->
                     data.map(
                             fieldToValues ->
-                                new SimpleFactoryData(fieldToValues, IdCoordinatePair.class))
+                                new SimpleFactoryData(fieldToValues, IdCoordinateInput.class))
                         .map(factory::get))
             .flatMap(
                 s -> Try.scanStream(s, "Pair<Integer, Point>").transformF(SourceException::new))
@@ -80,12 +79,13 @@ private Map<Integer, Point> setupIdToCoordinateMap() throws SourceException {
 
     try {
       // check the uniqueness of the source
-      UniquenessValidationUtils.checkIdCoordinateUniqueness(pairs);
+      UniquenessValidationUtils.checkIdCoordinateUniqueness(idCoordinates);
     } catch (DuplicateEntitiesException de) {
       throw new SourceException("Due to: ", de);
     }
 
-    return pairs.stream().collect(Collectors.toMap(Pair::getKey, Pair::getValue));
+    return idCoordinates.stream()
+        .collect(Collectors.toMap(IdCoordinateInput::id, IdCoordinateInput::point));
   }
 
   /**
@@ -187,7 +187,7 @@ public int getCoordinateCount() {
       final String[] headline = dataSource.parseCsvRow(reader.readLine(), dataSource.csvSep);
 
       // validating read file
-      factory.validate(Set.of(headline), IdCoordinatePair.class).getOrThrow();
+      factory.validate(Set.of(headline), IdCoordinateInput.class).getOrThrow();
 
       // by default try-with-resources closes the reader directly when we leave this method (which
       // is wanted to avoid a lock on the file), but this causes a closing of the stream as well.
diff --git a/src/main/java/edu/ie3/datamodel/io/source/sql/SqlIdCoordinateSource.java b/src/main/java/edu/ie3/datamodel/io/source/sql/SqlIdCoordinateSource.java
@@ -13,7 +13,7 @@
 import edu.ie3.datamodel.io.factory.timeseries.SqlIdCoordinateFactory;
 import edu.ie3.datamodel.io.naming.DatabaseNamingStrategy;
 import edu.ie3.datamodel.io.source.IdCoordinateSource;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import edu.ie3.datamodel.models.value.CoordinateValue;
 import edu.ie3.datamodel.utils.Try;
 import edu.ie3.util.geo.CoordinateDistance;
@@ -66,7 +66,7 @@ public SqlIdCoordinateSource(
                     .map(
                         fields ->
                             factory
-                                .validate(fields, IdCoordinatePair.class)
+                                .validate(fields, IdCoordinateInput.class)
                                 .transformF(SourceException::new))
                     .orElse(Try.Success.empty()))
         .getOrThrow();
@@ -201,10 +201,10 @@ private CoordinateValue createCoordinateValue(Map<String, String> fieldToValues)
     fieldToValues.remove("distance");
 
     SimpleFactoryData simpleFactoryData =
-        new SimpleFactoryData(fieldToValues, IdCoordinatePair.class);
+        new SimpleFactoryData(fieldToValues, IdCoordinateInput.class);
 
-    IdCoordinatePair pair = factory.get(simpleFactoryData).getOrThrow();
-    return new CoordinateValue(pair.getKey(), pair.getValue());
+    IdCoordinateInput idCoordinate = factory.get(simpleFactoryData).getOrThrow();
+    return new CoordinateValue(idCoordinate.id(), idCoordinate.point());
   }
 
   private List<CoordinateValue> executeQueryToList(
diff --git a/src/main/java/edu/ie3/datamodel/models/input/IdCoordinateInput.java b/src/main/java/edu/ie3/datamodel/models/input/IdCoordinateInput.java
@@ -0,0 +1,22 @@
+/*
+ * © 2024. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.models.input;
+
+import edu.ie3.util.geo.GeoUtils;
+import org.locationtech.jts.geom.Point;
+
+public record IdCoordinateInput(Integer id, Point point) implements InputEntity {
+  /**
+   * Constructor for an {@link IdCoordinateInput}.
+   *
+   * @param id of the pair
+   * @param lat of the pair
+   * @param lon of the pair
+   */
+  public IdCoordinateInput(Integer id, double lat, double lon) {
+    this(id, GeoUtils.buildPoint(lat, lon));
+  }
+}
diff --git a/src/main/java/edu/ie3/datamodel/models/input/IdCoordinatePair.java b/src/main/java/edu/ie3/datamodel/models/input/IdCoordinatePair.java
diff --git a/src/main/java/edu/ie3/datamodel/utils/validation/UniquenessValidationUtils.java b/src/main/java/edu/ie3/datamodel/utils/validation/UniquenessValidationUtils.java
@@ -10,7 +10,7 @@
 import edu.ie3.datamodel.models.Entity;
 import edu.ie3.datamodel.models.UniqueEntity;
 import edu.ie3.datamodel.models.input.AssetInput;
-import edu.ie3.datamodel.models.input.IdCoordinatePair;
+import edu.ie3.datamodel.models.input.IdCoordinateInput;
 import edu.ie3.datamodel.models.result.ResultEntity;
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
 import edu.ie3.datamodel.models.value.WeatherValue;
@@ -31,8 +31,8 @@ public class UniquenessValidationUtils extends ValidationUtils {
       entity -> Set.of(entity.getTime(), entity.getInputModel());
   protected static final FieldSetSupplier<MappingEntry> mappingFieldSupplier =
       entity -> Set.of(entity.participant());
-  protected static final FieldSetSupplier<IdCoordinatePair> idCoordinateSupplier =
-      pair -> Set.of(pair.getKey(), pair.getValue());
+  protected static final FieldSetSupplier<IdCoordinateInput> idCoordinateSupplier =
+      entity -> Set.of(entity.id(), entity.point());
   protected static final FieldSetSupplier<TimeBasedValue<WeatherValue>> weatherValueFieldSupplier =
       entity -> Set.of(entity.getTime(), entity.getValue().getCoordinate());
 
@@ -96,7 +96,7 @@ public static void checkMappingEntryUniqueness(Collection<MappingEntry> entities
    * @param entities to be checked
    * @throws DuplicateEntitiesException if uniqueness is violated
    */
-  public static void checkIdCoordinateUniqueness(Collection<IdCoordinatePair> entities)
+  public static void checkIdCoordinateUniqueness(Collection<IdCoordinateInput> entities)
       throws DuplicateEntitiesException {
     checkUniqueness(entities, idCoordinateSupplier).getOrThrow();
   }
diff --git a/src/test/groovy/edu/ie3/datamodel/io/factory/timeseries/CosmoIdCoordinateFactoryTest.groovy b/src/test/groovy/edu/ie3/datamodel/io/factory/timeseries/CosmoIdCoordinateFactoryTest.groovy
@@ -6,7 +6,7 @@
 package edu.ie3.datamodel.io.factory.timeseries
 
 import edu.ie3.datamodel.io.factory.SimpleFactoryData
-import edu.ie3.datamodel.models.input.IdCoordinatePair
+import edu.ie3.datamodel.models.input.IdCoordinateInput
 import edu.ie3.util.geo.GeoUtils
 import spock.lang.Shared
 import spock.lang.Specification
@@ -31,7 +31,7 @@ class CosmoIdCoordinateFactoryTest extends Specification {
     ] as Set
 
     when:
-    def actual = factory.getFields(IdCoordinatePair)
+    def actual = factory.getFields(IdCoordinateInput)
 
     then:
     actual.size() == 1
@@ -43,12 +43,12 @@ class CosmoIdCoordinateFactoryTest extends Specification {
     def actualFields = CosmoIdCoordinateFactory.newSet("tid", "id", "latrot", "longrot")
 
     when:
-    def actual = factory.validate(actualFields, IdCoordinatePair)
+    def actual = factory.validate(actualFields, IdCoordinateInput)
 
     then:
     actual.failure
-    actual.exception.get().message == "The provided fields [id, latrot, longrot, tid] are invalid for instance of 'IdCoordinatePair'. \n" +
-        "The following fields (without complex objects e.g. nodes, operators, ...) to be passed to a constructor of 'IdCoordinatePair' are possible (NOT case-sensitive!):\n" +
+    actual.exception.get().message == "The provided fields [id, latrot, longrot, tid] are invalid for instance of 'IdCoordinateInput'. \n" +
+        "The following fields (without complex objects e.g. nodes, operators, ...) to be passed to a constructor of 'IdCoordinateInput' are possible (NOT case-sensitive!):\n" +
         "0: [id, latGeo, latRot, longGeo, longRot, tid] or [id, lat_geo, lat_rot, long_geo, long_rot, tid]\n"
   }
 
@@ -63,17 +63,17 @@ class CosmoIdCoordinateFactoryTest extends Specification {
       "longRot": "-6.8125"
     ]
 
-    def validSimpleFactoryData = new SimpleFactoryData(parameter, IdCoordinatePair)
-    IdCoordinatePair expectedPair = IdCoordinatePair.of(106580, GeoUtils.buildPoint(39.602772, 1.279336))
+    def validSimpleFactoryData = new SimpleFactoryData(parameter, IdCoordinateInput)
+    IdCoordinateInput expectedIdCoordinate = new IdCoordinateInput(106580, GeoUtils.buildPoint(39.602772, 1.279336))
 
     when:
     def actual = factory.get(validSimpleFactoryData)
 
     then:
     actual.success
     actual.data.get().with {
-      assert it.key == expectedPair.key
-      assert it.value.equalsExact(expectedPair.value, 1E-6)
+      assert it.id() == expectedIdCoordinate.id()
+      assert it.point().equalsExact(expectedIdCoordinate.point(), 1E-6)
     }
   }
 }
diff --git a/src/test/groovy/edu/ie3/datamodel/io/factory/timeseries/IconIdCoordinateFactoryTest.groovy b/src/test/groovy/edu/ie3/datamodel/io/factory/timeseries/IconIdCoordinateFactoryTest.groovy
diff --git a/src/test/groovy/edu/ie3/datamodel/io/processor/ProcessorProviderTest.groovy b/src/test/groovy/edu/ie3/datamodel/io/processor/ProcessorProviderTest.groovy
