Improving validation utils

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Deleted parameter initFiles, set parameter append to false by default [#791](https://github.com/ie3-institute/PowerSystemDataModel/issues/791)
 - Use nio paths instead of strings for file path [#723](https://github.com/ie3-institute/PowerSystemDataModel/issues/723)
 - Data source will throw an exceptions instead of returning an empty optionals [#707](https://github.com/ie3-institute/PowerSystemDataModel/issues/707)
+- Improving `ValidationUtils` [#758](https://github.com/ie3-institute/PowerSystemDataModel/issues/758)
 
 
 ## [3.0.0] - 2023-02-16

src/main/java/edu/ie3/datamodel/exceptions/FailedValidationException.java

@@ -0,0 +1,25 @@
+/*
+ * © 2023. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.exceptions;
+
+import edu.ie3.datamodel.utils.ExceptionUtils;
+import java.util.List;
+
+public class FailedValidationException extends ValidationException {
+  public FailedValidationException(String message, Throwable throwable) {
+    super(message, throwable);
+  }
+
+  public FailedValidationException(String message) {
+    super(message);
+  }
+
+  /** @param exceptions List of exceptions, which must not be empty */
+  public FailedValidationException(List<? extends Exception> exceptions) {
+    super(
+        "Validation failed due to: \n" + ExceptionUtils.getMessages(exceptions), exceptions.get(0));
+  }
+}

src/main/java/edu/ie3/datamodel/exceptions/InvalidEntityException.java

@@ -13,12 +13,13 @@ public class InvalidEntityException extends ValidationException {
   private static final long serialVersionUID = 809496087520306374L;
 
   public InvalidEntityException(String faultDescription, UniqueEntity invalidEntity) {
-    super("Entity is invalid because of: " + faultDescription + " [" + invalidEntity + "]");
+    super("Entity is invalid because of: \n" + faultDescription + " [" + invalidEntity + "]");
   }
 
   public InvalidEntityException(
       String faultDescription, Throwable cause, UniqueEntity invalidEntity) {
-    super("Entity is invalid because of: " + faultDescription + " [" + invalidEntity + "]", cause);
+    super(
+        "Entity is invalid because of: \n" + faultDescription + " [" + invalidEntity + "]", cause);
   }
 
   public InvalidEntityException(String message, Throwable cause) {

src/main/java/edu/ie3/datamodel/exceptions/ValidationException.java

@@ -5,7 +5,7 @@
 */
 package edu.ie3.datamodel.exceptions;
 
-public abstract class ValidationException extends RuntimeException {
+public abstract class ValidationException extends Exception {
   protected ValidationException(String s) {
     super(s);
   }

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

@@ -119,8 +119,7 @@ public List<TimeBasedValue<WeatherValue>> buildTimeBasedValues(
                   return factory.get(data.get());
                 }),
             "TimeBasedValue<WeatherValue>")
-        .transformF(SourceException::new)
-        .getOrThrow()
-        .toList();
+        .transform(Stream::toList, SourceException::new)
+        .getOrThrow();
   }
 }

src/main/java/edu/ie3/datamodel/io/source/csv/CsvIdCoordinateSource.java

@@ -67,9 +67,9 @@ private Map<Integer, Point> setupIdToCoordinateMap() throws SourceException {
                 .map(fieldToValues -> new SimpleFactoryData(fieldToValues, Pair.class))
                 .map(factory::get),
             "Pair<Integer, Point>")
-        .transformF(SourceException::new)
-        .getOrThrow()
-        .collect(Collectors.toMap(Pair::getKey, Pair::getValue));
+        .transform(
+            s -> s.collect(Collectors.toMap(Pair::getKey, Pair::getValue)), SourceException::new)
+        .getOrThrow();
   }
 
   /**

src/main/java/edu/ie3/datamodel/io/source/csv/CsvJointGridContainerSource.java

@@ -6,6 +6,7 @@
 package edu.ie3.datamodel.io.source.csv;
 
 import edu.ie3.datamodel.exceptions.FileException;
+import edu.ie3.datamodel.exceptions.InvalidGridException;
 import edu.ie3.datamodel.exceptions.SourceException;
 import edu.ie3.datamodel.io.naming.DefaultDirectoryHierarchy;
 import edu.ie3.datamodel.io.naming.EntityPersistenceNamingStrategy;
@@ -25,7 +26,7 @@ private CsvJointGridContainerSource() {}
 
   public static JointGridContainer read(
       String gridName, String csvSep, Path directoryPath, boolean isHierarchic)
-      throws SourceException, FileException {
+      throws SourceException, FileException, InvalidGridException {
 
     /* Parameterization */
     FileNamingStrategy namingStrategy;

src/main/java/edu/ie3/datamodel/models/UniqueEntity.java

@@ -52,7 +52,7 @@ public String toString() {
    * @version 0.1
    * @since 05.06.20
    */
-  protected abstract static class UniqueEntityCopyBuilder<T extends UniqueEntityBuilder>
+  public abstract static class UniqueEntityCopyBuilder<B extends UniqueEntityBuilder>
       implements UniqueEntityBuilder {
 
     private UUID uuid;
@@ -61,16 +61,16 @@ protected UniqueEntityCopyBuilder(UniqueEntity entity) {
       this.uuid = entity.getUuid();
     }
 
-    public T uuid(UUID uuid) {
+    public B uuid(UUID uuid) {
       this.uuid = uuid;
-      return childInstance();
+      return thisInstance();
     }
 
     protected UUID getUuid() {
       return uuid;
     }
 
-    protected abstract T childInstance();
+    protected abstract B thisInstance();
   }
 
   protected interface UniqueEntityBuilder {

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

@@ -58,7 +58,7 @@ public String getId() {
     return id;
   }
 
-  public abstract UniqueEntityBuilder copy();
+  public abstract AssetInputCopyBuilder<?> copy();
 
   @Override
   public boolean equals(Object o) {
@@ -95,8 +95,8 @@ public String toString() {
    * @version 0.1
    * @since 05.06.20
    */
-  protected abstract static class AssetInputCopyBuilder<T extends AssetInputCopyBuilder<T>>
-      extends UniqueEntityCopyBuilder<T> {
+  public abstract static class AssetInputCopyBuilder<B extends AssetInputCopyBuilder<B>>
+      extends UniqueEntityCopyBuilder<B> {
 
     private String id;
     private OperatorInput operator;
@@ -109,19 +109,19 @@ protected AssetInputCopyBuilder(AssetInput entity) {
       this.operationTime = entity.getOperationTime();
     }
 
-    public T id(String id) {
+    public B id(String id) {
       this.id = id;
-      return childInstance();
+      return thisInstance();
     }
 
-    public T operator(OperatorInput operator) {
+    public B operator(OperatorInput operator) {
       this.operator = operator;
-      return childInstance();
+      return thisInstance();
     }
 
-    public T operationTime(OperationTime operationTime) {
+    public B operationTime(OperationTime operationTime) {
       this.operationTime = operationTime;
-      return childInstance();
+      return thisInstance();
     }
 
     protected String getId() {
@@ -140,6 +140,6 @@ protected OperationTime getOperationTime() {
     public abstract AssetInput build();
 
     @Override
-    protected abstract T childInstance();
+    protected abstract B thisInstance();
   }
 }

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

@@ -98,6 +98,7 @@ public boolean getQ() {
     return q;
   }
 
+  @Override
   public MeasurementUnitInputCopyBuilder copy() {
     return new MeasurementUnitInputCopyBuilder(this);
   }
@@ -206,7 +207,7 @@ public MeasurementUnitInputCopyBuilder q(boolean q) {
     }
 
     @Override
-    protected MeasurementUnitInputCopyBuilder childInstance() {
+    protected MeasurementUnitInputCopyBuilder thisInstance() {
       return this;
     }
   }

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

@@ -115,6 +115,7 @@ public int getSubnet() {
     return subnet;
   }
 
+  @Override
   public NodeInputCopyBuilder copy() {
     return new NodeInputCopyBuilder(this);
   }
@@ -226,7 +227,7 @@ public NodeInputCopyBuilder subnet(int subnet) {
     }
 
     @Override
-    protected NodeInputCopyBuilder childInstance() {
+    protected NodeInputCopyBuilder thisInstance() {
       return this;
     }
   }

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

@@ -83,7 +83,7 @@ public OperatorInputCopyBuilder id(String id) {
     }
 
     @Override
-    protected OperatorInputCopyBuilder childInstance() {
+    protected OperatorInputCopyBuilder thisInstance() {
       return this;
     }
   }

src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java

@@ -127,8 +127,8 @@ public String toString() {
    * @version 0.1
    * @since 05.06.20
    */
-  abstract static class ConnectorInputCopyBuilder<T extends ConnectorInputCopyBuilder<T>>
-      extends AssetInputCopyBuilder<T> {
+  public abstract static class ConnectorInputCopyBuilder<B extends ConnectorInputCopyBuilder<B>>
+      extends AssetInputCopyBuilder<B> {
 
     private NodeInput nodeA;
     private NodeInput nodeB;
@@ -141,19 +141,19 @@ protected ConnectorInputCopyBuilder(ConnectorInput entity) {
       this.parallelDevices = entity.getParallelDevices();
     }
 
-    public T nodeA(NodeInput nodeA) {
+    public B nodeA(NodeInput nodeA) {
       this.nodeA = nodeA;
-      return childInstance();
+      return thisInstance();
     }
 
-    public T nodeB(NodeInput nodeB) {
+    public B nodeB(NodeInput nodeB) {
       this.nodeB = nodeB;
-      return childInstance();
+      return thisInstance();
     }
 
-    public T parallelDevices(int parallelDevices) {
+    public B parallelDevices(int parallelDevices) {
       this.parallelDevices = parallelDevices;
-      return childInstance();
+      return thisInstance();
     }
 
     protected NodeInput getNodeA() {
@@ -172,6 +172,6 @@ protected int getParallelDevices() {
     public abstract ConnectorInput build();
 
     @Override
-    protected abstract T childInstance();
+    protected abstract B thisInstance();
   }
 }

src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java

@@ -117,6 +117,7 @@ public OlmCharacteristicInput getOlmCharacteristic() {
     return olmCharacteristic;
   }
 
+  @Override
   public LineInputCopyBuilder copy() {
     return new LineInputCopyBuilder(this);
   }
@@ -223,7 +224,7 @@ public LineInputCopyBuilder olmCharacteristic(OlmCharacteristicInput olmCharacte
     }
 
     @Override
-    protected LineInputCopyBuilder childInstance() {
+    protected LineInputCopyBuilder thisInstance() {
       return this;
     }
   }

src/main/java/edu/ie3/datamodel/models/input/connector/SwitchInput.java

@@ -57,6 +57,7 @@ public boolean isClosed() {
     return closed;
   }
 
+  @Override
   public SwitchInputCopyBuilder copy() {
     return new SwitchInputCopyBuilder(this);
   }
@@ -126,7 +127,7 @@ public SwitchInputCopyBuilder closed(boolean closed) {
     }
 
     @Override
-    protected SwitchInputCopyBuilder childInstance() {
+    protected SwitchInputCopyBuilder thisInstance() {
       return this;
     }
   }

src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java

@@ -77,6 +77,7 @@ public Transformer2WInput(
     this.type = type;
   }
 
+  @Override
   public Transformer2WInputCopyBuilder copy() {
     return new Transformer2WInputCopyBuilder(this);
   }
@@ -160,7 +161,7 @@ public Transformer2WInputCopyBuilder type(Transformer2WTypeInput type) {
     }
 
     @Override
-    protected Transformer2WInputCopyBuilder childInstance() {
+    protected Transformer2WInputCopyBuilder thisInstance() {
       return this;
     }
   }

src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java

@@ -232,6 +232,7 @@ public NodeInput getNodeInternal() {
     return nodeInternal;
   }
 
+  @Override
   public Transformer3WInputCopyBuilder copy() {
     return new Transformer3WInputCopyBuilder(this);
   }
@@ -335,7 +336,7 @@ public Transformer3WInputCopyBuilder internalSlack(boolean internalNodeIsSlack)
     }
 
     @Override
-    protected Transformer3WInputCopyBuilder childInstance() {
+    protected Transformer3WInputCopyBuilder thisInstance() {
       return this;
     }
   }

src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java

@@ -81,7 +81,7 @@ public int getTapPos() {
   }
 
   @Override
-  public abstract TransformerInputCopyBuilder<?> copy();
+  public abstract TransformerInputCopyBuilder<? extends TransformerInputCopyBuilder<?>> copy();
 
   @Override
   public boolean equals(Object o) {
@@ -127,8 +127,8 @@ public String toString() {
    * @version 0.1
    * @since 05.06.20
    */
-  abstract static class TransformerInputCopyBuilder<T extends TransformerInputCopyBuilder<T>>
-      extends ConnectorInputCopyBuilder<T> {
+  public abstract static class TransformerInputCopyBuilder<B extends TransformerInputCopyBuilder<B>>
+      extends ConnectorInputCopyBuilder<B> {
 
     private int tapPos;
     private boolean autoTap;
@@ -139,14 +139,14 @@ protected TransformerInputCopyBuilder(TransformerInput entity) {
       this.autoTap = entity.isAutoTap();
     }
 
-    public T tapPos(int tapPos) {
+    public B tapPos(int tapPos) {
       this.tapPos = tapPos;
-      return childInstance();
+      return thisInstance();
     }
 
-    public T autoTap(boolean autoTap) {
+    public B autoTap(boolean autoTap) {
       this.autoTap = autoTap;
-      return childInstance();
+      return thisInstance();
     }
 
     protected int getTapPos() {
@@ -161,6 +161,6 @@ protected boolean isAutoTap() {
     public abstract TransformerInput build();
 
     @Override
-    protected abstract T childInstance();
+    protected abstract B thisInstance();
   }
 }