Addressing reviewer's comments

ie3-institute · Dec 21, 2021 · 4ec75a4 · 4ec75a4
1 parent f57531f
commit 4ec75a4
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 13 deletions.
diff --git a/src/main/java/edu/ie3/datamodel/io/source/TimeSeriesSource.java b/src/main/java/edu/ie3/datamodel/io/source/TimeSeriesSource.java
@@ -5,10 +5,14 @@
 */
 package edu.ie3.datamodel.io.source;
 
+import static edu.ie3.datamodel.io.csv.timeseries.ColumnScheme.*;
+
+import edu.ie3.datamodel.io.csv.timeseries.ColumnScheme;
 import edu.ie3.datamodel.models.timeseries.individual.IndividualTimeSeries;
 import edu.ie3.datamodel.models.value.Value;
 import edu.ie3.util.interval.ClosedInterval;
 import java.time.ZonedDateTime;
+import java.util.EnumSet;
 import java.util.Optional;
 
 /**
@@ -17,6 +21,23 @@
  */
 public interface TimeSeriesSource<V extends Value> extends DataSource {
 
+  /**
+   * Checks whether the given column scheme can be used with time series.
+   *
+   * @param scheme the column scheme to check
+   * @return whether the scheme is accepted or not
+   */
+  static boolean isSchemeAccepted(ColumnScheme scheme) {
+    return EnumSet.of(
+            ACTIVE_POWER,
+            APPARENT_POWER,
+            ENERGY_PRICE,
+            APPARENT_POWER_AND_HEAT_DEMAND,
+            ACTIVE_POWER_AND_HEAT_DEMAND,
+            HEAT_DEMAND)
+        .contains(scheme);
+  }
+
   /**
    * Obtain the full time series
    *

diff --git a/src/main/java/edu/ie3/datamodel/io/source/csv/CsvTimeSeriesSource.java b/src/main/java/edu/ie3/datamodel/io/source/csv/CsvTimeSeriesSource.java
@@ -5,11 +5,8 @@
 */
 package edu.ie3.datamodel.io.source.csv;
 
-import static edu.ie3.datamodel.io.csv.timeseries.ColumnScheme.*;
-
 import edu.ie3.datamodel.exceptions.SourceException;
 import edu.ie3.datamodel.io.connectors.CsvFileConnector;
-import edu.ie3.datamodel.io.csv.timeseries.ColumnScheme;
 import edu.ie3.datamodel.io.factory.timeseries.*;
 import edu.ie3.datamodel.io.naming.FileNamingStrategy;
 import edu.ie3.datamodel.io.source.TimeSeriesSource;
@@ -29,15 +26,6 @@
 /** Source that is capable of providing information around time series from csv files. */
 public class CsvTimeSeriesSource<V extends Value> extends CsvDataSource
     implements TimeSeriesSource<V> {
-  private static final EnumSet<ColumnScheme> acceptableSchemes =
-      EnumSet.of(
-          ACTIVE_POWER,
-          APPARENT_POWER,
-          ENERGY_PRICE,
-          APPARENT_POWER_AND_HEAT_DEMAND,
-          ACTIVE_POWER_AND_HEAT_DEMAND,
-          HEAT_DEMAND);
-
   private final IndividualTimeSeries<V> timeSeries;
 
   /**
@@ -56,7 +44,7 @@ public static CsvTimeSeriesSource<? extends Value> getSource(
       FileNamingStrategy fileNamingStrategy,
       CsvFileConnector.CsvIndividualTimeSeriesMetaInformation metaInformation)
       throws SourceException {
-    if (!acceptableSchemes.contains(metaInformation.getColumnScheme()))
+    if (!TimeSeriesSource.isSchemeAccepted(metaInformation.getColumnScheme()))
       throw new SourceException(
           "Unsupported column scheme '" + metaInformation.getColumnScheme() + "'.");
 

diff --git a/src/main/java/edu/ie3/datamodel/io/source/sql/SqlDataSource.java b/src/main/java/edu/ie3/datamodel/io/source/sql/SqlDataSource.java
@@ -67,6 +67,14 @@ protected static String getDbColumnName(
             + "Please ensure that the database connection is working and the column names are correct!");
   }
 
+  /**
+   * Interface for anonymous functions that are used as a parameter for {@link #executeQuery}.
+   *
+   * <p>For example, it can be defined this way: {@code ps -> ps.setInt(1, 2)}
+   *
+   * <p>(We cannot use {@link java.util.function.Function} here because it throws SQLException).
+   */
+  @FunctionalInterface
   interface AddParams {
     /**
      * Enhance a PreparedStatement by inserting parameters for wildcards