Merge pull request #1512 from ie3-institute/ms/#1511-fix-error-handling-in-method-enrichWithDefault

Fixed handling of erroneous field values in `EntitySource.enrichWithDefault()`

Author: staudtMarius

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed `EnergyPriceValue.equals()` [#1479](https://github.com/ie3-institute/PowerSystemDataModel/issues/1479)
 - Fixed tests of `TimeBasedValue` [#1469](https://github.com/ie3-institute/PowerSystemDataModel/issues/1469)
 - Requiring `thermalBus` field in house and storage input [#1509](https://github.com/ie3-institute/PowerSystemDataModel/issues/1509)
+- Fixed handling of erroneous field values in `EntitySource.enrichWithDefault()` [#1511](https://github.com/ie3-institute/PowerSystemDataModel/issues/1511)
 
 ### Changed
 - Updated CI-Pipeline to run task `Deploy` and `Staging` only for `Main` [#1403](https://github.com/ie3-institute/PowerSystemDataModel/issues/1403)

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

@@ -41,6 +41,17 @@ public boolean containsKey(String key) {
     return fieldsToAttributes.containsKey(key);
   }
 
+  /**
+   * Checks if the field is empty.
+   *
+   * @param field to check
+   * @return {@code true} if either the key is not present or the field is empty
+   */
+  public boolean isFieldEmpty(String field) {
+    String value = fieldsToAttributes.getOrDefault(field, null);
+    return value == null || value.isEmpty();
+  }
+
   /**
    * Returns field value for given field name. Throws {@link FactoryException} if field does not
    * exist.

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

@@ -252,9 +252,7 @@ WrappedFunction<E, R> enrichWithDefault(
           BiFunction<E, T, R> buildingFcn) {
     return entityData ->
         entityData
-            .zip(
-                extractFunction(entityData, fieldName, entities)
-                    .orElse(() -> Try.Success.of(defaultEntity)))
+            .zip(extractWithDefaultFunction(entityData, fieldName, entities, defaultEntity))
             .map(enrichFunction(List.of(fieldName), buildingFcn));
   }
 
@@ -383,6 +381,30 @@ protected static <E extends EntityData, R> Try<R, SourceException> extractFuncti
                                 + exception.getMessage())));
   }
 
+  /**
+   * Method to extract an entity with default.
+   *
+   * @param entityData data containing complex entities
+   * @param fieldName name of the field
+   * @param entities map: uuid to {@link Entity}
+   * @param defaultEntity that is used if the field is empty
+   * @return an enrichment
+   * @param <E> type of entity data
+   * @param <R> type of entity
+   */
+  protected static <E extends EntityData, R> Try<R, SourceException> extractWithDefaultFunction(
+      Try<E, SourceException> entityData,
+      String fieldName,
+      Map<UUID, R> entities,
+      R defaultEntity) {
+    if (entityData.convert(data -> data.isFieldEmpty(fieldName), f -> false)) {
+      // return the default entity, if the field is empty
+      return new Try.Success<>(defaultEntity);
+    } else {
+      return extractFunction(entityData, fieldName, entities);
+    }
+  }
+
   /**
    * Method to extract an {@link Entity} from a given map.
    *