Merge branch 'dev' into ns/#81-develop-a-validation-strategy

Author: ckittl

docs/readthedocs/models/input/participant/evcs.rst

@@ -111,7 +111,7 @@ Limitations
 """""""""""
 
 - the available charging types are currently limited to only some common standard charging point types and not configurable
-  via a type file or table. Although providing custom types is possible using the syntax explained above.
+  via a type file or table. Nevertheless, providing custom types is possible using the syntax explained above.
   If there is additional need for a more granular type configuration via type file please contact us.
 - each charging station can hold one or more charging points. If more than one charging point is available
   all attributes (e.g. :code:`sRated` or :code:`connectionType`) are considered to be equal for all connection

src/main/java/edu/ie3/datamodel/models/input/thermal/CylindricalStorageInput.java

@@ -13,7 +13,6 @@
 import java.util.UUID;
 import javax.measure.quantity.Temperature;
 import javax.measure.quantity.Volume;
-import org.apache.commons.lang3.NotImplementedException;
 import tech.units.indriya.ComparableQuantity;
 
 /** Thermal storage with cylindrical shape */
@@ -107,10 +106,8 @@ public ComparableQuantity<SpecificHeatCapacity> getC() {
     return c;
   }
 
-  @Override
-  public UniqueEntityBuilder copy() {
-    throw new NotImplementedException(
-        "Copying of " + this.getClass().getSimpleName() + " entities is not supported yet!");
+  public CylindricalStorageInputCopyBuilder copy() {
+    return new CylindricalStorageInputCopyBuilder(this);
   }
 
   @Override
@@ -157,4 +154,76 @@ public String toString() {
         + c
         + '}';
   }
+
+  /**
+   * A builder pattern based approach to create copies of {@link CylindricalStorageInput} entities
+   * with altered field values. For detailed field descriptions refer to java docs of {@link
+   * CylindricalStorageInput}
+   */
+  public static class CylindricalStorageInputCopyBuilder
+      extends ThermalUnitInput.ThermalUnitInputCopyBuilder<CylindricalStorageInputCopyBuilder> {
+
+    private ComparableQuantity<Volume> storageVolumeLvl;
+    private ComparableQuantity<Volume> storageVolumeLvlMin;
+    private ComparableQuantity<Temperature> inletTemp;
+    private ComparableQuantity<Temperature> returnTemp;
+    private ComparableQuantity<SpecificHeatCapacity> c;
+
+    private CylindricalStorageInputCopyBuilder(CylindricalStorageInput entity) {
+      super(entity);
+      this.storageVolumeLvl = entity.getStorageVolumeLvl();
+      this.storageVolumeLvlMin = entity.getStorageVolumeLvlMin();
+      this.inletTemp = entity.getInletTemp();
+      this.returnTemp = entity.getReturnTemp();
+      this.c = entity.getC();
+    }
+
+    @Override
+    public CylindricalStorageInput build() {
+      return new CylindricalStorageInput(
+          getUuid(),
+          getId(),
+          getOperator(),
+          getOperationTime(),
+          getThermalBus(),
+          storageVolumeLvl,
+          storageVolumeLvlMin,
+          inletTemp,
+          returnTemp,
+          c);
+    }
+
+    public CylindricalStorageInputCopyBuilder storageVolumeLvl(
+        ComparableQuantity<Volume> storageVolumeLvl) {
+      this.storageVolumeLvl = storageVolumeLvl;
+      return this;
+    }
+
+    public CylindricalStorageInputCopyBuilder storageVolumeLvlMin(
+        ComparableQuantity<Volume> storageVolumeLvlMin) {
+      this.storageVolumeLvlMin = storageVolumeLvlMin;
+      return this;
+    }
+
+    public CylindricalStorageInputCopyBuilder inletTemp(ComparableQuantity<Temperature> inletTemp) {
+      this.inletTemp = inletTemp;
+      return this;
+    }
+
+    public CylindricalStorageInputCopyBuilder returnTemp(
+        ComparableQuantity<Temperature> returnTemp) {
+      this.returnTemp = returnTemp;
+      return this;
+    }
+
+    public CylindricalStorageInputCopyBuilder c(ComparableQuantity<SpecificHeatCapacity> c) {
+      this.c = c;
+      return this;
+    }
+
+    @Override
+    protected CylindricalStorageInputCopyBuilder childInstance() {
+      return this;
+    }
+  }
 }

src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalBusInput.java

@@ -9,7 +9,6 @@
 import edu.ie3.datamodel.models.input.AssetInput;
 import edu.ie3.datamodel.models.input.OperatorInput;
 import java.util.UUID;
-import org.apache.commons.lang3.NotImplementedException;
 
 /** A thermal bus, to which different {@link ThermalUnitInput} units may be connected */
 public class ThermalBusInput extends AssetInput {
@@ -36,9 +35,30 @@ public ThermalBusInput(UUID uuid, String id) {
     super(uuid, id);
   }
 
-  @Override
-  public UniqueEntityBuilder copy() {
-    throw new NotImplementedException(
-        "Copying of " + this.getClass().getSimpleName() + " entities is not supported yet!");
+  public ThermalBusInputCopyBuilder copy() {
+    return new ThermalBusInputCopyBuilder(this);
+  }
+
+  /**
+   * A builder pattern based approach to create copies of {@link ThermalBusInput} entities with
+   * altered field values. For detailed field descriptions refer to java docs of {@link
+   * ThermalBusInput}
+   */
+  public static class ThermalBusInputCopyBuilder
+      extends AssetInput.AssetInputCopyBuilder<ThermalBusInputCopyBuilder> {
+
+    private ThermalBusInputCopyBuilder(ThermalBusInput entity) {
+      super(entity);
+    }
+
+    @Override
+    public ThermalBusInput build() {
+      return new ThermalBusInput(getUuid(), getId(), getOperator(), getOperationTime());
+    }
+
+    @Override
+    protected ThermalBusInputCopyBuilder childInstance() {
+      return this;
+    }
   }
 }

src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalHouseInput.java

@@ -12,7 +12,6 @@
 import edu.ie3.util.quantities.interfaces.ThermalConductance;
 import java.util.Objects;
 import java.util.UUID;
-import org.apache.commons.lang3.NotImplementedException;
 import tech.units.indriya.ComparableQuantity;
 
 /** Quite simple thermal model of a house to serve as a heat sink */
@@ -70,10 +69,8 @@ public ComparableQuantity<HeatCapacity> getEthCapa() {
     return ethCapa;
   }
 
-  @Override
-  public UniqueEntityBuilder copy() {
-    throw new NotImplementedException(
-        "Copying of " + this.getClass().getSimpleName() + " entities is not supported yet!");
+  public ThermalHouseInputCopyBuilder copy() {
+    return new ThermalHouseInputCopyBuilder(this);
   }
 
   @Override
@@ -109,4 +106,50 @@ public String toString() {
         + ethCapa
         + '}';
   }
+
+  /**
+   * A builder pattern based approach to create copies of {@link ThermalHouseInput} entities with
+   * altered field values. For detailed field descriptions refer to java docs of {@link
+   * ThermalHouseInput}
+   */
+  public static class ThermalHouseInputCopyBuilder
+      extends ThermalUnitInput.ThermalUnitInputCopyBuilder<ThermalHouseInputCopyBuilder> {
+
+    private ComparableQuantity<ThermalConductance> ethLosses;
+    private ComparableQuantity<HeatCapacity> ethCapa;
+
+    private ThermalHouseInputCopyBuilder(ThermalHouseInput entity) {
+      super(entity);
+      this.ethLosses = entity.getEthLosses();
+      this.ethCapa = entity.getEthCapa();
+    }
+
+    @Override
+    public ThermalHouseInput build() {
+      return new ThermalHouseInput(
+          getUuid(),
+          getId(),
+          getOperator(),
+          getOperationTime(),
+          getThermalBus(),
+          ethLosses,
+          ethCapa);
+    }
+
+    public ThermalHouseInputCopyBuilder ethLosses(
+        ComparableQuantity<ThermalConductance> ethLosses) {
+      this.ethLosses = ethLosses;
+      return this;
+    }
+
+    public ThermalHouseInputCopyBuilder ethCapa(ComparableQuantity<HeatCapacity> ethCapa) {
+      this.ethCapa = ethCapa;
+      return this;
+    }
+
+    @Override
+    protected ThermalHouseInputCopyBuilder childInstance() {
+      return this;
+    }
+  }
 }

src/main/java/edu/ie3/datamodel/models/input/thermal/ThermalUnitInput.java

@@ -78,4 +78,35 @@ public String toString() {
         + thermalBus.getUuid()
         + '}';
   }
+
+  /**
+   * Abstract class for all builders that build child entities of abstract class {@link
+   * ThermalUnitInput}
+   */
+  protected abstract static class ThermalUnitInputCopyBuilder<
+          T extends ThermalUnitInput.ThermalUnitInputCopyBuilder<T>>
+      extends AssetInputCopyBuilder<T> {
+
+    private ThermalBusInput thermalBus;
+
+    protected ThermalUnitInputCopyBuilder(ThermalUnitInput entity) {
+      super(entity);
+      this.thermalBus = entity.getThermalBus();
+    }
+
+    public T thermalBus(ThermalBusInput thermalBus) {
+      this.thermalBus = thermalBus;
+      return childInstance();
+    }
+
+    protected ThermalBusInput getThermalBus() {
+      return thermalBus;
+    }
+
+    @Override
+    public abstract ThermalUnitInput build();
+
+    @Override
+    protected abstract T childInstance();
+  }
 }

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

@@ -18,15 +18,14 @@ import tech.units.indriya.quantity.Quantities
 
 import javax.measure.quantity.Dimensionless
 import java.time.ZonedDateTime
-
 /**
- * //ToDo: Class Description
+ * Testing EvcsInputFactory
  *
  * @version 0.1* @since 26.07.20
  */
-class EvcsInputFactoryTest extends Specification  implements FactoryTestHelper {
+class EvcsInputFactoryTest extends Specification implements FactoryTestHelper {
 
-	def "A CsInputFactory should contain exactly the expected class for parsing"() {
+	def "A EvcsInputFactory should contain exactly the expected class for parsing"() {
 		given:
 		def inputFactory = new EvcsInputFactory()
 		def expectedClasses = [EvcsInput]
@@ -35,7 +34,7 @@ class EvcsInputFactoryTest extends Specification  implements FactoryTestHelper {
 		inputFactory.supportedClasses == Arrays.asList(expectedClasses.toArray())
 	}
 
-	def "A CsInputFactory should parse a valid CsInput correctly"() {
+	def "A EvcsInputFactory should parse a valid EvcsInput correctly"() {
 		given: "a system participant input type factory and model data"
 		def inputFactory = new EvcsInputFactory()
 		Map<String, String> parameter = [
@@ -44,9 +43,9 @@ class EvcsInputFactoryTest extends Specification  implements FactoryTestHelper {
 			"operatesuntil"   : "2019-12-31T23:59:00+01:00[Europe/Berlin]",
 			"id"              : "TestID",
 			"qcharacteristics": "cosPhiFixed:{(0.0,1.0)}",
-			"type"          : "Household",
-			"chargingpoints"         : "4",
-			"cosphirated"          : "0.95",
+			"type"            : "Household",
+			"chargingpoints"  : "4",
+			"cosphirated"     : "0.95",
 		]
 		def inputClass = EvcsInput
 		def nodeInput = Mock(NodeInput)
@@ -79,4 +78,30 @@ class EvcsInputFactoryTest extends Specification  implements FactoryTestHelper {
 			assert cosPhiRated == Double.parseDouble(parameter["cosphirated"])
 		}
 	}
+
+	def "A EvcsInputFactory should fail when passing an invalid ChargingPointType"() {
+		given: "a system participant input type factory and model data"
+		def inputFactory = new EvcsInputFactory()
+		Map<String, String> parameter = [
+			"uuid"            : "91ec3bcf-1777-4d38-af67-0bf7c9fa73c7",
+			"operatesfrom"    : "2019-01-01T00:00:00+01:00[Europe/Berlin]",
+			"operatesuntil"   : "2019-12-31T23:59:00+01:00[Europe/Berlin]",
+			"id"              : "TestID",
+			"qcharacteristics": "cosPhiFixed:{(0.0,1.0)}",
+			"type"            : "-- invalid --",
+			"chargingpoints"  : "4",
+			"cosphirated"     : "0.95",
+		]
+		def inputClass = EvcsInput
+		def nodeInput = Mock(NodeInput)
+		def operatorInput = Mock(OperatorInput)
+
+		when:
+		Optional<EvcsInput> input = inputFactory.get(
+				new NodeAssetInputEntityData(parameter, inputClass, operatorInput, nodeInput))
+
+		then:
+		// FactoryException is caught in Factory.java. We get an empty Option back
+		!input.present
+	}
 }

src/test/groovy/edu/ie3/datamodel/models/input/thermal/CylindricalStorageInputTest.groovy

@@ -0,0 +1,39 @@
+/*
+ * © 2021. 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.thermal
+
+import edu.ie3.test.common.ThermalUnitInputTestData
+import spock.lang.Specification
+
+
+class CylindricalStorageInputTest extends Specification {
+
+	def "A CylindricalStorageInput copy method should work as expected"() {
+		given:
+		def cylindricalStorageInput = ThermalUnitInputTestData.cylindricStorageInput
+
+		when:
+		def alteredUnit = cylindricalStorageInput.copy().storageVolumeLvl(ThermalUnitInputTestData.storageVolumeLvl)
+				.storageVolumeLvlMin(ThermalUnitInputTestData.storageVolumeLvlMin).inletTemp(ThermalUnitInputTestData.inletTemp)
+				.returnTemp(ThermalUnitInputTestData.returnTemp).c(ThermalUnitInputTestData.c)
+				.thermalBus(ThermalUnitInputTestData.thermalBus).build()
+
+
+		then:
+		alteredUnit.with {
+			assert uuid == cylindricalStorageInput.uuid
+			assert id == cylindricalStorageInput.id
+			assert operator == cylindricalStorageInput.operator
+			assert operationTime == cylindricalStorageInput.operationTime
+			assert thermalBus == cylindricalStorageInput.thermalBus
+			assert storageVolumeLvl == ThermalUnitInputTestData.storageVolumeLvl
+			assert storageVolumeLvlMin == ThermalUnitInputTestData.storageVolumeLvlMin
+			assert inletTemp == ThermalUnitInputTestData.inletTemp
+			assert returnTemp == ThermalUnitInputTestData.returnTemp
+			assert c == ThermalUnitInputTestData.c
+		}
+	}
+}