Bump com.github.ie3-institute:PowerSystemUtils from 2.0 to 2.2

CHANGELOG.md

@@ -36,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated contributing.md [#737](https://github.com/ie3-institute/PowerSystemDataModel/issues/737)
 - Don't throw exceptions for not yet implemented validations [#879](https://github.com/ie3-institute/PowerSystemDataModel/issues/879)
 - `CsvDataSource` throws exceptions on error [#954](https://github.com/ie3-institute/PowerSystemDataModel/issues/954)
+- BREAKING: Updating PowerSystemUtils dependency to 2.2 [#1006](https://github.com/ie3-institute/PowerSystemDataModel/issues/1006)
 
 ## [4.1.0] - 2023-11-02
 

build.gradle

@@ -53,7 +53,7 @@ repositories {
 dependencies {
 
   //	 ie³ power system utils
-  implementation 'com.github.ie3-institute:PowerSystemUtils:2.0'
+  implementation 'com.github.ie3-institute:PowerSystemUtils:2.2'
 
   implementation 'tech.units:indriya:2.2'
 

src/main/java/edu/ie3/datamodel/io/factory/result/ConnectorResultFactory.java

@@ -14,6 +14,7 @@
 import edu.ie3.datamodel.models.result.connector.Transformer2WResult;
 import edu.ie3.datamodel.models.result.connector.Transformer3WResult;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Angle;
 import javax.measure.quantity.ElectricCurrent;
@@ -37,10 +38,11 @@ public ConnectorResultFactory() {
    * Create a new factory to build {@link ConnectorResult}s and utilize the given date time
    * formatter pattern to parse date time strings
    *
-   * @param dtfPattern Pattern to parse date time strings
+   * @param dateTimeFormatter to parse date time strings
    */
-  public ConnectorResultFactory(String dtfPattern) {
-    super(dtfPattern, LineResult.class, Transformer2WResult.class, Transformer3WResult.class);
+  public ConnectorResultFactory(DateTimeFormatter dateTimeFormatter) {
+    super(
+        dateTimeFormatter, LineResult.class, Transformer2WResult.class, Transformer3WResult.class);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/io/factory/result/FlexOptionsResultFactory.java

@@ -9,6 +9,7 @@
 import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.result.system.FlexOptionsResult;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Power;
 import tech.units.indriya.ComparableQuantity;
@@ -27,10 +28,10 @@ public FlexOptionsResultFactory() {
    * Create a new factory to build {@link FlexOptionsResult}s and utilize the given date time
    * formatter pattern to parse date time strings
    *
-   * @param dtfPattern Pattern to parse date time strings
+   * @param dateTimeFormatter to parse date time strings
    */
-  public FlexOptionsResultFactory(String dtfPattern) {
-    super(dtfPattern, FlexOptionsResult.class);
+  public FlexOptionsResultFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter, FlexOptionsResult.class);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/io/factory/result/NodeResultFactory.java

@@ -9,6 +9,7 @@
 import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.result.NodeResult;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Angle;
 import javax.measure.quantity.Dimensionless;
@@ -26,10 +27,10 @@ public NodeResultFactory() {
    * Create a new factory to build {@link NodeResult}s and utilize the given date time formatter
    * pattern to parse date time strings
    *
-   * @param dtfPattern Pattern to parse date time strings
+   * @param dateTimeFormatter to parse date time strings
    */
-  public NodeResultFactory(String dtfPattern) {
-    super(dtfPattern, NodeResult.class);
+  public NodeResultFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter, NodeResult.class);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/io/factory/result/ResultEntityFactory.java

@@ -9,8 +9,7 @@
 import edu.ie3.datamodel.io.factory.EntityFactory;
 import edu.ie3.datamodel.models.result.ResultEntity;
 import edu.ie3.util.TimeUtil;
-import java.time.ZoneId;
-import java.util.Locale;
+import java.time.format.DateTimeFormatter;
 
 /**
  * Internal API for building {@link ResultEntity}s. This additional abstraction layer is necessary
@@ -32,8 +31,9 @@ protected ResultEntityFactory(Class<? extends T>... allowedClasses) {
     timeUtil = TimeUtil.withDefaults;
   }
 
-  protected ResultEntityFactory(String dtfPattern, Class<? extends T>... allowedClasses) {
+  protected ResultEntityFactory(
+      DateTimeFormatter dateTimeFormatter, Class<? extends T>... allowedClasses) {
     super(allowedClasses);
-    timeUtil = new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, dtfPattern);
+    timeUtil = new TimeUtil(dateTimeFormatter);
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/result/SwitchResultFactory.java

@@ -8,6 +8,7 @@
 import edu.ie3.datamodel.io.factory.EntityData;
 import edu.ie3.datamodel.models.result.connector.SwitchResult;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 
 public class SwitchResultFactory extends ResultEntityFactory<SwitchResult> {
@@ -22,10 +23,10 @@ public SwitchResultFactory() {
    * Create a new factory to build {@link SwitchResult}s and utilize the given date time formatter
    * pattern to parse date time strings
    *
-   * @param dtfPattern Pattern to parse date time strings
+   * @param dateTimeFormatter Pattern to parse date time strings
    */
-  public SwitchResultFactory(String dtfPattern) {
-    super(dtfPattern, SwitchResult.class);
+  public SwitchResultFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter, SwitchResult.class);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/io/factory/result/SystemParticipantResultFactory.java

@@ -13,6 +13,7 @@
 import edu.ie3.datamodel.models.UniqueEntity;
 import edu.ie3.datamodel.models.result.system.*;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Dimensionless;
 import javax.measure.quantity.Power;
@@ -48,11 +49,11 @@ public SystemParticipantResultFactory() {
    * Create a new factory to build {@link SystemParticipantResult}s and utilize the given date time
    * formatter pattern to parse date time strings
    *
-   * @param dtfPattern Pattern to parse date time strings
+   * @param dateTimeFormatter to parse date time strings
    */
-  public SystemParticipantResultFactory(String dtfPattern) {
+  public SystemParticipantResultFactory(DateTimeFormatter dateTimeFormatter) {
     super(
-        dtfPattern,
+        dateTimeFormatter,
         LoadResult.class,
         FixedFeedInResult.class,
         BmResult.class,

src/main/java/edu/ie3/datamodel/io/factory/result/ThermalResultFactory.java

@@ -13,6 +13,7 @@
 import edu.ie3.datamodel.models.result.thermal.ThermalHouseResult;
 import edu.ie3.datamodel.models.result.thermal.ThermalUnitResult;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Dimensionless;
 import javax.measure.quantity.Energy;
@@ -34,10 +35,10 @@ public ThermalResultFactory() {
    * Create a new factory to build {@link ThermalResultFactory}s and utilize the given date time
    * formatter pattern to parse date time strings
    *
-   * @param dtfPattern Pattern to parse date time strings
+   * @param dateTimeFormatter parse date time strings
    */
-  public ThermalResultFactory(String dtfPattern) {
-    super(dtfPattern, ThermalHouseResult.class, CylindricalStorageResult.class);
+  public ThermalResultFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter, ThermalHouseResult.class, CylindricalStorageResult.class);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/io/factory/timeseries/CosmoTimeBasedWeatherValueFactory.java

@@ -12,6 +12,7 @@
 import edu.ie3.util.quantities.PowerSystemUnits;
 import edu.ie3.util.quantities.interfaces.Irradiance;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.Collections;
 import java.util.List;
 import java.util.Set;
@@ -36,8 +37,8 @@ public CosmoTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
     super(timeUtil);
   }
 
-  public CosmoTimeBasedWeatherValueFactory(String timePattern) {
-    super(timePattern);
+  public CosmoTimeBasedWeatherValueFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter);
   }
 
   public CosmoTimeBasedWeatherValueFactory() {

src/main/java/edu/ie3/datamodel/io/factory/timeseries/IconTimeBasedWeatherValueFactory.java

@@ -11,8 +11,8 @@
 import edu.ie3.util.TimeUtil;
 import edu.ie3.util.quantities.PowerSystemUnits;
 import edu.ie3.util.quantities.interfaces.Irradiance;
-import java.time.ZoneId;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 import javax.measure.quantity.Angle;
 import javax.measure.quantity.Speed;
@@ -35,16 +35,16 @@ public class IconTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFacto
   private static final String WIND_VELOCITY_U = "u131m";
   private static final String WIND_VELOCITY_V = "v131m";
 
-  public IconTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
-    super(timeUtil);
+  public IconTimeBasedWeatherValueFactory() {
+    super();
   }
 
-  public IconTimeBasedWeatherValueFactory(String timePattern) {
-    super(timePattern);
+  public IconTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
+    super(timeUtil);
   }
 
-  public IconTimeBasedWeatherValueFactory() {
-    super(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, "yyyy-MM-dd HH:mm:ss"));
+  public IconTimeBasedWeatherValueFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter);
   }
 
   @Override

src/main/java/edu/ie3/datamodel/io/factory/timeseries/TimeBasedSimpleValueFactory.java

@@ -12,8 +12,8 @@
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
 import edu.ie3.datamodel.models.value.*;
 import edu.ie3.util.TimeUtil;
-import java.time.ZoneId;
 import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.*;
 
 public class TimeBasedSimpleValueFactory<V extends Value>
@@ -30,12 +30,14 @@ public class TimeBasedSimpleValueFactory<V extends Value>
   private final TimeUtil timeUtil;
 
   public TimeBasedSimpleValueFactory(Class<? extends V> valueClasses) {
-    this(valueClasses, "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]'Z'");
+    super(valueClasses);
+    this.timeUtil = TimeUtil.withDefaults;
   }
 
-  public TimeBasedSimpleValueFactory(Class<? extends V> valueClasses, String timePattern) {
+  public TimeBasedSimpleValueFactory(
+      Class<? extends V> valueClasses, DateTimeFormatter dateTimeFormatter) {
     super(valueClasses);
-    timeUtil = new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, timePattern);
+    this.timeUtil = new TimeUtil(dateTimeFormatter);
   }
 
   /**

src/main/java/edu/ie3/datamodel/io/factory/timeseries/TimeBasedWeatherValueFactory.java

@@ -7,8 +7,7 @@
 
 import edu.ie3.datamodel.models.value.WeatherValue;
 import edu.ie3.util.TimeUtil;
-import java.time.ZoneId;
-import java.util.*;
+import java.time.format.DateTimeFormatter;
 
 /**
  * Abstract factory to handle the conversion from "flat" field to value mapping onto actual {@link
@@ -23,11 +22,13 @@ public abstract class TimeBasedWeatherValueFactory
   protected final TimeUtil timeUtil;
 
   protected TimeBasedWeatherValueFactory() {
-    this("yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]'Z'");
+    super(WeatherValue.class);
+    this.timeUtil = new TimeUtil(DateTimeFormatter.ISO_OFFSET_DATE_TIME);
   }
 
-  protected TimeBasedWeatherValueFactory(String timePattern) {
-    this(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, timePattern));
+  protected TimeBasedWeatherValueFactory(DateTimeFormatter dateTimeFormatter) {
+    super(WeatherValue.class);
+    this.timeUtil = new TimeUtil(dateTimeFormatter);
   }
 
   protected TimeBasedWeatherValueFactory(TimeUtil timeUtil) {

src/main/java/edu/ie3/datamodel/io/naming/FileNamingStrategy.java

@@ -254,21 +254,6 @@ public String getIdCoordinateEntityName() {
     return entityPersistenceNamingStrategy.getIdCoordinateEntityName();
   }
 
-  /**
-   * Get the full path to the id coordinate file with regard to some (not explicitly specified) base
-   * directory. The path does NOT start or end with any of the known file separators or file
-   * extension.
-   *
-   * @return An optional sub path to the id coordinate file
-   * @deprecated unused, no substitute
-   */
-  @Deprecated(since = "3.0", forRemoval = true)
-  public Optional<Path> getIdCoordinateFilePath() {
-    // do not adapt orElseGet, see https://www.baeldung.com/java-optional-or-else-vs-or-else-get for
-    // details
-    return Optional.of(FileUtils.of(getIdCoordinateEntityName(), fileHierarchy.getBaseDirectory()));
-  }
-
   /**
    * Returns the name of the entity, that should be used for persistence.
    *

src/main/java/edu/ie3/datamodel/io/processor/Processor.java

@@ -18,6 +18,7 @@
 import edu.ie3.datamodel.models.voltagelevels.VoltageLevel;
 import edu.ie3.datamodel.utils.Try;
 import edu.ie3.datamodel.utils.Try.*;
+import edu.ie3.util.TimeUtil;
 import edu.ie3.util.exceptions.QuantityException;
 import java.beans.Introspector;
 import java.lang.reflect.InvocationTargetException;
@@ -400,10 +401,10 @@ protected String processOperationTime(OperationTime operationTime, String fieldN
    * manually BEFORE calling this method!
    *
    * @param zonedDateTime representation of the ZonedDateTime
-   * @return string representation of the ZonedDateTime
+   * @return ISO 8601 conform string representation of the ZonedDateTime
    */
   protected String processZonedDateTime(ZonedDateTime zonedDateTime) {
-    return zonedDateTime.toString();
+    return TimeUtil.withDefaults.toString(zonedDateTime);
   }
 
   /**

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

@@ -16,7 +16,6 @@
 import edu.ie3.datamodel.utils.Try;
 import edu.ie3.datamodel.utils.Try.Failure;
 import java.util.*;
-import java.util.Set;
 import java.util.stream.Stream;
 
 /**

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

@@ -21,6 +21,7 @@
 import edu.ie3.datamodel.models.result.thermal.CylindricalStorageResult;
 import edu.ie3.datamodel.models.result.thermal.ThermalHouseResult;
 import edu.ie3.datamodel.utils.Try;
+import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
@@ -54,11 +55,11 @@ public ResultEntitySource(DataSource dataSource) {
     this.flexOptionsResultFactory = new FlexOptionsResultFactory();
   }
 
-  public ResultEntitySource(DataSource dataSource, String dtfPattern) {
+  public ResultEntitySource(DataSource dataSource, DateTimeFormatter dateTimeFormatter) {
     super(dataSource);
 
     // init factories
-    this.systemParticipantResultFactory = new SystemParticipantResultFactory(dtfPattern);
+    this.systemParticipantResultFactory = new SystemParticipantResultFactory(dateTimeFormatter);
     this.thermalResultFactory = new ThermalResultFactory();
     this.switchResultFactory = new SwitchResultFactory();
     this.nodeResultFactory = new NodeResultFactory();

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

@@ -16,7 +16,6 @@
 import edu.ie3.util.interval.ClosedInterval;
 import java.time.ZonedDateTime;
 import java.util.*;
-import java.util.Optional;
 
 /**
  * The interface definition of a source, that is able to provide one specific time series for one

src/main/java/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSource.java

@@ -34,7 +34,6 @@
 /** Couchbase Source for weather data */
 public class CouchbaseWeatherSource extends WeatherSource {
   private static final Logger logger = LoggerFactory.getLogger(CouchbaseWeatherSource.class);
-  private static final String DEFAULT_TIMESTAMP_PATTERN = "yyyy-MM-dd'T'HH:mm:ssxxx";
   /** The start of the document key, comparable to a table name in relational databases */
   private static final String DEFAULT_KEY_PREFIX = "weather";