org.dsa.iot.historian.database

Class Database

java.lang.Object

org.dsa.iot.historian.database.Database

public abstract class Database
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Database(java.lang.String name, DatabaseProvider provider)

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes the database connection and frees any resources.
void	connect(org.dsa.iot.dslink.util.handler.Handler<Database> onConnected) Performs a connection to the database supporting reconnecting if a connection gets dropped.
DatabaseProvider	getProvider()
abstract void	initExtensions(org.dsa.iot.dslink.node.Node node) Initialize additional top level database data and settings.
protected abstract void	performConnect() Performs a raw connection to the database endpoint.
abstract void	query(java.lang.String path, long from, long to, org.dsa.iot.dslink.util.handler.CompleteHandler<QueryData> handler) Times must be in UTC.
abstract QueryData	queryFirst(java.lang.String path)
abstract QueryData	queryLast(java.lang.String path)
abstract void	write(java.lang.String path, org.dsa.iot.dslink.node.value.Value value, long ts) Values must be written into the database in UTC.

Methods inherited from class java.lang.Object

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

Constructor Detail

Database

public Database(java.lang.String name,
                DatabaseProvider provider)

Method Detail

getProvider

public DatabaseProvider getProvider()

connect

public void connect(org.dsa.iot.dslink.util.handler.Handler<Database> onConnected)

Performs a connection to the database supporting reconnecting if a connection gets dropped.

Parameters:

onConnected - Called when the database is connected.

write

public abstract void write(java.lang.String path,
                           org.dsa.iot.dslink.node.value.Value value,
                           long ts)

Values must be written into the database in UTC.

Parameters:

path - Path to query.

value - Value received from the server.

ts - Converted time in UTC.

See Also:

TimeParser

query

public abstract void query(java.lang.String path,
                           long from,
                           long to,
                           org.dsa.iot.dslink.util.handler.CompleteHandler<QueryData> handler)

Times must be in UTC. At the end of the query, the handler must receive a null event in order to close the table stream.

Parameters:

path - Path to query.

from - Beginning search time.

to - End search time.

handler - Handler callback for incoming data.

queryFirst

public abstract QueryData queryFirst(java.lang.String path)

Parameters:

path - Path to query.

Returns:

The first value stored in the database.

queryLast

public abstract QueryData queryLast(java.lang.String path)

Parameters:

path - Path to query.

Returns:

The last value stored in the database.

close

public abstract void close()
                    throws java.lang.Exception

Closes the database connection and frees any resources.

Throws:

java.lang.Exception - Convenience for a failed close.

performConnect

protected abstract void performConnect()
                                throws java.lang.Exception

Performs a raw connection to the database endpoint.

Throws:

java.lang.Exception - Connection failed.

initExtensions

public abstract void initExtensions(org.dsa.iot.dslink.node.Node node)

Initialize additional top level database data and settings. All settings should be stored in the "edit" action for consistency.

Parameters:

node - Node to initialize data, usually database node.

See Also:

For action permission level.