Package edu.ie3.datamodel.io.source

Interface TimeSeriesSource<V extends Value>

All Superinterfaces:
DataSource
All Known Implementing Classes:
CsvTimeSeriesSource, SqlTimeSeriesSource
public interface TimeSeriesSource<V extends Value> extends DataSource
The interface definition of a source, that is able to provide one specific time series for one model

  • Method Details

    • isSchemeAccepted

      @Deprecated(since="3.0", forRemoval=true) static boolean isSchemeAccepted(ColumnScheme scheme)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.0. Use TimeSeriesUtils#isSchemeAccepted(edu.ie3.datamodel.io.naming.timeseries.ColumnScheme) instead.
      Checks whether the given column scheme can be used with time series.
      Parameters:
      scheme - the column scheme to check
      Returns:
      whether the scheme is accepted or not

    • getTimeSeries

      IndividualTimeSeries<V> getTimeSeries()
      Obtain the full time series
      Returns:
      the time series

    • getTimeSeries

      IndividualTimeSeries<V> getTimeSeries(edu.ie3.util.interval.ClosedInterval<ZonedDateTime> timeInterval)
      Get the time series for the given time interval. If the interval is bigger than the time series itself, only the parts of the time series within the interval are handed back.
      Parameters:
      timeInterval - Desired time interval to cover
      Returns:
      The parts of of interest of the time series

    • getValue

      Optional<V> getValue(ZonedDateTime time)
      Get the time series value for a specific time
      Parameters:
      time - The queried time
      Returns:
      Option on a value for that time