Package edu.ie3.datamodel.io.source.sql

Class SqlTimeSeriesSource<V extends Value>

java.lang.Object

edu.ie3.datamodel.io.source.sql.SqlDataSource<TimeBasedValue<V>>

edu.ie3.datamodel.io.source.sql.SqlTimeSeriesSource<V>

All Implemented Interfaces:

DataSource, TimeSeriesSource<V>

public class SqlTimeSeriesSource<V extends Value>
extends SqlDataSource<TimeBasedValue<V>>
implements TimeSeriesSource<V>

Field Summary

Fields inherited from class edu.ie3.datamodel.io.source.sql.SqlDataSource

log

Constructor Summary

Constructors

Constructor	Description
SqlTimeSeriesSource(SqlConnector connector, String schemaName, DatabaseNamingStrategy namingStrategy, UUID timeSeriesUuid, Class<V> valueClass, TimeBasedSimpleValueFactory<V> factory)	Initializes a new SqlTimeSeriesSource

Method Summary

Modifier and Type	Method	Description
protected Optional<TimeBasedValue<V>>	createEntity(Map<String,String> fieldToValues)	Build a TimeBasedValue of type V, whereas the underlying Value does not need any additional information.
static SqlTimeSeriesSource<? extends Value>	createSource(SqlConnector connector, String schemaName, DatabaseNamingStrategy namingStrategy, IndividualTimeSeriesMetaInformation metaInformation, String timePattern)	Factory method to build a source from given meta information
IndividualTimeSeries<V>	getTimeSeries()	Obtain the full time series
IndividualTimeSeries<V>	getTimeSeries(edu.ie3.util.interval.ClosedInterval<ZonedDateTime> timeInterval)	Get the time series for the given time interval.
Optional<V>	getValue(ZonedDateTime time)	Get the time series value for a specific time

Methods inherited from class edu.ie3.datamodel.io.source.sql.SqlDataSource

createBaseQueryString, executeQuery, getDbColumnName, getDbTables

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SqlTimeSeriesSource

public SqlTimeSeriesSource(SqlConnector connector,
 String schemaName,
 DatabaseNamingStrategy namingStrategy,
 UUID timeSeriesUuid,
 Class<V> valueClass,
 TimeBasedSimpleValueFactory<V> factory)

Initializes a new SqlTimeSeriesSource

Parameters:

connector - the connector needed for database connection

schemaName - the database schema to use

namingStrategy - the naming strategy for database entities

timeSeriesUuid - the uuid of the time series

valueClass - the class of returned time series values

factory - a factory that parses the input data

Method Details

createSource

public static SqlTimeSeriesSource<? extends Value> createSource(SqlConnector connector,
 String schemaName,
 DatabaseNamingStrategy namingStrategy,
 IndividualTimeSeriesMetaInformation metaInformation,
 String timePattern)
                                                         throws SourceException

Factory method to build a source from given meta information

Parameters:

connector - the connector needed for database connection

schemaName - the database schema to use

namingStrategy - the database entity naming strategy to use

metaInformation - the time series meta information

timePattern - the pattern of time values

Returns:

a SqlTimeSeriesSource for given time series table

Throws:

SourceException - if the column scheme is not supported

getTimeSeries

public IndividualTimeSeries<V> getTimeSeries()

Description copied from interface: TimeSeriesSource

Obtain the full time series

Specified by:

getTimeSeries in interface TimeSeriesSource<V extends Value>

Returns:

the time series

getTimeSeries

public IndividualTimeSeries<V> getTimeSeries(edu.ie3.util.interval.ClosedInterval<ZonedDateTime> timeInterval)

Description copied from interface: TimeSeriesSource

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.

Specified by:

getTimeSeries in interface TimeSeriesSource<V extends Value>

Parameters:

timeInterval - Desired time interval to cover

Returns:

The parts of of interest of the time series

getValue

public Optional<V> getValue(ZonedDateTime time)

Description copied from interface: TimeSeriesSource

Get the time series value for a specific time

Specified by:

getValue in interface TimeSeriesSource<V extends Value>

Parameters:

time - The queried time

Returns:

Option on a value for that time

createEntity

protected Optional<TimeBasedValue<V>> createEntity(Map<String,String> fieldToValues)

Build a TimeBasedValue of type V, whereas the underlying Value does not need any additional information.

Specified by:

createEntity in class SqlDataSource<TimeBasedValue<V extends Value>>

Parameters:

fieldToValues - Mapping from field id to values

Returns:

Optional simple time based value