Merge pull request #712 from ie3-institute/ms/#707-Refactor-data-sources-to-throw-exceptions-instead-of-returning-Optionals

Refactor data source to throw exception instead of returning optionals

Author: danielfeismann

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Refactor CSV data sources [#716](https://github.com/ie3-institute/PowerSystemDataModel/issues/716)
 - 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)
 
 
 ## [3.0.0] - 2023-02-16

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

@@ -0,0 +1,20 @@
+/*
+ * © 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;
+
+public class FailureException extends Exception {
+  public FailureException(String message, Throwable throwable) {
+    super(message, throwable);
+  }
+
+  public FailureException(String message) {
+    super(message);
+  }
+
+  public FailureException(Throwable throwable) {
+    super(throwable);
+  }
+}

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

@@ -0,0 +1,14 @@
+/*
+ * © 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 java.util.List;
+
+public class GraphicSourceException extends SourceException {
+  public GraphicSourceException(String message, List<SourceException> exceptions) {
+    super(message, exceptions);
+  }
+}

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

@@ -0,0 +1,14 @@
+/*
+ * © 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 java.util.List;
+
+public class RawGridException extends SourceException {
+  public RawGridException(String message, List<SourceException> exceptions) {
+    super(message, exceptions);
+  }
+}

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

@@ -5,6 +5,9 @@
 */
 package edu.ie3.datamodel.exceptions;
 
+import edu.ie3.datamodel.utils.ExceptionUtils;
+import java.util.List;
+
 /**
  * Exception that should be used whenever an error occurs in a instance of a {@link
  * edu.ie3.datamodel.io.source.DataSource}
@@ -27,4 +30,8 @@ public SourceException(final Throwable cause) {
   public SourceException(final String message) {
     super(message);
   }
+
+  public SourceException(String message, List<? extends Exception> exceptions) {
+    super(message + " " + ExceptionUtils.getMessages(exceptions), exceptions.get(0));
+  }
 }

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

@@ -0,0 +1,14 @@
+/*
+ * © 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 java.util.List;
+
+public class SystemParticipantsException extends SourceException {
+  public SystemParticipantsException(String message, List<SourceException> exceptions) {
+    super(message, exceptions);
+  }
+}

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

@@ -0,0 +1,12 @@
+/*
+ * © 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;
+
+public class TryException extends RuntimeException {
+  public TryException(String message, Throwable throwable) {
+    super(message, throwable);
+  }
+}

src/main/java/edu/ie3/datamodel/io/factory/Factory.java

@@ -6,6 +6,8 @@
 package edu.ie3.datamodel.io.factory;
 
 import edu.ie3.datamodel.exceptions.FactoryException;
+import edu.ie3.datamodel.utils.Try;
+import edu.ie3.datamodel.utils.Try.*;
 import java.util.*;
 import java.util.function.IntFunction;
 import java.util.stream.Collectors;
@@ -39,27 +41,40 @@ public List<Class<? extends C>> getSupportedClasses() {
    * data
    *
    * @param data EntityData (or subclass) containing the data
-   * @return An entity wrapped in Option if successful, an empty option otherwise
+   * @return An entity wrapped in a {@link Success} if successful, or an exception wrapped in a
+   *     {@link Failure}
    */
-  public Optional<R> get(D data) {
+  public Try<R, FactoryException> get(D data) {
     isSupportedClass(data.getTargetClass());
 
     // magic: case-insensitive get/set calls on set strings
     final List<Set<String>> allFields = getFields(data);
 
-    validateParameters(data, allFields.toArray((IntFunction<Set<String>[]>) Set[]::new));
-
     try {
+      validateParameters(data, allFields.toArray((IntFunction<Set<String>[]>) Set[]::new));
+
       // build the model
-      return Optional.of(buildModel(data));
+      return new Success<>(buildModel(data));
     } catch (FactoryException e) {
-      // only catch FactoryExceptions, as more serious exceptions should be handled elsewhere
-      log.error(
-          "An error occurred when creating instance of {}.class.",
-          data.getTargetClass().getSimpleName(),
-          e);
+      return new Failure<>(
+          new FactoryException(
+              "An error occurred when creating instance of "
+                  + data.getTargetClass().getSimpleName()
+                  + ".class.",
+              e));
     }
-    return Optional.empty();
+  }
+
+  /**
+   * Builds entity with data from given EntityData object after doing all kinds of checks on the
+   * data
+   *
+   * @param data EntityData (or subclass) containing the data wrapped in a {@link Try}
+   * @return An entity wrapped in a {@link Success} if successful, or an exception wrapped in a
+   *     {@link Failure}
+   */
+  public Try<R, FactoryException> get(Try<D, ?> data) {
+    return data.transformF(FactoryException::new).flatMap(this::get);
   }
 
   /**