review

Author: jo-bao

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

@@ -9,7 +9,7 @@
 import java.util.Optional;
 
 /**
- * Interface that should be implemented by all elements holding one or more {@link
+ * 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}.
  */

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

@@ -21,7 +21,7 @@ public class EmInput extends AssetInput implements HasEm {
    * 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
@@ -31,18 +31,18 @@ public class EmInput extends AssetInput implements HasEm {
    * @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;
   }
 
   /**
@@ -51,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);
@@ -78,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
@@ -100,13 +96,13 @@ public String toString() {
         + ", controlStrategy="
         + getControlStrategy()
         + ", parentEm="
-        + getParentEm().map(UniqueEntity::getUuid).map(UUID::toString).orElse("")
+        + getControllingEm().map(UniqueEntity::getUuid).map(UUID::toString).orElse("")
         + "}";
   }
 
   @Override
   public Optional<EmInput> getControllingEm() {
-    return Optional.ofNullable(parentEm);
+    return Optional.ofNullable(controllingEm);
   }
 
   public static class EmInputCopyBuilder extends AssetInputCopyBuilder<EmInputCopyBuilder> {
@@ -118,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/SystemParticipantInput.java

@@ -85,12 +85,6 @@ public ReactivePowerCharacteristic getqCharacteristics() {
     return qCharacteristics;
   }
 
-  /*
-  public Optional<EmInput> getEm() {
-    return Optional.ofNullable(em);
-  }
-   */
-
   @Override
   public List<NodeInput> allNodes() {
     return Collections.singletonList(node);
@@ -134,7 +128,7 @@ public String toString() {
         + node.getUuid()
         + ", qCharacteristics='"
         + qCharacteristics
-        + "', em="
+        + "', controllingEm="
         + getControllingEm().map(UniqueEntity::getUuid).map(UUID::toString).orElse("")
         + '}';
   }

src/test/groovy/edu/ie3/datamodel/io/extractor/ExtractorTest.groovy

@@ -58,7 +58,7 @@ class ExtractorTest extends Specification {
       sptd.fixedFeedInInput.operator,
       sptd.fixedFeedInInput.node.operator,
       sptd.fixedFeedInInput.controllingEm.get(),
-      sptd.fixedFeedInInput.controllingEm.get().parentEm.get()
+      sptd.fixedFeedInInput.controllingEm.get().controllingEm.get()
     ]
 
     sptd.wecInput              || [
@@ -67,7 +67,7 @@ class ExtractorTest extends Specification {
       sptd.wecInput.operator,
       sptd.wecInput.node.operator,
       sptd.wecInput.controllingEm.get(),
-      sptd.wecInput.controllingEm.get().parentEm.get()
+      sptd.wecInput.controllingEm.get().controllingEm.get()
     ]
     sptd.chpInput              || [
       sptd.chpInput.node,
@@ -78,31 +78,31 @@ class ExtractorTest extends Specification {
       sptd.chpInput.thermalStorage.thermalBus,
       sptd.chpInput.thermalStorage.thermalBus.operator,
       sptd.chpInput.controllingEm.get(),
-      sptd.chpInput.controllingEm.get().parentEm.get()
+      sptd.chpInput.controllingEm.get().controllingEm.get()
     ]
     sptd.bmInput               || [
       sptd.bmInput.node,
       sptd.bmInput.type,
       sptd.bmInput.operator,
       sptd.bmInput.node.operator,
       sptd.bmInput.controllingEm.get(),
-      sptd.bmInput.controllingEm.get().parentEm.get()
+      sptd.bmInput.controllingEm.get().controllingEm.get()
     ]
     sptd.evInput               || [
       sptd.evInput.node,
       sptd.evInput.type,
       sptd.evInput.operator,
       sptd.evInput.node.operator,
       sptd.evInput.controllingEm.get(),
-      sptd.evInput.controllingEm.get().parentEm.get()
+      sptd.evInput.controllingEm.get().controllingEm.get()
     ]
     sptd.storageInput          || [
       sptd.storageInput.node,
       sptd.storageInput.type,
       sptd.storageInput.operator,
       sptd.storageInput.node.operator,
       sptd.storageInput.controllingEm.get(),
-      sptd.storageInput.controllingEm.get().parentEm.get()
+      sptd.storageInput.controllingEm.get().controllingEm.get()
     ]
     sptd.hpInput               || [
       sptd.hpInput.node,
@@ -112,7 +112,7 @@ class ExtractorTest extends Specification {
       sptd.hpInput.thermalBus.operator,
       sptd.hpInput.node.operator,
       sptd.hpInput.controllingEm.get(),
-      sptd.hpInput.controllingEm.get().parentEm.get()
+      sptd.hpInput.controllingEm.get().controllingEm.get()
     ]
 
     gtd.lineGraphicCtoD        || [
@@ -168,7 +168,7 @@ class ExtractorTest extends Specification {
       sptd.fixedFeedInInput.node,
       sptd.fixedFeedInInput.node.operator,
       sptd.fixedFeedInInput.controllingEm.get(),
-      sptd.fixedFeedInInput.controllingEm.get().parentEm.get(),
+      sptd.fixedFeedInInput.controllingEm.get().controllingEm.get(),
       sptd.fixedFeedInInput.controllingEm.get().operator
     ] as Set
   }

src/test/groovy/edu/ie3/datamodel/io/factory/input/participant/EmInputFactoryTest.groovy

@@ -55,7 +55,7 @@ class EmInputFactoryTest extends Specification {
       assert operator == operatorInput
       assert id == parameter["id"]
       assert controlStrategy == parameter["controlstrategy"]
-      assert parentEm == Optional.of(parentEmUnit)
+      assert controllingEm == Optional.of(parentEmUnit)
     }
   }
 
@@ -88,7 +88,7 @@ class EmInputFactoryTest extends Specification {
       assert operator == operatorInput
       assert id == parameter["id"]
       assert controlStrategy == parameter["controlstrategy"]
-      assert parentEm == Optional.empty()
+      assert controllingEm == Optional.empty()
     }
   }
 

src/test/groovy/edu/ie3/datamodel/models/input/system/EmInputTest.groovy

@@ -86,7 +86,7 @@ class EmInputTest extends Specification {
       assert operator == emInput.operator
       assert id == emInput.id
       assert controlStrategy == newStrat
-      assert parentEm == Optional.of(givenParentEm)
+      assert controllingEm == Optional.of(givenParentEm)
     }
   }
 }