Improve inheritance along TimeBasedValueFactory

Author: ckittl

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

@@ -23,7 +23,8 @@
 
 /**
  * Factory implementation of {@link TimeBasedWeatherValueFactory}, that is able to handle field to
- * value mapping in the typical PowerSystemDataModel (PSDM) column scheme
+ * value mapping in the typical column scheme used by German Federal Meteorological Service's COSMO
+ * model
  */
 public class CosmoTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFactory {
   private static final String DIFFUSE_IRRADIANCE = "diffuseirradiance";
@@ -32,6 +33,11 @@ public class CosmoTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFact
   private static final String WIND_DIRECTION = "winddirection";
   private static final String WIND_VELOCITY = "windvelocity";
 
+  /**
+   * @deprecated Use {@link
+   *     CosmoTimeBasedWeatherValueFactory#CosmoTimeBasedWeatherValueFactory(String)} instead
+   */
+  @Deprecated
   public CosmoTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
     super(timeUtil);
   }

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

@@ -11,7 +11,6 @@
 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.util.*;
 import javax.measure.quantity.Angle;
@@ -35,6 +34,11 @@ public class IconTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFacto
   private static final String WIND_VELOCITY_U = "u131m";
   private static final String WIND_VELOCITY_V = "v131m";
 
+  /**
+   * @deprecated Use {@link
+   *     IconTimeBasedWeatherValueFactory#IconTimeBasedWeatherValueFactory(String)} instead
+   */
+  @Deprecated
   public IconTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
     super(timeUtil);
   }
@@ -44,7 +48,7 @@ public IconTimeBasedWeatherValueFactory(String timePattern) {
   }
 
   public IconTimeBasedWeatherValueFactory() {
-    super(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, "yyyy-MM-dd HH:mm:ss"));
+    super("yyyy-MM-dd HH:mm:ss");
   }
 
   @Override

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

@@ -11,31 +11,24 @@
 import edu.ie3.datamodel.models.StandardUnits;
 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.util.*;
 
 public class TimeBasedSimpleValueFactory<V extends Value>
     extends TimeBasedValueFactory<SimpleTimeBasedValueData<V>, V> {
-  private static final String UUID = "uuid";
-  private static final String TIME = "time";
   /* Energy price */
   private static final String PRICE = "price";
   /* Energy / Power */
   private static final String ACTIVE_POWER = "p";
   private static final String REACTIVE_POWER = "q";
   private static final String HEAT_DEMAND = "heatdemand";
 
-  private final TimeUtil timeUtil;
-
   public TimeBasedSimpleValueFactory(Class<? extends V> valueClasses) {
-    this(valueClasses, "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]'Z'");
+    super("yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]'Z'", valueClasses);
   }
 
   public TimeBasedSimpleValueFactory(Class<? extends V> valueClasses, String timePattern) {
-    super(valueClasses);
-    timeUtil = new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, timePattern);
+    super(timePattern, valueClasses);
   }
 
   @Override

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

@@ -8,6 +8,9 @@
 import edu.ie3.datamodel.io.factory.Factory;
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
 import edu.ie3.datamodel.models.value.Value;
+import edu.ie3.util.TimeUtil;
+import java.time.ZoneId;
+import java.util.Locale;
 
 /**
  * Abstract class that is able to build {@link TimeBasedValue}s from "flat" information
@@ -17,7 +20,45 @@
  */
 public abstract class TimeBasedValueFactory<D extends TimeBasedValueData<V>, V extends Value>
     extends Factory<V, D, TimeBasedValue<V>> {
+  /* Static field names, that are harmonized across different time based values */
+  protected static final String UUID = "uuid";
+  protected static final String TIME = "time";
+
+  protected final TimeUtil timeUtil;
+
+  /**
+   * Build an instance of of a time based value factory. Time zone defaults to UTC, Locale to {@link
+   * Locale#GERMANY} and the time stamp pattern to RFC 3339 standard.
+   *
+   * @param valueClasses Classes, that are covered by this factory
+   * @see <a href="https://tools.ietf.org/html/rfc3339">RFC 3339 standard definition</a>
+   */
   public TimeBasedValueFactory(Class<? extends V>... valueClasses) {
+    this(ZoneId.of("UTC"), Locale.GERMANY, "yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]'Z'", valueClasses);
+  }
+
+  /**
+   * Build an instance of of a time based value factory. Time zone defaults to UTC and Locale to
+   * {@link Locale#GERMANY}.
+   *
+   * @param timeStampPattern Pattern, that should be used to interpret a String to date time
+   * @param valueClasses Classes, that are covered by this factory
+   */
+  public TimeBasedValueFactory(String timeStampPattern, Class<? extends V>... valueClasses) {
+    this(ZoneId.of("UTC"), Locale.GERMANY, timeStampPattern, valueClasses);
+  }
+
+  /**
+   * Build an instance of of a time based value factory.
+   *
+   * @param timeZone Time zone to use, when parsing to date time
+   * @param locale Locale to use, when parsing to date time
+   * @param timeStampPattern Pattern, that should be used to interpret a String to date time
+   * @param valueClasses Classes, that are covered by this factory
+   */
+  public TimeBasedValueFactory(
+      ZoneId timeZone, Locale locale, String timeStampPattern, Class<? extends V>... valueClasses) {
     super(valueClasses);
+    timeUtil = new TimeUtil(timeZone, locale, timeStampPattern);
   }
 }

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

@@ -9,7 +9,6 @@
 import edu.ie3.util.TimeUtil;
 import edu.ie3.util.naming.Naming;
 import edu.ie3.util.naming.NamingConvention;
-import java.time.ZoneId;
 import java.util.*;
 
 /**
@@ -18,24 +17,24 @@
  */
 public abstract class TimeBasedWeatherValueFactory
     extends TimeBasedValueFactory<TimeBasedWeatherValueData, WeatherValue> {
-  protected static final String UUID = "uuid";
-  protected static final String TIME = "time";
   /* Hold a case agnostic representation of the composite word "coordinate id", that allows for later case conversion */
   protected static final Naming COORDINATE_ID_NAMING = Naming.from("coordinate", "id");
 
-  protected final TimeUtil timeUtil;
-
   protected TimeBasedWeatherValueFactory() {
-    this("yyyy-MM-dd'T'HH:mm:ss[.S[S][S]]'Z'");
+    super(WeatherValue.class);
   }
 
   protected TimeBasedWeatherValueFactory(String timePattern) {
-    this(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, timePattern));
+    super(timePattern, WeatherValue.class);
   }
 
+  /**
+   * @deprecated Use {@link TimeBasedWeatherValueFactory#TimeBasedWeatherValueFactory(String)}
+   *     instead
+   */
+  @Deprecated
   protected TimeBasedWeatherValueFactory(TimeUtil timeUtil) {
-    super(WeatherValue.class);
-    this.timeUtil = timeUtil;
+    super(timeUtil.getDtfPattern(), WeatherValue.class);
   }
 
   /**

src/test/groovy/edu/ie3/datamodel/io/factory/timeseries/IconTimeBasedWeatherValueFactoryTest.groovy

@@ -76,17 +76,17 @@ class IconTimeBasedWeatherValueFactoryTest extends Specification {
 		def coordinate = CosmoWeatherTestData.COORDINATE_67775
 
 		def parameter = [
-			"time"    : "2019-08-01 01:00:00",
-			"albRad"  : "13.015240669",
-			"asobS"   : "3.555093673828124",
-			"aswdifdS": "1.8088226191406245",
-			"aswdifuS": "0.5713421484374998",
-			"aswdirS" : "2.317613203124999",
-			"t2m"     : "289.1179319051744",
-			"tg"      : "288.4101691197649",
-			"u10m"    : "0.3021732864307963",
-			"u131m"   : "2.6058700426057797",
-			"u20m"    : "0.32384365019387784",
+			"time"        : "2019-08-01 01:00:00",
+			"albRad"      : "13.015240669",
+			"asobS"       : "3.555093673828124",
+			"aswdifdS"    : "1.8088226191406245",
+			"aswdifuS"    : "0.5713421484374998",
+			"aswdirS"     : "2.317613203124999",
+			"t2m"         : "289.1179319051744",
+			"tg"          : "288.4101691197649",
+			"u10m"        : "0.3021732864307963",
+			"u131m"       : "2.6058700426057797",
+			"u20m"        : "0.32384365019387784",
 			"u216m"       : "3.9015497418041756",
 			"u65m"        : "1.2823686334340363",
 			"v10m"        : "1.3852550649486943",
@@ -98,7 +98,7 @@ class IconTimeBasedWeatherValueFactoryTest extends Specification {
 			"w20m"        : "-0.0100060345167524",
 			"w216m"       : "-0.030348050471342078",
 			"w65m"        : "-0.01817112027569893",
-			"z0"           : "0.955323922526438",
+			"z0"          : "0.955323922526438",
 			"coordinateId": "67775",
 			"p131m"       : "",
 			"p20m"        : "",

src/test/groovy/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSourceCosmoIT.groovy

@@ -64,7 +64,7 @@ class CouchbaseWeatherSourceCosmoIT extends Specification implements WeatherSour
 
 		def connector = new CouchbaseConnector(couchbaseContainer.connectionString, bucketDefinition.name, couchbaseContainer.username, couchbaseContainer.password)
 		def dtfPattern = "yyyy-MM-dd'T'HH:mm:ssxxx"
-		def weatherFactory = new CosmoTimeBasedWeatherValueFactory(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, dtfPattern))
+		def weatherFactory = new CosmoTimeBasedWeatherValueFactory(dtfPattern)
 		source = new CouchbaseWeatherSource(connector, CosmoWeatherTestData.coordinateSource, weatherFactory, dtfPattern)
 	}
 

src/test/groovy/edu/ie3/datamodel/io/source/couchbase/CouchbaseWeatherSourceIconIT.groovy

@@ -62,7 +62,7 @@ class CouchbaseWeatherSourceIconIT extends Specification implements WeatherSourc
 
 		def connector = new CouchbaseConnector(couchbaseContainer.connectionString, bucketDefinition.name, couchbaseContainer.username, couchbaseContainer.password)
 		def dtfPattern = "yyyy-MM-dd'T'HH:mm:ssxxx"
-		def weatherFactory = new IconTimeBasedWeatherValueFactory(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, dtfPattern))
+		def weatherFactory = new IconTimeBasedWeatherValueFactory(dtfPattern)
 		source = new CouchbaseWeatherSource(connector, IconWeatherTestData.coordinateSource, weatherFactory, dtfPattern)
 	}
 

src/test/groovy/edu/ie3/datamodel/io/source/sql/SqlWeatherSourceCosmoIT.groovy

@@ -43,7 +43,7 @@ class SqlWeatherSourceCosmoIT extends Specification implements WeatherSourceTest
 		postgreSQLContainer.execInContainer("psql", "-Utest", "-f/home/weather.sql")
 
 		def connector = new SqlConnector(postgreSQLContainer.jdbcUrl, postgreSQLContainer.username, postgreSQLContainer.password)
-		def weatherFactory = new CosmoTimeBasedWeatherValueFactory(TimeUtil.withDefaults)
+		def weatherFactory = new CosmoTimeBasedWeatherValueFactory(TimeUtil.withDefaults.getDtfPattern())
 		source = new SqlWeatherSource(connector, CosmoWeatherTestData.coordinateSource, schemaName, weatherTableName, namingConvention, weatherFactory)
 	}
 

src/test/groovy/edu/ie3/datamodel/io/source/sql/SqlWeatherSourceIconIT.groovy

@@ -43,7 +43,7 @@ class SqlWeatherSourceIconIT extends Specification implements WeatherSourceTestH
 		postgreSQLContainer.execInContainer("psql", "-Utest", "-f/home/weather.sql")
 
 		def connector = new SqlConnector(postgreSQLContainer.jdbcUrl, postgreSQLContainer.username, postgreSQLContainer.password)
-		def weatherFactory = new IconTimeBasedWeatherValueFactory(TimeUtil.withDefaults)
+		def weatherFactory = new IconTimeBasedWeatherValueFactory(TimeUtil.withDefaults.getDtfPattern())
 		source = new SqlWeatherSource(connector, IconWeatherTestData.coordinateSource, schemaName, weatherTableName, namingConvention, weatherFactory)
 	}