org.wandora.modules

Interface DatabaseInterface

All Superinterfaces:

Module

All Known Implementing Classes:

GenericDatabaseInterface

public interface DatabaseInterface
extends Module

An interface for a module that provides database services. An implementation using JDBC is in GenericDatabaseInterface.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DatabaseInterface.DatabaseConnectionListener
static interface	DatabaseInterface.PreparedDatabaseStatement A class that holds information about a stored database statement that can be executed later, possibly multiple times.
static class	DatabaseInterface.Row A simple helper class for a single returned row, essentially just a HashMap.
static class	DatabaseInterface.Rows A simple helper class for returned rows, essentially an ArrayList of Row objects.

Method Summary

Modifier and Type	Method and Description
void	addDatabaseConnectionListener(DatabaseInterface.DatabaseConnectionListener l) Adds a database connection listener that will be notified when a database connection is established or closed.
java.lang.String	formatTimestamp(long time) Makes a time stamp value out of a milliseconds time.
java.lang.Object	insertAutoIncrement(java.lang.String query) Inserts a row with an auto increment field and returns the automatically assigned value.
DatabaseInterface.PreparedDatabaseStatement	prepareStatement(java.lang.String query) Prepares a statement for later execution.
DatabaseInterface.Rows	query(java.lang.String query) Executes a database query and returns the results.
void	removeDatabaseConnectionListener(DatabaseInterface.DatabaseConnectionListener l) Removes a database connection listener.
java.lang.String	sqlEscape(java.lang.String str) Escapes a string so that it can then be safely used as part of a query.
java.lang.String	sqlEscapeLen(java.lang.String str, int length) Escapes a string so that it can then be safely used as part of a query with a maximum length of the returned string.
int	update(java.lang.String query) Executes an update statement.

Methods inherited from interface org.wandora.modules.Module

getDependencies, init, isInitialized, isRunning, start, stop

Method Detail

query

DatabaseInterface.Rows query(java.lang.String query)
                      throws java.sql.SQLException

Executes a database query and returns the results.

Parameters:

query - The query to execute.

Returns:

The results of the query as a Rows object (essentially an ArrayList).

Throws:

java.sql.SQLException

update

int update(java.lang.String query)
    throws java.sql.SQLException

Executes an update statement.

Parameters:

query - The update statement to execute.

Returns:

The number of rows affected by the statement.

Throws:

java.sql.SQLException

insertAutoIncrement

java.lang.Object insertAutoIncrement(java.lang.String query)
                              throws java.sql.SQLException

Inserts a row with an auto increment field and returns the automatically assigned value.

Parameters:

query - The insert statement.

Returns:

The automatically assigned incremented value.

Throws:

java.sql.SQLException

sqlEscape

java.lang.String sqlEscape(java.lang.String str)

Escapes a string so that it can then be safely used as part of a query.

Parameters:

str - The string to be escaped.

Returns:

The escaped string.

sqlEscapeLen

java.lang.String sqlEscapeLen(java.lang.String str,
                              int length)

Escapes a string so that it can then be safely used as part of a query with a maximum length of the returned string. If the input value is longer than the maximum length, it will be truncated to fit the length limit.

Parameters:

str - The string to be escaped.

length - The maximum length.

Returns:

The escaped and possibly truncated string.

formatTimestamp

java.lang.String formatTimestamp(long time)

Makes a time stamp value out of a milliseconds time.

Parameters:

time - The time in milliseconds.

Returns:

The time stamp as a string.

prepareStatement

DatabaseInterface.PreparedDatabaseStatement prepareStatement(java.lang.String query)
                                                      throws java.sql.SQLException

Prepares a statement for later execution.

Parameters:

query - The statement to prepare.

Returns:

A PreparedDatabaseStatement object that can be ran later.

Throws:

java.sql.SQLException

addDatabaseConnectionListener

void addDatabaseConnectionListener(DatabaseInterface.DatabaseConnectionListener l)

Adds a database connection listener that will be notified when a database connection is established or closed.

Parameters:

l -

removeDatabaseConnectionListener

void removeDatabaseConnectionListener(DatabaseInterface.DatabaseConnectionListener l)

Removes a database connection listener.

Parameters:

l -