refactor with ThermalSystemParticipant to comply with sonar

Author: danielfeismann

src/main/java/edu/ie3/datamodel/io/factory/input/participant/AcInputEntityData.java

@@ -12,19 +12,16 @@
 import edu.ie3.datamodel.models.input.system.type.AcTypeInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import java.util.Map;
-import java.util.Objects;
 
-public class AcInputEntityData extends SystemParticipantTypedEntityData<AcTypeInput> {
-  private final ThermalBusInput thermalBusInput;
+public class AcInputEntityData extends ThermalSystemParticipantEntityData<AcTypeInput> {
 
   public AcInputEntityData(
       Map<String, String> fieldsToAttributes,
       NodeInput node,
       EmInput em,
       AcTypeInput typeInput,
       ThermalBusInput thermalBusInput) {
-    super(fieldsToAttributes, AcInput.class, node, em, typeInput);
-    this.thermalBusInput = thermalBusInput;
+    super(fieldsToAttributes, AcInput.class, node, em, typeInput, thermalBusInput);
   }
 
   public AcInputEntityData(
@@ -34,8 +31,7 @@ public AcInputEntityData(
       EmInput em,
       AcTypeInput typeInput,
       ThermalBusInput thermalBusInput) {
-    super(fieldsToAttributes, AcInput.class, operator, node, em, typeInput);
-    this.thermalBusInput = thermalBusInput;
+    super(fieldsToAttributes, AcInput.class, operator, node, em, typeInput, thermalBusInput);
   }
 
   /**
@@ -47,42 +43,11 @@ public AcInputEntityData(
    */
   public AcInputEntityData(
       SystemParticipantTypedEntityData<AcTypeInput> entityData, ThermalBusInput thermalBusInput) {
-    super(entityData, entityData.getTypeInput());
-    this.thermalBusInput = thermalBusInput;
-  }
-
-  public ThermalBusInput getThermalBusInput() {
-    return thermalBusInput;
-  }
-
-  @Override
-  public boolean equals(Object o) {
-    if (this == o) return true;
-    if (!(o instanceof AcInputEntityData that)) return false;
-    if (!super.equals(o)) return false;
-    return thermalBusInput.equals(that.thermalBusInput);
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(super.hashCode(), thermalBusInput);
+    super(entityData, thermalBusInput);
   }
 
   @Override
   public String toString() {
-    return "AcInputEntityData{"
-        + "thermalBusInput="
-        + thermalBusInput.getUuid()
-        + ", typeInput="
-        + getTypeInput().getUuid()
-        + ", node="
-        + getNode().getUuid()
-        + ", operatorInput="
-        + getOperatorInput().getUuid()
-        + ", fieldsToValues="
-        + getFieldsToValues()
-        + ", targetClass="
-        + getTargetClass()
-        + '}';
+    return buildToStringContent("AcInputEntityData");
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/participant/AcInputFactory.java

@@ -11,40 +11,38 @@
 import edu.ie3.datamodel.models.input.OperatorInput;
 import edu.ie3.datamodel.models.input.system.AcInput;
 import edu.ie3.datamodel.models.input.system.characteristic.ReactivePowerCharacteristic;
+import edu.ie3.datamodel.models.input.system.type.AcTypeInput;
+import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import java.util.UUID;
 
 public class AcInputFactory
-    extends SystemParticipantInputEntityFactory<AcInput, AcInputEntityData> {
+    extends ThermalSystemParticipantInputFactory<AcInput, AcInputEntityData> {
 
   public AcInputFactory() {
     super(AcInput.class);
   }
 
   @Override
-  protected String[] getAdditionalFields() {
-    return new String[0];
-  }
-
-  @Override
-  protected AcInput buildModel(
-      AcInputEntityData data,
+  protected AcInput createThermalSystemModel(
       UUID uuid,
       String id,
+      OperatorInput operator,
+      OperationTime operationTime,
       NodeInput node,
+      ThermalBusInput thermalBusInput,
       ReactivePowerCharacteristic qCharacteristics,
-      OperatorInput operator,
-      OperationTime operationTime) {
-    final EmInput em = data.getControllingEm().orElse(null);
+      EmInput em,
+      Object typeInput) {
 
     return new AcInput(
         uuid,
         id,
         operator,
         operationTime,
         node,
-        data.getThermalBusInput(),
+        thermalBusInput,
         qCharacteristics,
         em,
-        data.getTypeInput());
+        (AcTypeInput) typeInput);
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/participant/HpInputEntityData.java

@@ -12,19 +12,16 @@
 import edu.ie3.datamodel.models.input.system.type.HpTypeInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import java.util.Map;
-import java.util.Objects;
 
-public class HpInputEntityData extends SystemParticipantTypedEntityData<HpTypeInput> {
-  private final ThermalBusInput thermalBusInput;
+public class HpInputEntityData extends ThermalSystemParticipantEntityData<HpTypeInput> {
 
   public HpInputEntityData(
       Map<String, String> fieldsToAttributes,
       NodeInput node,
       EmInput em,
       HpTypeInput typeInput,
       ThermalBusInput thermalBusInput) {
-    super(fieldsToAttributes, HpInput.class, node, em, typeInput);
-    this.thermalBusInput = thermalBusInput;
+    super(fieldsToAttributes, HpInput.class, node, em, typeInput, thermalBusInput);
   }
 
   public HpInputEntityData(
@@ -34,8 +31,7 @@ public HpInputEntityData(
       EmInput em,
       HpTypeInput typeInput,
       ThermalBusInput thermalBusInput) {
-    super(fieldsToAttributes, HpInput.class, operator, node, em, typeInput);
-    this.thermalBusInput = thermalBusInput;
+    super(fieldsToAttributes, HpInput.class, operator, node, em, typeInput, thermalBusInput);
   }
 
   /**
@@ -47,42 +43,11 @@ public HpInputEntityData(
    */
   public HpInputEntityData(
       SystemParticipantTypedEntityData<HpTypeInput> entityData, ThermalBusInput thermalBusInput) {
-    super(entityData, entityData.getTypeInput());
-    this.thermalBusInput = thermalBusInput;
-  }
-
-  public ThermalBusInput getThermalBusInput() {
-    return thermalBusInput;
-  }
-
-  @Override
-  public boolean equals(Object o) {
-    if (this == o) return true;
-    if (!(o instanceof HpInputEntityData that)) return false;
-    if (!super.equals(o)) return false;
-    return thermalBusInput.equals(that.thermalBusInput);
-  }
-
-  @Override
-  public int hashCode() {
-    return Objects.hash(super.hashCode(), thermalBusInput);
+    super(entityData, thermalBusInput);
   }
 
   @Override
   public String toString() {
-    return "HpInputEntityData{"
-        + "thermalBusInput="
-        + thermalBusInput.getUuid()
-        + ", typeInput="
-        + getTypeInput().getUuid()
-        + ", node="
-        + getNode().getUuid()
-        + ", operatorInput="
-        + getOperatorInput().getUuid()
-        + ", fieldsToValues="
-        + getFieldsToValues()
-        + ", targetClass="
-        + getTargetClass()
-        + '}';
+    return buildToStringContent("HpInputEntityData");
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/participant/HpInputFactory.java

@@ -11,40 +11,38 @@
 import edu.ie3.datamodel.models.input.OperatorInput;
 import edu.ie3.datamodel.models.input.system.HpInput;
 import edu.ie3.datamodel.models.input.system.characteristic.ReactivePowerCharacteristic;
+import edu.ie3.datamodel.models.input.system.type.HpTypeInput;
+import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
 import java.util.UUID;
 
 public class HpInputFactory
-    extends SystemParticipantInputEntityFactory<HpInput, HpInputEntityData> {
+    extends ThermalSystemParticipantInputFactory<HpInput, HpInputEntityData> {
 
   public HpInputFactory() {
     super(HpInput.class);
   }
 
   @Override
-  protected String[] getAdditionalFields() {
-    return new String[0];
-  }
-
-  @Override
-  protected HpInput buildModel(
-      HpInputEntityData data,
+  protected HpInput createThermalSystemModel(
       UUID uuid,
       String id,
+      OperatorInput operator,
+      OperationTime operationTime,
       NodeInput node,
+      ThermalBusInput thermalBusInput,
       ReactivePowerCharacteristic qCharacteristics,
-      OperatorInput operator,
-      OperationTime operationTime) {
-    final EmInput em = data.getControllingEm().orElse(null);
+      EmInput em,
+      Object typeInput) {
 
     return new HpInput(
         uuid,
         id,
         operator,
         operationTime,
         node,
-        data.getThermalBusInput(),
+        thermalBusInput,
         qCharacteristics,
         em,
-        data.getTypeInput());
+        (HpTypeInput) typeInput);
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/participant/ThermalSystemParticipantEntityData.java

@@ -0,0 +1,97 @@
+/*
+ * © 2021. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.factory.input.participant;
+
+import edu.ie3.datamodel.models.UniqueEntity;
+import edu.ie3.datamodel.models.input.EmInput;
+import edu.ie3.datamodel.models.input.NodeInput;
+import edu.ie3.datamodel.models.input.OperatorInput;
+import edu.ie3.datamodel.models.input.system.type.SystemParticipantTypeInput;
+import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Abstract base class for system participants that connect to thermal buses
+ *
+ * @param <T> The specific type input for the thermal system participant
+ */
+public abstract class ThermalSystemParticipantEntityData<T extends SystemParticipantTypeInput>
+    extends SystemParticipantTypedEntityData<T> {
+
+  private final ThermalBusInput thermalBusInput;
+
+  protected ThermalSystemParticipantEntityData(
+      Map<String, String> fieldsToAttributes,
+      Class<? extends UniqueEntity> targetClass,
+      NodeInput node,
+      EmInput em,
+      T typeInput,
+      ThermalBusInput thermalBusInput) {
+    super(fieldsToAttributes, targetClass, node, em, typeInput);
+    this.thermalBusInput = thermalBusInput;
+  }
+
+  protected ThermalSystemParticipantEntityData(
+      Map<String, String> fieldsToAttributes,
+      Class<? extends UniqueEntity> targetClass,
+      OperatorInput operator,
+      NodeInput node,
+      EmInput em,
+      T typeInput,
+      ThermalBusInput thermalBusInput) {
+    super(fieldsToAttributes, targetClass, operator, node, em, typeInput);
+    this.thermalBusInput = thermalBusInput;
+  }
+
+  /**
+   * Creates a new ThermalSystemParticipantEntityData object based on a given {@link
+   * SystemParticipantTypedEntityData} object and given thermal bus input
+   *
+   * @param entityData The SystemParticipantTypedEntityData object to enhance
+   * @param thermalBusInput The thermal bus input
+   */
+  protected ThermalSystemParticipantEntityData(
+      SystemParticipantTypedEntityData<T> entityData, ThermalBusInput thermalBusInput) {
+    super(entityData, entityData.getTypeInput());
+    this.thermalBusInput = thermalBusInput;
+  }
+
+  public ThermalBusInput getThermalBusInput() {
+    return thermalBusInput;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof ThermalSystemParticipantEntityData<?> that)) return false;
+    if (!super.equals(o)) return false;
+    return Objects.equals(thermalBusInput, that.thermalBusInput);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), thermalBusInput);
+  }
+
+  protected String buildToStringContent(String className) {
+    return className
+        + "{"
+        + "thermalBusInput="
+        + thermalBusInput.getUuid()
+        + ", typeInput="
+        + getTypeInput().getUuid()
+        + ", node="
+        + getNode().getUuid()
+        + ", operatorInput="
+        + getOperatorInput().getUuid()
+        + ", fieldsToValues="
+        + getFieldsToValues()
+        + ", targetClass="
+        + getTargetClass()
+        + '}';
+  }
+}