Enhancing TimeSeriesSources with method to extract future activation ticks

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Enhancing `VoltageLevel` with `equals` method [#1063](https://github.com/ie3-institute/PowerSystemDataModel/issues/1063)
 - `ConnectorValidationUtils` checks if parallel devices is > 0 [#1077](https://github.com/ie3-institute/PowerSystemDataModel/issues/1077)
+- Enhance `TimeSeriesSource` with method to retrieve all time keys after a given key [#543](https://github.com/ie3-institute/PowerSystemDataModel/issues/543)
+- Enhance `WeatherSource` with method to retrieve all time keys after a given key [#572](https://github.com/ie3-institute/PowerSystemDataModel/issues/572)
 
 ### Fixed
 - Fixed `MappingEntryies` not getting processed by adding `Getter` methods for record fields [#1084](https://github.com/ie3-institute/PowerSystemDataModel/issues/1084) 

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

@@ -51,4 +51,12 @@ public abstract IndividualTimeSeries<V> getTimeSeries(ClosedInterval<ZonedDateTi
       throws SourceException;
 
   public abstract Optional<V> getValue(ZonedDateTime time) throws SourceException;
+
+  /**
+   * Method to return all time keys after a given timestamp.
+   *
+   * @param time given time
+   * @return a list of time keys
+   */
+  public abstract List<ZonedDateTime> getTimeKeysAfter(ZonedDateTime time);
 }

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

@@ -28,8 +28,6 @@ public abstract class WeatherSource {
 
   protected TimeBasedWeatherValueFactory weatherFactory;
 
-  protected Map<Point, IndividualTimeSeries<WeatherValue>> coordinateToTimeSeries;
-
   protected IdCoordinateSource idCoordinateSource;
 
   protected static final String COORDINATE_ID = "coordinateid";
@@ -61,6 +59,14 @@ public abstract Map<Point, IndividualTimeSeries<WeatherValue>> getWeather(
   public abstract Optional<TimeBasedValue<WeatherValue>> getWeather(
       ZonedDateTime date, Point coordinate) throws SourceException;
 
+  public abstract Map<Point, List<ZonedDateTime>> getTimeKeysAfter(ZonedDateTime time)
+      throws SourceException;
+
+  public List<ZonedDateTime> getTimeKeysAfter(ZonedDateTime time, Point coordinate)
+      throws SourceException {
+    return getTimeKeysAfter(time).getOrDefault(coordinate, Collections.emptyList());
+  }
+
   // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
   /**

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

@@ -182,6 +182,37 @@ public Optional<TimeBasedValue<WeatherValue>> getWeather(ZonedDateTime date, Poi
     }
   }
 
+  @Override
+  public Map<Point, List<ZonedDateTime>> getTimeKeysAfter(ZonedDateTime time) {
+    String query = createQueryStringForFollowingTimeKeys(time);
+    CompletableFuture<QueryResult> futureResult = connector.query(query);
+    QueryResult queryResult = futureResult.join();
+    List<JsonObject> jsonWeatherInputs = Collections.emptyList();
+    try {
+      jsonWeatherInputs = queryResult.rowsAsObject();
+    } catch (DecodingFailureException ex) {
+      logger.error("Querying weather inputs failed!", ex);
+    }
+    if (jsonWeatherInputs != null && !jsonWeatherInputs.isEmpty()) {
+
+      Map<Point, Set<TimeBasedValue<WeatherValue>>> timeBasedValues =
+          jsonWeatherInputs.stream()
+              .map(this::toTimeBasedWeatherValue)
+              .flatMap(Optional::stream)
+              .filter(t -> t.getTime().isAfter(time))
+              .collect(
+                  Collectors.groupingBy(t -> t.getValue().getCoordinate(), Collectors.toSet()));
+
+      return timeBasedValues.entrySet().stream()
+          .collect(
+              Collectors.toMap(
+                  Map.Entry::getKey,
+                  t -> t.getValue().stream().map(TimeBasedValue::getTime).sorted().toList()));
+    }
+
+    return Collections.emptyMap();
+  }
+
   /**
    * Generates a key for weather documents with the pattern: {@code
    * weather::<coordinate_id>::<time>}
@@ -216,6 +247,19 @@ public String createQueryStringForIntervalAndCoordinate(
     return basicQuery + whereClause;
   }
 
+  /**
+   * Create a query string to search for all time keys that comes after the given time.
+   *
+   * @param time given timestamp
+   * @return the query string
+   */
+  public String createQueryStringForFollowingTimeKeys(ZonedDateTime time) {
+    String basicQuery =
+        "SELECT " + connector.getBucketName() + ".* FROM " + connector.getBucketName();
+    String whereClause = " WHERE META().id > '" + generateWeatherKey(time, 0) + "'";
+    return basicQuery + whereClause;
+  }
+
   /**
    * Converts a JsonObject into TimeBasedWeatherValueData by extracting all fields into a field to
    * value map and then removing the coordinate from it to supply as a parameter

src/main/java/edu/ie3/datamodel/io/source/csv/CsvTimeSeriesSource.java

@@ -120,6 +120,11 @@ public Optional<V> getValue(ZonedDateTime time) {
     return timeSeries.getValue(time);
   }
 
+  @Override
+  public List<ZonedDateTime> getTimeKeysAfter(ZonedDateTime time) {
+    return timeSeries.getTimeKeysAfter(time);
+  }
+
   // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
   /**

src/main/java/edu/ie3/datamodel/io/source/csv/CsvWeatherSource.java

@@ -41,6 +41,7 @@
 
 /** Implements a WeatherSource for CSV files by using the CsvTimeSeriesSource as a base */
 public class CsvWeatherSource extends WeatherSource {
+  private final Map<Point, IndividualTimeSeries<WeatherValue>> coordinateToTimeSeries;
 
   private final CsvDataSource dataSource;
 
@@ -64,7 +65,7 @@ public CsvWeatherSource(
       throws SourceException {
     super(idCoordinateSource, weatherFactory);
     this.dataSource = new CsvDataSource(csvSep, folderPath, fileNamingStrategy);
-    coordinateToTimeSeries = getWeatherTimeSeries();
+    this.coordinateToTimeSeries = getWeatherTimeSeries();
   }
 
   // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
@@ -98,6 +99,12 @@ public Optional<TimeBasedValue<WeatherValue>> getWeather(ZonedDateTime date, Poi
     return timeSeries.getTimeBasedValue(date);
   }
 
+  @Override
+  public Map<Point, List<ZonedDateTime>> getTimeKeysAfter(ZonedDateTime time) {
+    return coordinateToTimeSeries.entrySet().stream()
+        .collect(Collectors.toMap(Map.Entry::getKey, t -> t.getValue().getTimeKeysAfter(time)));
+  }
+
   // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
   /**

src/main/java/edu/ie3/datamodel/io/source/influxdb/InfluxDbWeatherSource.java

@@ -133,6 +133,46 @@ public Optional<TimeBasedValue<WeatherValue>> getWeather(ZonedDateTime date, Poi
     }
   }
 
+  @Override
+  public Map<Point, List<ZonedDateTime>> getTimeKeysAfter(ZonedDateTime time) {
+    try (InfluxDB session = connector.getSession()) {
+      String query = createQueryStringForTimeKeysAfter(time);
+      QueryResult queryResult = session.query(new Query(query));
+      Stream<Optional<TimeBasedValue<WeatherValue>>> optValues =
+          optTimeBasedValueStream(queryResult);
+      Set<TimeBasedValue<WeatherValue>> timeBasedValues =
+          filterEmptyOptionals(optValues).collect(Collectors.toSet());
+      Map<Point, Set<TimeBasedValue<WeatherValue>>> coordinateToValues =
+          timeBasedValues.stream()
+              .collect(
+                  Collectors.groupingBy(
+                      timeBasedWeatherValue -> timeBasedWeatherValue.getValue().getCoordinate(),
+                      Collectors.toSet()));
+
+      return coordinateToValues.entrySet().stream()
+          .collect(
+              Collectors.toMap(
+                  Map.Entry::getKey,
+                  e -> e.getValue().stream().map(TimeBasedValue::getTime).sorted().toList()));
+    }
+  }
+
+  @Override
+  public List<ZonedDateTime> getTimeKeysAfter(ZonedDateTime time, Point coordinate) {
+    Optional<Integer> coordinateId = idCoordinateSource.getId(coordinate);
+    if (coordinateId.isEmpty()) {
+      return Collections.emptyList();
+    }
+    try (InfluxDB session = connector.getSession()) {
+      String query = createQueryStringForTimeKeysAfterWithCoordinate(time, coordinateId.get());
+      QueryResult queryResult = session.query(new Query(query));
+
+      return filterEmptyOptionals(optTimeBasedValueStream(queryResult))
+          .map(TimeBasedValue::getTime)
+          .toList();
+    }
+  }
+
   /**
    * Return the weather for the given time interval AND coordinate
    *
@@ -214,6 +254,19 @@ private String createQueryStringForTimeInterval(ClosedInterval<ZonedDateTime> ti
     return BASIC_QUERY_STRING + WHERE + createTimeConstraint(timeInterval);
   }
 
+  private String createQueryStringForTimeKeysAfter(ZonedDateTime time) {
+    return BASIC_QUERY_STRING + WHERE + createTimeConstraintAfter(time);
+  }
+
+  private String createQueryStringForTimeKeysAfterWithCoordinate(
+      ZonedDateTime time, int coordinateId) {
+    return BASIC_QUERY_STRING
+        + WHERE
+        + createCoordinateConstraintString(coordinateId)
+        + AND
+        + createTimeConstraintAfter(time);
+  }
+
   private String createTimeConstraint(ClosedInterval<ZonedDateTime> timeInterval) {
     return weatherFactory.getTimeFieldString()
         + " >= "
@@ -230,6 +283,12 @@ private String createTimeConstraint(ZonedDateTime date) {
         + date.toInstant().toEpochMilli() * MILLI_TO_NANO_FACTOR;
   }
 
+  private String createTimeConstraintAfter(ZonedDateTime time) {
+    return weatherFactory.getTimeFieldString()
+        + " > "
+        + time.toInstant().toEpochMilli() * MILLI_TO_NANO_FACTOR;
+  }
+
   private String createCoordinateConstraintString(int coordinateId) {
     return COORDINATE_ID_COLUMN_NAME + "='" + coordinateId + "'";
   }

src/main/java/edu/ie3/datamodel/io/source/sql/SqlTimeSeriesSource.java

@@ -46,6 +46,7 @@
   private final String queryFull;
 
   private final String queryTimeInterval;
+  private final String queryTimeKeysAfter;
   private final String queryTime;
 
   public SqlTimeSeriesSource(
@@ -82,6 +83,8 @@
     this.queryFull = createQueryFull(sqlDataSource.schemaName, tableName);
     this.queryTimeInterval =
         createQueryForTimeInterval(sqlDataSource.schemaName, tableName, dbTimeColumnName);
+    this.queryTimeKeysAfter =
+        createQueryForTimeKeysAfter(sqlDataSource.schemaName, tableName, dbTimeColumnName);
     this.queryTime = createQueryForTime(sqlDataSource.schemaName, tableName, dbTimeColumnName);
   }
 
@@ -187,6 +190,14 @@
     return Optional.of(timeBasedValues.stream().toList().get(0).getValue());
   }
 
+  @Override
+  public List<ZonedDateTime> getTimeKeysAfter(ZonedDateTime time) {
+    Set<TimeBasedValue<V>> timeBasedValues =
+        getTimeBasedValueSet(
+            queryTimeKeysAfter, ps -> ps.setTimestamp(1, Timestamp.from(time.toInstant())));
+    return timeBasedValues.stream().map(TimeBasedValue::getTime).sorted().toList();
+  }
+
   // -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
   /** Creates a set of TimeBasedValues from database */
@@ -245,11 +256,33 @@
         + TIME_SERIES
         + " = '"
         + timeSeriesUuid.toString()
         + "' AND "
         + timeColumnName
         + " BETWEEN ? AND ?;";
   }
 
+  /**
+   * Creates a base query to retrieve all entities for given time series uuid and in the given time
+   * frame with the following pattern: <br>
+   * {@code <base query> WHERE time_series = $timeSeriesUuid AND <time column> > ?;}
+   *
+   * @param schemaName the name of the database schema
+   * @param tableName the name of the database table
+   * @param timeColumnName the name of the column holding the timestamp info
+   * @return the query string
+   */
+  private String createQueryForTimeKeysAfter(
+      String schemaName, String tableName, String timeColumnName) {
+    return createBaseQueryString(schemaName, tableName)
+        + WHERE
+        + TIME_SERIES
+        + " = '"
+        + timeSeriesUuid.toString()
+        + "' AND "
+        + timeColumnName
+        + " > ?;";
+  }
+
   /**
    * Creates a basic query to retrieve an entry for the given time series uuid and time with the
    * following pattern: <br>