org.josef.jdbc

Class Database

java.lang.Object

org.josef.jdbc.Database

Direct Known Subclasses:

DerbyDatabase, OracleDatabase

public abstract class Database
extends Object

Utility class to access a relational database.
Many overloaded methods exists in this class where one method accepts a DataSource and the other accepts a Connection. The methods accepting a DataSource get and close connections automatically. When you execute multiple statements in a row and worry about performance then get the connection from a DataSource and use the connection over and over again before closing it yourself.
Note many methods in this class accept sql parameters and you might expect your JDBC driver to accept null values but some drivers don't. To prevent errors you may want to pass in objects of type CType. An object of this type is automatically considered to be a null type and is handled properly!

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAM_NAME_CONNECTION Parameter name: connection.
protected static String	PARAM_NAME_DATA_SOURCE Parameter name: dataSource.
protected static String	PARAM_NAME_NAME Parameter name: name.
protected static String	PARAM_NAME_OWNER Parameter name: owner.
protected static String	PARAM_NAME_RESULT_SET_ROW_CALL_BACK Parameter name: resultSetRowCallBack.
protected static String	PARAM_NAME_SQL_STATEMENT Parameter name: sqlStatement.
protected static String	PARAM_NAME_TABLE_NAME Parameter name: tableName.

Method Summary

Modifier and Type	Method and Description
static int	execute(Connection connection, String sqlStatement, Object... parameters) Executes a sql statement that is not a SELECT statement.
static int	execute(DataSource dataSource, String sqlStatement, Object... parameters) Executes a sql statement that is not a SELECT statement.
static <T> List<T>	executeQuery(Connection connection, Integer maximumNumberOfRows, ResultSetRowCallBackInterface<T> resultSetRowCallBack, String sqlStatement, Object... parameters) Executes a SELECT statement.
static List<List<Object>>	executeQuery(Connection connection, Integer maximumNumberOfRows, String sqlStatement, Object... parameters) Executes a SELECT statement.
static List<List<Object>>	executeQuery(Connection connection, String sqlStatement, Object... parameters) Executes a SELECT statement.
static <T> List<T>	executeQuery(DataSource dataSource, Integer maximumNumberOfRows, ResultSetRowCallBackInterface<T> resultSetRowCallBack, String sqlStatement, Object... parameters) Executes a SELECT statement.
static List<List<Object>>	executeQuery(DataSource dataSource, Integer maximumNumberOfRows, String sqlStatement, Object... parameters) Executes a SELECT statement.
static List<List<Object>>	executeQuery(DataSource dataSource, String sqlStatement, Object... parameters) Executes a SELECT statement.
static <T> long	executeQueryWithLargeResultSet(Connection connection, ResultSetRowCallBackInterface<T> resultSetRowCallBack, String sqlStatement, Object... parameters) Executes a SELECT statement that could possible result in a large result set.
static <T> long	executeQueryWithLargeResultSet(DataSource dataSource, ResultSetRowCallBackInterface<T> resultSetRowCallBack, String sqlStatement, Object... parameters) Executes a SELECT statement that could possible result in a large result set.
static double	executeSingleDoubleResultQuery(Connection connection, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row.
static double	executeSingleDoubleResultQuery(DataSource dataSource, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row.
static long	executeSingleLongResultQuery(Connection connection, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row.
static long	executeSingleLongResultQuery(DataSource dataSource, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row.
static Object	executeSingleOptionalResultQuery(Connection connection, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row provided that the query results in the selection of a row.
static Object	executeSingleOptionalResultQuery(DataSource dataSource, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row provided that the query results in the selection of a row.
static Object	executeSingleResultQuery(Connection connection, String sqlStatement, Object... parameters) Executes a SELECT statement that will fetch the first column from the first row.
static <T> T	executeSingleRowResultQuery(Connection connection, ResultSetRowCallBackInterface<T> resultSetRowCallBack, String sqlStatement, Object... parameters) Executes a SELECT statement that returns a single row.
static List<Object>	executeSingleRowResultQuery(Connection connection, String sqlStatement, Object... parameters) Executes a SELECT statement that returns a single row.
static <T> T	executeSingleRowResultQuery(DataSource dataSource, ResultSetRowCallBackInterface<T> resultSetRowCallBack, String sqlStatement, Object... parameters) Executes a SELECT statement that returns a single row.
static List<Object>	executeSingleRowResultQuery(DataSource dataSource, String sqlStatement, Object... parameters) Executes a SELECT statement that returns a single row.
abstract Constraint	getActualConstraint(Connection connection, String owner, String name) Gets the constraint owned by the supplied owner and with the supplied name, from the database.
abstract List<Constraint>	getActualConstraints(Connection connection, String owner, String tableName) Gets all constraints on the supplied tableName, owned by the supplied owner.
static Database	getActualDatabase(DatabaseMetaData databaseMetaData) Gets the actual database, like DerbyDatabase or OracleDatabase.
protected abstract Timestamp	getActualDatabaseTime(Connection connection) Gets the time of the actual database.
protected abstract Table	getActualTableMetaData(Connection connection, String owner, String tableName) Gets the meta data of the table identified by the supplied tableName.
protected abstract List<String>	getActualTables(Connection connection, String owner) Gets the database tables owned by the supplied owner.
static Constraint	getConstraint(Connection connection, String owner, String name) Gets the constraint owned by the supplied owner and with the supplied name, from the database.
static Constraint	getConstraint(DataSource dataSource, String owner, String name) Gets the constraint owned by the supplied owner and with the supplied name, from the database.
static List<Constraint>	getConstraints(Connection connection, String owner, String tableName) Gets all constraints on the supplied tableName, owned by the supplied owner.
static List<Constraint>	getConstraints(DataSource dataSource, String owner, String tableName) Gets all constraints on the supplied tableName, owned by the supplied owner.
static Timestamp	getDatabaseTime(Connection connection) Gets the time from the database server.
static Timestamp	getDatabaseTime(DataSource dataSource) Gets the time from the database server.
protected List<Column>	getTableColumns(Connection connection, String tableName) Gets the list of columns that are present in the table identified by the supplied tableName.
static Table	getTableMetaData(Connection connection, String owner, String tableName) Gets the meta data of the table identified by the supplied table.
static Table	getTableMetaData(DataSource dataSource, String owner, String tableName) Gets the meta data of the table identified by the supplied tableName.
static List<String>	getTables(Connection connection, String owner) Gets the names of all the database tables for the supplied owner.
static List<String>	getTables(DataSource dataSource, String owner) Gets the names of all the database tables for the supplied owner.
protected abstract String	getTimestampColumnName() Gets the column name the database uses to get or insert a timestamp.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_NAME_CONNECTION

protected static final String PARAM_NAME_CONNECTION

Parameter name: connection.

See Also:

Constant Field Values

PARAM_NAME_DATA_SOURCE

protected static final String PARAM_NAME_DATA_SOURCE

Parameter name: dataSource.

See Also:

Constant Field Values

PARAM_NAME_NAME

protected static final String PARAM_NAME_NAME

Parameter name: name.

See Also:

Constant Field Values

PARAM_NAME_OWNER

protected static final String PARAM_NAME_OWNER

Parameter name: owner.

See Also:

Constant Field Values

PARAM_NAME_RESULT_SET_ROW_CALL_BACK

protected static final String PARAM_NAME_RESULT_SET_ROW_CALL_BACK

Parameter name: resultSetRowCallBack.

See Also:

Constant Field Values

PARAM_NAME_SQL_STATEMENT

protected static final String PARAM_NAME_SQL_STATEMENT

Parameter name: sqlStatement.

See Also:

Constant Field Values

PARAM_NAME_TABLE_NAME

protected static final String PARAM_NAME_TABLE_NAME

Parameter name: tableName.

See Also:

Constant Field Values

Method Detail

getActualDatabase

public static Database getActualDatabase(DatabaseMetaData databaseMetaData)
                                  throws SQLException

Gets the actual database, like DerbyDatabase or OracleDatabase.

Parameters:

databaseMetaData - Meta data that is used to determine what the actual underlying database is.

Returns:

The actual database, like DerbyDatabase or OracleDatabase.

Throws:

NullPointerException - When the supplied databaseMetaData is null.

SQLException - When the database could not be obtained from the supplied databaseMetaData or when the database could be obtained but corresponds to a database that we do not support.
Currently we support: Oracle and Derby.

execute

public static int execute(DataSource dataSource,
                          String sqlStatement,
                          Object... parameters)
                   throws SQLException

Executes a sql statement that is not a SELECT statement.

Parameters:

dataSource - DataSource used to get a connection from.

sqlStatement - SQL statement that is not a SELECT statement.

parameters - The optional parameters to use in the insert/update/delete statement.

Returns:

Number of updated/inserted/deleted records.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

execute

public static int execute(Connection connection,
                          String sqlStatement,
                          Object... parameters)
                   throws SQLException

Executes a sql statement that is not a SELECT statement.

Parameters:

connection - The database connection.

sqlStatement - SQL statement that is not a SELECT statement.

parameters - The optional parameters to use in the insert/update/delete statement.

Returns:

Number of updated/inserted/deleted records.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeQuery

public static List<List<Object>> executeQuery(DataSource dataSource,
                                              String sqlStatement,
                                              Object... parameters)
                                       throws SQLException

Executes a SELECT statement.

Parameters:

dataSource - DataSource used to get a connection from.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

List of rows where each row is a list of columns.
The returned list may be empty but will never be null.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeQuery

public static List<List<Object>> executeQuery(Connection connection,
                                              String sqlStatement,
                                              Object... parameters)
                                       throws SQLException

Executes a SELECT statement.

Parameters:

connection - The database connection.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

List of rows where each row is a list of columns.
The returned list may be empty but will never be null.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied connection or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeQuery

public static List<List<Object>> executeQuery(DataSource dataSource,
                                              Integer maximumNumberOfRows,
                                              String sqlStatement,
                                              Object... parameters)
                                       throws SQLException

Executes a SELECT statement.
When a maximumNumberOfRows is supplied than this method will return a list with a size less than or equal to the supplied maximumNumberOfRows.

Parameters:

dataSource - DataSource used to get a connection from.

maximumNumberOfRows - The maximum number of rows that the returned list of rows is allowed to contain.
Supply null to return all rows.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

List of rows where each row consists of a list of columns.
The returned list may be empty but will never be null.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty or when a maximumNumberOfRows less than 1 has been supplied (only thrown when debug mode is enabled).

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null (only thrown when debug mode is enabled).

SQLException - When the statement could not be executed.

executeQuery

public static List<List<Object>> executeQuery(Connection connection,
                                              Integer maximumNumberOfRows,
                                              String sqlStatement,
                                              Object... parameters)
                                       throws SQLException

Executes a SELECT statement.
When a maximumNumberOfRows is supplied than this method will return a list with a size less than or equal to the supplied maximumNumberOfRows.

Parameters:

connection - The database connection.

maximumNumberOfRows - The maximum number of rows that the returned list of rows is allowed to contain.
Supply null to return all rows.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

List of rows.
Each row will consist of a list of columns.
The returned list may be empty but will never be null.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty or when a maximumNumberOfRows less than 1 has been supplied (only thrown when debug mode is enabled).

NullPointerException - When either the supplied connection or the supplied sqlStatement is null (only thrown when debug mode is enabled).

SQLException - When the statement could not be executed.

executeQuery

public static <T> List<T> executeQuery(DataSource dataSource,
                                       Integer maximumNumberOfRows,
                                       ResultSetRowCallBackInterface<T> resultSetRowCallBack,
                                       String sqlStatement,
                                       Object... parameters)
                                throws SQLException

Executes a SELECT statement.
When a maximumNumberOfRows is supplied than this method will return a list with a size less than or equal to the supplied maximumNumberOfRows.

Type Parameters:

T - Type of the elements in the ResultSetRowCallBackInterface.

Parameters:

dataSource - DataSource used to get a connection from.

maximumNumberOfRows - The maximum number of rows that the returned list of rows is allowed to contain.
Supply null to return all rows.

resultSetRowCallBack - Object that will be called back for every row fetched from the result set.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

List where each element is of type <T>. Each row could for example may consist of a value object.
The returned list may be empty but will never be null.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty or when a maximumNumberOfRows less than 1 has been supplied (only thrown when debug mode is enabled).

NullPointerException - When either the supplied dataSource or the supplied resultSetRowCallBack or the supplied sqlStatement is null (only thrown when debug mode is enabled).

SQLException - When the statement could not be executed.

executeQuery

public static <T> List<T> executeQuery(Connection connection,
                                       Integer maximumNumberOfRows,
                                       ResultSetRowCallBackInterface<T> resultSetRowCallBack,
                                       String sqlStatement,
                                       Object... parameters)
                                throws SQLException

Executes a SELECT statement.
When a maximumNumberOfRows is supplied than this method will return a list with a size less than or equal to the supplied maximumNumberOfRows.

Type Parameters:

T - Type of the elements in the ResultSetRowCallBackInterface.

Parameters:

connection - The database connection.

maximumNumberOfRows - The maximum number of rows that the returned list of rows is allowed to contain.
Supply null to return all rows.

resultSetRowCallBack - Object that will be called back for every row fetched from the result set.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

List of rows.
Each row will consist of a list of columns when the supplied resultSetRowCallBack is null. When the call-back mechanism is used however, the content of each row depends upon the value returned by the call-back mechanism. Each row could for example consist of a value object.
The returned list may be empty but will never be null.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty or when a maximumNumberOfRows less than 1 has been supplied (only thrown when debug mode is enabled).

NullPointerException - When either the supplied connection or the supplied resultSetRowCallBack or the supplied sqlStatement is null (only thrown when debug mode is enabled).

SQLException - When the statement could not be executed.

executeQueryWithLargeResultSet

public static <T> long executeQueryWithLargeResultSet(DataSource dataSource,
                                                      ResultSetRowCallBackInterface<T> resultSetRowCallBack,
                                                      String sqlStatement,
                                                      Object... parameters)
                                               throws SQLException

Executes a SELECT statement that could possible result in a large result set.
Other executeQuery...(...) methods in this class store the result set in memory whereas this method reads the result set record by record and passes it on to the supplied resultSetRowCallBack interface. Once you have processed a row it is lost!

Type Parameters:

T - Type of the elements in the ResultSetRowCallBackInterface.

Parameters:

dataSource - DataSource used to get a connection from.

resultSetRowCallBack - Object that will be called back for every row fetched from the result set.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

Number of selected rows.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource or the supplied sqlStatement or the supplied resultSetRowCallBack, is null.

SQLException - When the statement could not be executed.

executeQueryWithLargeResultSet

public static <T> long executeQueryWithLargeResultSet(Connection connection,
                                                      ResultSetRowCallBackInterface<T> resultSetRowCallBack,
                                                      String sqlStatement,
                                                      Object... parameters)
                                               throws SQLException

Executes a SELECT statement that could possible result in a large result set.
Other executeQuery...(...) methods in this class store the result set in memory whereas this method reads the result set record by record and passes it on to the supplied resultSetRowCallBack interface. Once you have processed a row it is lost!

Type Parameters:

T - Type of the elements in the ResultSetRowCallBackInterface.

Parameters:

connection - The database connection.

resultSetRowCallBack - Object that will be called back for every row fetched from the result set.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

Number of selected rows.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied connection or the supplied sqlStatement or the supplied resultSetRowCallBack, is null.

SQLException - When the statement could not be executed.

executeSingleRowResultQuery

public static <T> T executeSingleRowResultQuery(DataSource dataSource,
                                                ResultSetRowCallBackInterface<T> resultSetRowCallBack,
                                                String sqlStatement,
                                                Object... parameters)
                                         throws SQLException

Executes a SELECT statement that returns a single row.

Type Parameters:

T - Type of the elements in the ResultSetRowCallBackInterface.

Parameters:

dataSource - DataSource used to get a connection from.

resultSetRowCallBack - Object that will be called back for every row fetched from the result set.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

Single object representing the requested row (e.g. Value Object).
Note: Even when the supplied sqlStatements results in more than one row, only the first row (without warning) will be returned.
Null is returned when execution of the query resulted in zero rows.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource, resultSetRowCallBack or sqlStatement is null.

SQLException - When the statement could not be executed.

executeSingleRowResultQuery

public static <T> T executeSingleRowResultQuery(Connection connection,
                                                ResultSetRowCallBackInterface<T> resultSetRowCallBack,
                                                String sqlStatement,
                                                Object... parameters)
                                         throws SQLException

Executes a SELECT statement that returns a single row.

Type Parameters:

T - Type of the elements in the ResultSetRowCallBackInterface.

Parameters:

connection - The database connection.

resultSetRowCallBack - Object that will be called back for every row fetched from the result set.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

Single object representing the requested row (e.g. Value Object).
Note: Even when the supplied sqlStatements results in more than one row, only the first row (without warning) will be returned.
Null is returned when execution of the query resulted in zero rows.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource, resultSetRowCallBack or sqlStatement is null.

SQLException - When the statement could not be executed.

executeSingleRowResultQuery

public static List<Object> executeSingleRowResultQuery(DataSource dataSource,
                                                       String sqlStatement,
                                                       Object... parameters)
                                                throws SQLException

Executes a SELECT statement that returns a single row.

Parameters:

dataSource - DataSource used to get a connection from.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

A list of columns.
Note: Even when the supplied sqlStatements results in more than one row, only the first row (without warning) will be returned.
Null is returned when execution of the query resulted in zero rows.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource, or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeSingleRowResultQuery

public static List<Object> executeSingleRowResultQuery(Connection connection,
                                                       String sqlStatement,
                                                       Object... parameters)
                                                throws SQLException

Executes a SELECT statement that returns a single row.

Parameters:

connection - The database connection.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

A list of columns.
Note: Even when the supplied sqlStatements results in more than one row, only the first row (without warning) will be returned.
Null is returned when execution of the query resulted in zero rows.

Throws:

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource, or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeSingleLongResultQuery

public static long executeSingleLongResultQuery(DataSource dataSource,
                                                String sqlStatement,
                                                Object... parameters)
                                         throws SQLException

Executes a SELECT statement that will fetch the first column from the first row.
The column read should be a column that can be converted to a long value! Use this method for example to execute a SELECT COUNT(1) ... statement.

Parameters:

dataSource - DataSource used to get a connection from.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row.

Throws:

ClassCastException - When the read column is not a Number.

IllegalArgumentException - When the supplied sqlStatement is empty.

NullPointerException - When either the supplied dataSource or the sqlStatement is null.

SQLException - When the statement could not be executed.
Note: No SQLException is thrown when the result set contains more than one row!

NoSingleRowResultSetException - When the supplied statement results in a result set without any records.

executeSingleLongResultQuery

public static long executeSingleLongResultQuery(Connection connection,
                                                String sqlStatement,
                                                Object... parameters)
                                         throws SQLException

Executes a SELECT statement that will fetch the first column from the first row.
The column read should be a column that can be converted to a long value! Use this method for example to execute a SELECT COUNT(1) ... statement.

Parameters:

connection - The database connection.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row.

Throws:

ClassCastException - When the read column is not a Number.

IllegalArgumentException - When the supplied sqlStatement is empty.

NoSingleRowResultSetException - When the supplied statement results in a result set without any records.
Note: This Exception is not thrown when the result set contains more than one row!

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeSingleDoubleResultQuery

public static double executeSingleDoubleResultQuery(DataSource dataSource,
                                                    String sqlStatement,
                                                    Object... parameters)
                                             throws SQLException

Executes a SELECT statement that will fetch the first column from the first row.
The column read should be a column that can be converted to a double value! Use this method for example to execute a SELECT MAX(...) ... statement.

Parameters:

dataSource - DataSource used to get a connection from.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row.

Throws:

ClassCastException - When the read column is not a Number.

IllegalArgumentException - When the supplied sqlStatement is empty.

NoSingleRowResultSetException - When the supplied statement results in a result set without any records.
Note: This Exception is not thrown when the result set contains more than one row!

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null.

SQLException - When the statement could not be executed or when the result set contains zero rows.
Note: No SQLException is thrown when the result set contains more than one row!

executeSingleDoubleResultQuery

public static double executeSingleDoubleResultQuery(Connection connection,
                                                    String sqlStatement,
                                                    Object... parameters)
                                             throws SQLException

Executes a SELECT statement that will fetch the first column from the first row.
The column read should be a column that can be converted to a double value! Use this method for example to execute a SELECT MAX(...) ... statement.

Parameters:

connection - The database connection.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row.

Throws:

ClassCastException - When the read column is not a Number.

IllegalArgumentException - When the supplied sqlStatement is empty.

NoSingleRowResultSetException - When the supplied statement results in a result set without any records.
Note: This Exception is not thrown when the result set contains more than one row!

NullPointerException - When either the supplied dataSource or the supplied sqlStatement is null.

SQLException - When the statement could not be executed.

executeSingleResultQuery

public static Object executeSingleResultQuery(Connection connection,
                                              String sqlStatement,
                                              Object... parameters)
                                       throws SQLException

Executes a SELECT statement that will fetch the first column from the first row.

Parameters:

connection - The database connection.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row.

Throws:

NoSingleRowResultSetException - When the supplied statement results in a result set without any records.
Note: This Exception is not thrown when the result set contains more than one row!

SQLException - When the statement could not be executed.

executeSingleOptionalResultQuery

public static Object executeSingleOptionalResultQuery(DataSource dataSource,
                                                      String sqlStatement,
                                                      Object... parameters)
                                               throws SQLException

Executes a SELECT statement that will fetch the first column from the first row provided that the query results in the selection of a row.
To convert the returned object to another type, some casting is necessary. The following code for example converts the returned object to a primitive int.

 Number status = (Number)DatabaseType.executeSingleOptionalResultQuery(
     dataSource,
     "SELECT FIELD FROM TABLE_NAME WHERE ...");
 if (status != null) {
     int intStatus = status.intValue();
 }
 

Parameters:

dataSource - DataSource used to get a connection from.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row or null when the query resulted in the selection of zero rows.
Note: Null will also be returned when a row is fetched and the value of the first column is null.

Throws:

SQLException - When the statement could not be executed.
Note: No SQLException is thrown when the result set contains more than one row!

executeSingleOptionalResultQuery

public static Object executeSingleOptionalResultQuery(Connection connection,
                                                      String sqlStatement,
                                                      Object... parameters)
                                               throws SQLException

Executes a SELECT statement that will fetch the first column from the first row provided that the query results in the selection of a row.
To convert the returned object to another type, some casting is necessary. The following code for example converts the returned object to a primitive int.

 Number status = (Number)DatabaseType.executeSingleOptionalResultQuery(
     dataSource,
     "SELECT FIELD FROM TABLE_NAME WHERE ...");
 if (status != null) {
     int intStatus = status.intValue();
 }
 

Parameters:

connection - The database connection.

sqlStatement - SQL select statement.

parameters - The optional parameters to use in the select statement.

Returns:

The value of the first column of the first row or null when the query resulted in the selection of zero rows.
Note: Null will also be returned when a row is fetched and the value of the first column is null.

Throws:

SQLException - When the statement could not be executed.
Note: No SQLException is thrown when the result set contains more than one row!

getDatabaseTime

public static Timestamp getDatabaseTime(DataSource dataSource)
                                 throws SQLException

Gets the time from the database server.

Parameters:

dataSource - DataSource used to get a connection from.

Returns:

The time of the database server.

Throws:

NullPointerException - When the supplied dataSource is null.

SQLException - When the time could not be obtained from the database server (possibly due to the fact that no connection could be obtained).

getDatabaseTime

public static Timestamp getDatabaseTime(Connection connection)
                                 throws SQLException

Gets the time from the database server.

Parameters:

connection - The database connection.

Returns:

The time of the database server.

Throws:

NullPointerException - When the supplied dataSource is null.

SQLException - When the time could not be obtained from the database server (possibly due to the fact that the actual database could not be determined).

getActualDatabaseTime

protected abstract Timestamp getActualDatabaseTime(Connection connection)
                                            throws SQLException

Gets the time of the actual database.
Override this method in actual (concrete) instances of type Database.

Parameters:

connection - The database connection.

Returns:

The time of the actual database (server).

Throws:

SQLException - When the time could not be obtained from the database server.

getTimestampColumnName

protected abstract String getTimestampColumnName()

Gets the column name the database uses to get or insert a timestamp.

Returns:

The column name the database uses to get or insert a timestamp.

getTables

public static List<String> getTables(DataSource dataSource,
                                     String owner)
                              throws SQLException

Gets the names of all the database tables for the supplied owner.

Parameters:

dataSource - DataSource used to get a connection from.

owner - Owner of the database tables.

Returns:

The list of table names (ascending order).

Throws:

IllegalArgumentException - When the supplied owner is empty.

NullPointerException - When either the supplied dataSource or the supplied owner is null.

SQLException - When the list of table names could not be obtained from the database server (possibly due to the fact that no connection could be obtained).

getTables

public static List<String> getTables(Connection connection,
                                     String owner)
                              throws SQLException

Gets the names of all the database tables for the supplied owner.

Parameters:

connection - The database connection.

owner - Owner of the database tables.

Returns:

The list of table names (in ascending order).

Throws:

IllegalArgumentException - When the supplied owner is empty.

NullPointerException - When either the supplied connection or the supplied owner is null.

SQLException - When the list of table names could not be obtained from the database server (possibly due to the fact that no connection could be obtained).

getActualTables

protected abstract List<String> getActualTables(Connection connection,
                                                String owner)
                                         throws SQLException

Gets the database tables owned by the supplied owner.
Override this method in actual (concrete) instances of type Database.

Parameters:

connection - The database connection.

owner - Owner of the database tables.

Returns:

The list of table names (ordered ascending).

Throws:

SQLException - When the list could not be obtained from the database server.

getTableMetaData

public static Table getTableMetaData(DataSource dataSource,
                                     String owner,
                                     String tableName)
                              throws SQLException

Gets the meta data of the table identified by the supplied tableName.

Parameters:

dataSource - DataSource used to get a connection from.

owner - Owner of the table identified by the supplied tableName.

tableName - Name of the table to get the meta data for.

Returns:

The table's meta data.

Throws:

IllegalArgumentException - When either the supplied owner or the supplied tableName is empty.

NullPointerException - When either the supplied dataSource or the supplied owner or the supplied tableName is null.

SQLException - When the meta data could not be retrieved (possibly due to the fact that no connection could be obtained).

getTableMetaData

public static Table getTableMetaData(Connection connection,
                                     String owner,
                                     String tableName)
                              throws SQLException

Gets the meta data of the table identified by the supplied table.

Parameters:

connection - The database connection.

owner - Owner of the table identified by the supplied tableName.

tableName - Name of the table to get the meta data for.

Returns:

The table's meta data.

Throws:

IllegalArgumentException - When either the supplied owner or the supplied tableName is empty.

NullPointerException - When either the supplied connection or the supplied owner of the supplied tableName is null.

SQLException - When the meta data could not be retrieved (possibly due to the fact that no connection could be obtained).

getActualTableMetaData

protected abstract Table getActualTableMetaData(Connection connection,
                                                String owner,
                                                String tableName)
                                         throws SQLException

Gets the meta data of the table identified by the supplied tableName.
Override this method in actual (concrete) instances of type Database.

Parameters:

connection - The database connection.

owner - Owner of the table identified by the supplied tableName.

tableName - Name of the table to get the meta data for.

Returns:

The table's meta data.

Throws:

SQLException - When the meta data could not be retrieved (possibly due to the fact that no connection could be obtained).

NullPointerException - When either the supplied connection or the supplied owner or the supplied tableName is null.

IllegalArgumentException - When either the supplied owner or the supplied tableName is empty.

getTableColumns

protected List<Column> getTableColumns(Connection connection,
                                       String tableName)
                                throws SQLException

Gets the list of columns that are present in the table identified by the supplied tableName.

Parameters:

connection - The database connection.

tableName - Name of the table to get the columns for.

Returns:

List of columns where each element is of type Column.

Throws:

SQLException - When the list of columns could not be retrieved.

getConstraint

public static Constraint getConstraint(DataSource dataSource,
                                       String owner,
                                       String name)
                                throws SQLException

Gets the constraint owned by the supplied owner and with the supplied name, from the database.

Parameters:

dataSource - DataSource used to get a connection from.

owner - The owner of the constraint to get.

name - The name of the constraint to get.

Returns:

The constraint of the supplied owner and with the supplied name.

Throws:

SQLException - When the constraint could not be fetched from the database.

NullPointerException - When either the supplied dataSource, owner or name is null.

IllegalArgumentException - When either the supplied owner or name is empty.

getConstraint

public static Constraint getConstraint(Connection connection,
                                       String owner,
                                       String name)
                                throws SQLException

Gets the constraint owned by the supplied owner and with the supplied name, from the database.

Parameters:

connection - The database connection.

owner - The owner of the constraint to get.

name - The name of the constraint to get.

Returns:

The constraint of the supplied owner and with the supplied name.

Throws:

SQLException - When the constraint could not be fetched from the database.

NullPointerException - When either the supplied connection, owner or name is null.

IllegalArgumentException - When either the supplied owner or name is empty.

getActualConstraint

public abstract Constraint getActualConstraint(Connection connection,
                                               String owner,
                                               String name)
                                        throws SQLException

Gets the constraint owned by the supplied owner and with the supplied name, from the database.
Override this method in actual (concrete) instances of type Database.

Parameters:

connection - The database connection.

owner - The owner of the constraint to get.

name - The name of the constraint to get.

Returns:

The constraint of the supplied owner and with the supplied name.

Throws:

SQLException - When the constraint could not be fetched from the database.

NullPointerException - When either the supplied connection, owner or name is null.

IllegalArgumentException - When either the supplied owner or name is empty.

getConstraints

public static List<Constraint> getConstraints(DataSource dataSource,
                                              String owner,
                                              String tableName)
                                       throws SQLException

Gets all constraints on the supplied tableName, owned by the supplied owner.

Parameters:

dataSource - DataSource used to get a connection from.

owner - The owner of the constraints to get.

tableName - The name of the table.

Returns:

All constraints on the given tableName owned by the supplied owner.

Throws:

SQLException - When the constraints could not be fetched from the database.

NullPointerException - When either the supplied dataSource, owner or tableName is null.

IllegalArgumentException - When either the supplied owner or tableName is empty.

getConstraints

public static List<Constraint> getConstraints(Connection connection,
                                              String owner,
                                              String tableName)
                                       throws SQLException

Gets all constraints on the supplied tableName, owned by the supplied owner.

Parameters:

connection - The database connection.

owner - The owner of the constraints to get.

tableName - The name of the table.

Returns:

All constraints on the given tableName owned by the supplied owner.

Throws:

SQLException - When the constraints could not be fetched from the database.

NullPointerException - When either the supplied connection, owner or tableName is null.

IllegalArgumentException - When either the supplied owner or tableName is empty.

getActualConstraints

public abstract List<Constraint> getActualConstraints(Connection connection,
                                                      String owner,
                                                      String tableName)
                                               throws SQLException

Gets all constraints on the supplied tableName, owned by the supplied owner.
Override this method in actual (concrete) instances of type Database.

Parameters:

connection - The database connection.

owner - The owner of the constraints to get.

tableName - The name of the table.

Returns:

All constraints on the given tableName owned by the supplied owner.

Throws:

SQLException - When the constraints could not be fetched from the database.

NullPointerException - When either the supplied connection, owner or tableName is null.

IllegalArgumentException - When either the supplied owner or tableName is empty.