Merge pull request #1026 from ie3-institute/jb/#1025-persist-emunits

Enable persisting emUnits

Author: sebastian-peter

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

@@ -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/HasEm.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/models/input/EmInput.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/system/BmInput.java

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

src/main/java/edu/ie3/datamodel/models/input/system/ChpInput.java

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

src/main/java/edu/ie3/datamodel/models/input/system/EvInput.java

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

src/main/java/edu/ie3/datamodel/models/input/system/EvcsInput.java

@@ -219,7 +219,7 @@ public String toString() {
         + ", qCharacteristics='"
         + getqCharacteristics()
         + "', em="
-        + getEm()
+        + getControllingEm()
         + ", type="
         + type
         + ", chargingPoints="

src/main/java/edu/ie3/datamodel/models/input/system/FixedFeedInInput.java

@@ -116,7 +116,7 @@ public String toString() {
         + ", qCharacteristics='"
         + getqCharacteristics()
         + "', em="
-        + getEm()
+        + getControllingEm()
         + ", sRated="
         + sRated
         + ", cosphiRated="

src/main/java/edu/ie3/datamodel/models/input/system/HpInput.java

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

src/main/java/edu/ie3/datamodel/models/input/system/LoadInput.java

@@ -255,7 +255,7 @@ public String toString() {
         + ", qCharacteristics='"
         + getqCharacteristics()
         + "', em="
-        + getEm()
+        + getControllingEm()
         + ", dsm="
         + dsm
         + ", eConsAnnual="