Merge branch 'dev' into ms/#1007-refactor-CsvFileConnector-and-CsvDataSource

Author: staudtMarius

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+## [5.0.1] - 2024-03-07
+
+### Fixed
+- Fixed `equals` of `ResultEntity` and `TimeSeriesEntry` [#1037](https://github.com/ie3-institute/PowerSystemDataModel/issues/1037)
+
+## [5.0.0] - 2024-03-06
+
 ### Added
 - Formatting Spotless Groovy import order [#960](https://github.com/ie3-institute/PowerSystemDataModel/issues/960)
 - Implementing missing typical methods in `Try` [#970](https://github.com/ie3-institute/PowerSystemDataModel/issues/970)
@@ -271,7 +278,9 @@ coordinates or multiple exactly equal coordinates possible
 -   CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
 -   CsvDataSource now parsing multiple geoJson strings correctly
 
-[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.1.0...HEAD
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.0.1...HEAD
+[5.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/5.0.0...5.0.1
+[4.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.1.0...5.0.0
 [4.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.0.0...4.1.0
 [4.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/3.0.0...4.0.0
 [3.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.1.0...3.0.0

build.gradle

@@ -18,7 +18,7 @@ ext {
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
   groovyBinaryVersion = "4.0.19"
-  testcontainersVersion = '1.19.6'
+  testcontainersVersion = '1.19.7'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
@@ -53,7 +53,7 @@ repositories {
 dependencies {
 
   //	 ie³ power system utils
-  implementation 'com.github.ie3-institute:PowerSystemUtils:2.2'
+  implementation 'com.github.ie3-institute:PowerSystemUtils:2.2.1'
 
   implementation 'tech.units:indriya:2.2'
 

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -83,10 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,26 +131,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -197,11 +198,15 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

gradlew

@@ -51,6 +51,9 @@ public static Set<UniqueInputEntity> extractElements(NestedEntity nestedEntity)
     if (nestedEntity instanceof HasLine nestedHasLine) {
       resultingList.add(nestedHasLine.getLine());
     }
+    if (nestedEntity instanceof HasEm nestedHasEms) {
+      nestedHasEms.getControllingEm().ifPresent(resultingList::add);
+    }
 
     if (resultingList.contains(null)) {
       log.warn(

src/main/java/edu/ie3/datamodel/io/extractor/Extractor.java

@@ -0,0 +1,18 @@
+/*
+ * © 2024. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.extractor;
+
+import edu.ie3.datamodel.models.input.EmInput;
+import java.util.Optional;
+
+/**
+ * Interface that should be implemented by all elements that can be controlled by {@link
+ * edu.ie3.datamodel.models.input.EmInput} elements and should be processable by the {@link
+ * Extractor}.
+ */
+public interface HasEm extends NestedEntity {
+  Optional<EmInput> getControllingEm();
+}

src/main/java/edu/ie3/datamodel/io/extractor/HasEm.java

@@ -95,7 +95,7 @@ List<CoordinateDistance> getClosestCoordinates(
   default List<CoordinateDistance> calculateCoordinateDistances(
       Point coordinate, int n, Collection<Point> coordinates) {
     if (coordinates != null && !coordinates.isEmpty()) {
-      SortedSet<CoordinateDistance> sortedDistances =
+      List<CoordinateDistance> sortedDistances =
           GeoUtils.calcOrderedCoordinateDistances(coordinate, coordinates);
       return restrictToBoundingBox(coordinate, sortedDistances, n);
     } else {

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

@@ -5,13 +5,14 @@
 */
 package edu.ie3.datamodel.models.input;
 
+import edu.ie3.datamodel.io.extractor.HasEm;
 import edu.ie3.datamodel.models.OperationTime;
 import edu.ie3.datamodel.models.UniqueEntity;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.UUID;
 
-public class EmInput extends AssetInput {
+public class EmInput extends AssetInput implements HasEm {
 
   /** Reference to the control strategy to be used for this model */
   private final String controlStrategy;
@@ -20,7 +21,7 @@ public class EmInput extends AssetInput {
    * Optional UUID of the parent {@link EmInput} that is controlling this em unit. If null, this em
    * unit is not em-controlled.
    */
-  private final EmInput parentEm;
+  private final EmInput controllingEm;
 
   /**
    * Constructor for an operated energy management system
@@ -30,18 +31,18 @@ public class EmInput extends AssetInput {
    * @param operator of the asset
    * @param operationTime time for which the entity is operated
    * @param emControlStrategy the control strategy
-   * @param parentEm The {@link EmInput} controlling this em unit. Null, if not applicable.
+   * @param controllingEm The {@link EmInput} controlling this em unit. Null, if not applicable.
    */
   public EmInput(
       UUID uuid,
       String id,
       OperatorInput operator,
       OperationTime operationTime,
       String emControlStrategy,
-      EmInput parentEm) {
+      EmInput controllingEm) {
     super(uuid, id, operator, operationTime);
     this.controlStrategy = emControlStrategy;
-    this.parentEm = parentEm;
+    this.controllingEm = controllingEm;
   }
 
   /**
@@ -50,22 +51,18 @@ public EmInput(
    * @param uuid of the input entity
    * @param id of the asset
    * @param emControlStrategy the control strategy
-   * @param parentEm The {@link EmInput} controlling this em unit. Null, if not applicable.
+   * @param controllingEm The {@link EmInput} controlling this em unit. Null, if not applicable.
    */
-  public EmInput(UUID uuid, String id, String emControlStrategy, EmInput parentEm) {
+  public EmInput(UUID uuid, String id, String emControlStrategy, EmInput controllingEm) {
     super(uuid, id);
     this.controlStrategy = emControlStrategy;
-    this.parentEm = parentEm;
+    this.controllingEm = controllingEm;
   }
 
   public String getControlStrategy() {
     return controlStrategy;
   }
 
-  public Optional<EmInput> getParentEm() {
-    return Optional.ofNullable(parentEm);
-  }
-
   @Override
   public EmInputCopyBuilder copy() {
     return new EmInputCopyBuilder(this);
@@ -77,12 +74,12 @@ public boolean equals(Object o) {
     if (!(o instanceof EmInput emInput)) return false;
     if (!super.equals(o)) return false;
     return Objects.equals(controlStrategy, emInput.controlStrategy)
-        && Objects.equals(parentEm, emInput.parentEm);
+        && Objects.equals(controllingEm, emInput.controllingEm);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(super.hashCode(), controlStrategy, parentEm);
+    return Objects.hash(super.hashCode(), controlStrategy, controllingEm);
   }
 
   @Override
@@ -92,15 +89,20 @@ public String toString() {
         + getUuid()
         + ", id='"
         + getId()
-        + ", operator="
+        + "', operator="
         + getOperator().getUuid()
         + ", operationTime="
         + getOperationTime()
         + ", controlStrategy="
         + getControlStrategy()
-        + ", parentEm="
-        + getParentEm().map(UniqueEntity::getUuid).map(UUID::toString).orElse("")
-        + '}';
+        + ", controllingEm="
+        + getControllingEm().map(UniqueEntity::getUuid).map(UUID::toString).orElse("")
+        + "}";
+  }
+
+  @Override
+  public Optional<EmInput> getControllingEm() {
+    return Optional.ofNullable(controllingEm);
   }
 
   public static class EmInputCopyBuilder extends AssetInputCopyBuilder<EmInputCopyBuilder> {
@@ -112,7 +114,7 @@ public static class EmInputCopyBuilder extends AssetInputCopyBuilder<EmInputCopy
     protected EmInputCopyBuilder(EmInput entity) {
       super(entity);
       this.controlStrategy = entity.getControlStrategy();
-      this.parentEm = entity.parentEm;
+      this.parentEm = entity.controllingEm;
     }
 
     public EmInputCopyBuilder controlStrategy(String controlStrategy) {

src/main/java/edu/ie3/datamodel/models/input/EmInput.java

@@ -150,7 +150,7 @@ public String toString() {
         + ", qCharacteristics='"
         + getqCharacteristics()
         + "', em="
-        + getEm()
+        + getControllingEm()
         + ", type="
         + type.getUuid()
         + ", marketReaction="