Improve handling of time stamp pattern in factories

.gitattributes

@@ -1,3 +1,4 @@
 # The following file will be copied to a unix Docker image and imported to InfluxDB data base. Therefore, the line
 # ending plays a crucial role. This prevents the endings from being adjusted with 'core.autocrlf=true'
-src/test/resources/testContainerFiles/influxDb/weather.txt eol=lf
+src/test/resources/testContainerFiles/influxDb/cosmo/weather.txt eol=lf
+src/test/resources/testContainerFiles/influxDb/icon/weather.txt eol=lf

CHANGELOG.md

@@ -30,6 +30,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   Reworking the time series source (one source per time series, distinct mapping source, factory pattern)
 -   BREAKING: Moved methods `buildSafe{Coord,Point,LineString,LineStringBetweenCoords,LineStringBetweenPoints}`, `totalLengthOfLineString` from `GridAndGeoUtils` to `GeoUtils` in [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
 -   BREAKING: Moved `CoordinateDistance` to [_PowerSystemUtils_](https://github.com/ie3-institute/PowerSystemUtils)
+-   BREAKING: Weather source
+	-   Adapted data scheme (COSMO: `"coordinate"` to `"coordinate id"`, `"irradiation"` to `"irradiance"`, ICON: `"datum"` to `"time"`)
+	-   Harmonized the source of coordinate id column name across implementations of `WeatherSource`
+	-   Get field name in different casing (to actually get the column name in database, file, ...)
+	-   Force user to provide time stamp pattern to `CouchbaseWeatherSource` to ensure harmonized querying
+	-   Use naming convention dependent field names from factories within `InfluxDBWeatherSource`
+	-   Check, if time stamp pattern is [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant, as this is the output of InfluxDB
+	-   Use factory's time stamp pattern to build queries within `CouchbaseWeatherSource`
 
 ### Fixed
 -   InfluxDbConnector now keeps session instead of creating a new one each call

build.gradle

@@ -42,7 +42,7 @@ apply from: scriptsLocation + 'vcs.gradle'
 apply from: scriptsLocation + 'semVer.gradle'
 
 repositories {
-	jcenter() //searches in bintray's repository 'jCenter', which contains Maven Central
+	mavenCentral() // searches in Sonatype's repository 'Maven Central'
 	maven { url 'https://www.jitpack.io' } // allows github repos as dependencies
 
 	// sonatype snapshot repo
@@ -52,7 +52,7 @@ repositories {
 
 dependencies {
 	//	 ie³ power system utils
-	compile 'com.github.ie3-institute:PowerSystemUtils:1.5.1'
+	compile 'com.github.ie3-institute:PowerSystemUtils:1.5.2'
 
 	implementation 'tech.units:indriya:2.1.2'
 

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

@@ -5,8 +5,6 @@
 */
 package edu.ie3.datamodel.io.factory.timeseries;
 
-import static edu.ie3.datamodel.io.factory.timeseries.TimeBasedSimpleValueFactory.*;
-
 import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.timeseries.individual.TimeBasedValue;
 import edu.ie3.datamodel.models.value.WeatherValue;
@@ -25,33 +23,34 @@
 
 /**
  * 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 PsdmTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFactory {
-  private static final String COORDINATE = "coordinate";
-  private static final String DIFFUSE_IRRADIANCE = "diffuseirradiation";
-  private static final String DIRECT_IRRADIANCE = "directirradiation";
+public class CosmoTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFactory {
+  private static final String DIFFUSE_IRRADIANCE = "diffuseirradiance";
+  private static final String DIRECT_IRRADIANCE = "directirradiance";
   private static final String TEMPERATURE = "temperature";
   private static final String WIND_DIRECTION = "winddirection";
   private static final String WIND_VELOCITY = "windvelocity";
 
-  public PsdmTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
+  /**
+   * @param timeUtil The time util to use
+   * @deprecated Use {@link
+   *     CosmoTimeBasedWeatherValueFactory#CosmoTimeBasedWeatherValueFactory(String)} instead
+   */
+  @Deprecated
+  public CosmoTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
     super(timeUtil);
   }
 
-  public PsdmTimeBasedWeatherValueFactory(String timePattern) {
+  public CosmoTimeBasedWeatherValueFactory(String timePattern) {
     super(timePattern);
   }
 
-  public PsdmTimeBasedWeatherValueFactory() {
+  public CosmoTimeBasedWeatherValueFactory() {
     super();
   }
 
-  @Override
-  public String getCoordinateIdFieldString() {
-    return COORDINATE;
-  }
-
   @Override
   public String getTimeFieldString() {
     return TIME;

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;
@@ -29,14 +28,18 @@
  */
 public class IconTimeBasedWeatherValueFactory extends TimeBasedWeatherValueFactory {
   /* Redefine the column names to meet the icon specifications */
-  private static final String COORDINATE = "coordinateid";
-  private static final String TIME = "datum";
   private static final String DIFFUSE_IRRADIANCE = "aswdifdS";
   private static final String DIRECT_IRRADIANCE = "aswdirS";
   private static final String TEMPERATURE = "t2m";
   private static final String WIND_VELOCITY_U = "u131m";
   private static final String WIND_VELOCITY_V = "v131m";
 
+  /**
+   * @param timeUtil The time util to use
+   * @deprecated Use {@link
+   *     IconTimeBasedWeatherValueFactory#IconTimeBasedWeatherValueFactory(String)} instead
+   */
+  @Deprecated
   public IconTimeBasedWeatherValueFactory(TimeUtil timeUtil) {
     super(timeUtil);
   }
@@ -46,12 +49,7 @@ public IconTimeBasedWeatherValueFactory(String timePattern) {
   }
 
   public IconTimeBasedWeatherValueFactory() {
-    super(new TimeUtil(ZoneId.of("UTC"), Locale.GERMANY, "yyyy-MM-dd HH:mm:ss"));
-  }
-
-  @Override
-  public String getCoordinateIdFieldString() {
-    return COORDINATE;
+    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,49 @@
  */
 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);
+  }
+
+  public String getTimeStampPattern() {
+    return timeUtil.getDtfPattern();
   }
 }

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

@@ -7,7 +7,8 @@
 
 import edu.ie3.datamodel.models.value.WeatherValue;
 import edu.ie3.util.TimeUtil;
-import java.time.ZoneId;
+import edu.ie3.util.naming.Naming;
+import edu.ie3.util.naming.NamingConvention;
 import java.util.*;
 
 /**
@@ -16,30 +17,45 @@
  */
 public abstract class TimeBasedWeatherValueFactory
     extends TimeBasedValueFactory<TimeBasedWeatherValueData, WeatherValue> {
-  protected static final String UUID = "uuid";
-  protected static final String TIME = "time";
-
-  protected final TimeUtil timeUtil;
+  /* 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 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);
   }
 
+  /**
+   * @param timeUtil The time util to use
+   * @deprecated Use {@link TimeBasedWeatherValueFactory#TimeBasedWeatherValueFactory(String)}
+   *     instead
+   */
+  @Deprecated
   protected TimeBasedWeatherValueFactory(TimeUtil timeUtil) {
-    super(WeatherValue.class);
-    this.timeUtil = timeUtil;
+    super(timeUtil.getDtfPattern(), WeatherValue.class);
   }
 
   /**
-   * Return the field name for the coordinate id
+   * Return the field name for the coordinate id in flat case.
    *
    * @return the field name for the coordinate id
    */
-  public abstract String getCoordinateIdFieldString();
+  public String getCoordinateIdFieldString() {
+    return COORDINATE_ID_NAMING.flatCase();
+  }
+
+  /**
+   * Return the field name for the coordinate id in desired case.
+   *
+   * @param convention The desired naming convention / casing
+   * @return the field name for the coordinate id in appropriate case
+   */
+  public String getCoordinateIdFieldString(NamingConvention convention) {
+    return COORDINATE_ID_NAMING.as(convention);
+  }
 
   /**
    * Return the field name for the date time