tsdb

Class TsDB

java.lang.Object

tsdb.TsDB

All Implemented Interfaces:

java.lang.AutoCloseable

public class TsDB
extends java.lang.Object
implements java.lang.AutoCloseable

This is the main class of the timeseries database.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	configDirectory
VirtualCopyList[]	raw_copy_lists copy first found of sources to target
java.lang.String[]	raw_copy_sensor_names sensors that have raw source sensor
VirtualCopyList[]	sensor_dependency_lists sources that are needed for target
SourceCatalog	sourceCatalog
StreamStorageStreamDB	streamCache
StreamStorageStreamDB	streamStorage storage of all time series
static java.lang.String	tubedb_version

Constructor Summary

Constructors

Constructor and Description
TsDB(java.lang.String databasePath, java.lang.String cachePath, java.lang.String streamdbPathPrefix, java.lang.String configDirectory) create a new TimeSeriesDatabase object and connects to stored database files

Method Summary

Modifier and Type	Method and Description
boolean	baseAggregationExists(java.lang.String sensorName)
void	clear() Clears all database files.
void	close() Close database.
boolean	containsIgnoreSensorName(java.lang.String sensorName)
void	createSensorDependencies()
boolean	generalStationExists(java.lang.String generalStationName)
java.util.Set<java.lang.String>	getBaseAggregationSensorNames()
java.lang.String[]	getBaseSchema(java.lang.String[] rawSchema)
long[]	getBaseTimeInterval(java.lang.String stationName) gets first and last timestamp of virtualplot or station
java.lang.Float[]	getEmpiricalDiff(java.lang.String[] schema)
GeneralStation	getGeneralStation(java.lang.String generalStationName)
GeneralStation	getGeneralStationByLongName(java.lang.String longName)
java.util.Set<java.lang.String>	getGeneralStationGroups()
java.lang.String[]	getGeneralStationLongNames(java.lang.String regionName)
java.lang.String[]	getGeneralStationNames()
java.util.Collection<GeneralStation>	getGeneralStations()
java.util.stream.Stream<GeneralStation>	getGeneralStations(java.lang.String regionName)
java.util.stream.Stream<GeneralStation>	getGeneralStationsOfGroup(java.lang.String group)
LoggerType	getLoggerType(java.lang.String loggerTypeName)
java.util.Collection<LoggerType>	getLoggerTypes()
Sensor	getOrCreateSensor(java.lang.String sensorName)
Plot	getPlot(java.lang.String plotID)
java.util.stream.Stream<java.lang.String>	getPlotNames()
float[]	getReferenceValues(java.lang.String plotID, java.lang.String[] schema) Get an array of reference values of sensors at plotID.
Region	getRegion(java.lang.String regionName)
Region	getRegionByLongName(java.lang.String longName) slow method
java.util.stream.Stream<java.lang.String>	getRegionLongNames()
java.util.Set<java.lang.String>	getRegionNames()
java.util.Collection<Region>	getRegions()
Sensor	getSensor(java.lang.String sensorName)
java.lang.String[]	getSensorNamesOfPlot(java.lang.String plotID)
java.util.Collection<Sensor>	getSensors()
Sensor[]	getSensors(java.lang.String[] names) Transform array of sensor names to array of sensor objects.
Sensor[]	getSensors(java.lang.String[] names, boolean createMissing) Transform array of sensor names to array of sensor objects.
java.util.stream.Stream<Sensor>	getSensorStream(java.lang.String[] names) Get stream of sensors.
Station	getStation(java.lang.String stationName)
java.util.stream.Stream<java.lang.String>	getStationAndVirtualPlotNames(java.lang.String group)
java.util.Set<java.lang.String>	getStationNames()
java.util.Collection<Station>	getStations()
Station	getStationWithAlias(java.lang.String stationName)
long[]	getTimeInterval(java.lang.String stationName) gets first and last timestamp of virtualplot or station
java.lang.String[]	getValidSchema(java.lang.String plotID, java.lang.String[] schema)
java.lang.String[]	getValidSchemaWithVirtualSensors(java.lang.String plotID, java.lang.String[] schema)
VirtualPlot	getVirtualPlot(java.lang.String plotID)
java.util.Collection<VirtualPlot>	getVirtualPlots()
java.lang.String[]	includeVirtualSensorNames(java.lang.String[] schema) add appropriate virtual sensors to given schema
void	insertGeneralStation(GeneralStation generalStation)
void	insertIgnoreSensorName(java.lang.String sensorName)
void	insertLabeledProperty(LabeledProperty property)
void	insertLoggerType(LoggerType loggertype)
void	insertRawSensor(java.lang.String sensorName)
void	insertRegion(Region region)
void	insertSensor(Sensor sensor)
void	insertStation(Station station)
void	insertVirtualPlot(VirtualPlot virtualPlot)
boolean	isBaseSchema(java.lang.String[] schema)
boolean	isValidSchema(java.lang.String plotID, java.lang.String[] schema)
boolean	loggerTypeExists(java.lang.String loggerTypeName)
java.lang.String[]	order_by_dependency(java.lang.String[] schema) Order sensor names by transitive dependencies, sensors without dependencies first.
void	refresStationAliasMap()
boolean	regionExists(java.lang.String regionName)
void	replaceStation(Station station)
boolean	sensorExists(java.lang.String sensorName)
boolean	stationExists(java.lang.String stationName)
boolean	stationExistsWithAlias(java.lang.String stationName)
java.lang.String[]	supplementSchema(java.lang.String[] schema, java.lang.String[] availableSchema) Add sensors that are needed for virtual sensor processing in schema
void	updateGeneralStations()
boolean	virtualPlotExists(java.lang.String plotID)

Methods inherited from class java.lang.Object

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

Field Detail

tubedb_version

public static final java.lang.String tubedb_version

See Also:

Constant Field Values

streamStorage

public StreamStorageStreamDB streamStorage

storage of all time series

streamCache

public StreamStorageStreamDB streamCache

sourceCatalog

public SourceCatalog sourceCatalog

configDirectory

public final java.lang.String configDirectory

raw_copy_lists

public VirtualCopyList[] raw_copy_lists

copy first found of sources to target

sensor_dependency_lists

public VirtualCopyList[] sensor_dependency_lists

sources that are needed for target

raw_copy_sensor_names

public java.lang.String[] raw_copy_sensor_names

sensors that have raw source sensor

Constructor Detail

TsDB

public TsDB(java.lang.String databasePath,
            java.lang.String cachePath,
            java.lang.String streamdbPathPrefix,
            java.lang.String configDirectory)

create a new TimeSeriesDatabase object and connects to stored database files

Parameters:

databasePath -

cachePath -

streamdbPathPrefix -

configDirectory -

Method Detail

clear

public void clear()

Clears all database files.

close

public void close()

Close database. All pending data is written to disk.

Specified by:

close in interface java.lang.AutoCloseable

getEmpiricalDiff

public java.lang.Float[] getEmpiricalDiff(java.lang.String[] schema)

getSensors

public Sensor[] getSensors(java.lang.String[] names)

Transform array of sensor names to array of sensor objects. Complement missing sensors by new raw sensor objects.

Parameters:

outputTimeSeriesSchema -

Returns:

getSensors

public Sensor[] getSensors(java.lang.String[] names,
                           boolean createMissing)

Transform array of sensor names to array of sensor objects.

Parameters:

names -

createMissing - complement missing sensors by new raw sensor objects or set entry to null

Returns:

getSensorStream

public java.util.stream.Stream<Sensor> getSensorStream(java.lang.String[] names)

Get stream of sensors.

Parameters:

names -

Returns:

stream of sensors (or null elements if sensor not exists).

updateGeneralStations

public void updateGeneralStations()

getStation

public Station getStation(java.lang.String stationName)

getStationWithAlias

public Station getStationWithAlias(java.lang.String stationName)

getStations

public java.util.Collection<Station> getStations()

refresStationAliasMap

public void refresStationAliasMap()

getStationNames

public java.util.Set<java.lang.String> getStationNames()

stationExists

public boolean stationExists(java.lang.String stationName)

stationExistsWithAlias

public boolean stationExistsWithAlias(java.lang.String stationName)

insertStation

public void insertStation(Station station)

replaceStation

public void replaceStation(Station station)

getTimeInterval

public long[] getTimeInterval(java.lang.String stationName)

gets first and last timestamp of virtualplot or station

Parameters:

stationName -

Returns:

null if empty

getBaseTimeInterval

public long[] getBaseTimeInterval(java.lang.String stationName)

gets first and last timestamp of virtualplot or station

Parameters:

stationName -

Returns:

null if empty

generalStationExists

public boolean generalStationExists(java.lang.String generalStationName)

insertGeneralStation

public void insertGeneralStation(GeneralStation generalStation)

getGeneralStations

public java.util.Collection<GeneralStation> getGeneralStations()

getGeneralStationsOfGroup

public java.util.stream.Stream<GeneralStation> getGeneralStationsOfGroup(java.lang.String group)

getGeneralStation

public GeneralStation getGeneralStation(java.lang.String generalStationName)

getGeneralStationByLongName

public GeneralStation getGeneralStationByLongName(java.lang.String longName)

getGeneralStationNames

public java.lang.String[] getGeneralStationNames()

getGeneralStations

public java.util.stream.Stream<GeneralStation> getGeneralStations(java.lang.String regionName)

getGeneralStationGroups

public java.util.Set<java.lang.String> getGeneralStationGroups()

getStationAndVirtualPlotNames

public java.util.stream.Stream<java.lang.String> getStationAndVirtualPlotNames(java.lang.String group)

getPlotNames

public java.util.stream.Stream<java.lang.String> getPlotNames()

sensorExists

public boolean sensorExists(java.lang.String sensorName)

insertSensor

public void insertSensor(Sensor sensor)

getSensor

public Sensor getSensor(java.lang.String sensorName)

getOrCreateSensor

public Sensor getOrCreateSensor(java.lang.String sensorName)

getSensors

public java.util.Collection<Sensor> getSensors()

loggerTypeExists

public boolean loggerTypeExists(java.lang.String loggerTypeName)

insertLoggerType

public void insertLoggerType(LoggerType loggertype)

getLoggerType

public LoggerType getLoggerType(java.lang.String loggerTypeName)

getLoggerTypes

public java.util.Collection<LoggerType> getLoggerTypes()

virtualPlotExists

public boolean virtualPlotExists(java.lang.String plotID)

insertVirtualPlot

public void insertVirtualPlot(VirtualPlot virtualPlot)

getVirtualPlot

public VirtualPlot getVirtualPlot(java.lang.String plotID)

getVirtualPlots

public java.util.Collection<VirtualPlot> getVirtualPlots()

containsIgnoreSensorName

public boolean containsIgnoreSensorName(java.lang.String sensorName)

insertIgnoreSensorName

public void insertIgnoreSensorName(java.lang.String sensorName)

regionExists

public boolean regionExists(java.lang.String regionName)

insertRegion

public void insertRegion(Region region)

getRegions

public java.util.Collection<Region> getRegions()

getRegionNames

public java.util.Set<java.lang.String> getRegionNames()

getRegionLongNames

public java.util.stream.Stream<java.lang.String> getRegionLongNames()

getRegionByLongName

public Region getRegionByLongName(java.lang.String longName)

slow method

Parameters:

longName -

Returns:

getRegion

public Region getRegion(java.lang.String regionName)

getGeneralStationLongNames

public java.lang.String[] getGeneralStationLongNames(java.lang.String regionName)

baseAggregationExists

public boolean baseAggregationExists(java.lang.String sensorName)

insertRawSensor

public void insertRawSensor(java.lang.String sensorName)

getBaseSchema

public java.lang.String[] getBaseSchema(java.lang.String[] rawSchema)

getBaseAggregationSensorNames

public java.util.Set<java.lang.String> getBaseAggregationSensorNames()

isBaseSchema

public boolean isBaseSchema(java.lang.String[] schema)

getSensorNamesOfPlot

public java.lang.String[] getSensorNamesOfPlot(java.lang.String plotID)

getValidSchema

public java.lang.String[] getValidSchema(java.lang.String plotID,
                                         java.lang.String[] schema)

getValidSchemaWithVirtualSensors

public java.lang.String[] getValidSchemaWithVirtualSensors(java.lang.String plotID,
                                                           java.lang.String[] schema)

isValidSchema

public boolean isValidSchema(java.lang.String plotID,
                             java.lang.String[] schema)

getReferenceValues

public float[] getReferenceValues(java.lang.String plotID,
                                  java.lang.String[] schema)

Get an array of reference values of sensors at plotID.

Parameters:

plotID -

schema -

Returns:

includeVirtualSensorNames

public java.lang.String[] includeVirtualSensorNames(java.lang.String[] schema)

add appropriate virtual sensors to given schema

Parameters:

schema - (nullable) (if null returns null)

Returns:

expanded schema (nullable)

supplementSchema

public java.lang.String[] supplementSchema(java.lang.String[] schema,
                                           java.lang.String[] availableSchema)

Add sensors that are needed for virtual sensor processing in schema

Parameters:

schema - with virtual sensors

availableSchema - available sensors

Returns:

schema + additional sensors

getPlot

public Plot getPlot(java.lang.String plotID)

insertLabeledProperty

public void insertLabeledProperty(LabeledProperty property)

createSensorDependencies

public void createSensorDependencies()

order_by_dependency

public java.lang.String[] order_by_dependency(java.lang.String[] schema)

Order sensor names by transitive dependencies, sensors without dependencies first.

Parameters:

schema -

Returns: