org.josef.jdbc

Class DerbyDatabase

java.lang.Object

org.josef.jdbc.Database

org.josef.jdbc.DerbyDatabase

public class DerbyDatabase
extends Database

Abstraction of a Derby database.
This class contains Derby specific code and SQL statements.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Field Summary

Fields inherited from class org.josef.jdbc.Database

PARAM_NAME_CONNECTION, PARAM_NAME_DATA_SOURCE, PARAM_NAME_NAME, PARAM_NAME_OWNER, PARAM_NAME_RESULT_SET_ROW_CALL_BACK, PARAM_NAME_SQL_STATEMENT, PARAM_NAME_TABLE_NAME

Method Summary

Modifier and Type	Method and Description
Constraint	getActualConstraint(Connection connection, String owner, String name) Gets the constraint owned by the supplied owner and with the supplied name, from the database.
List<Constraint>	getActualConstraints(Connection connection, String owner, String tableName) Gets all constraints on the supplied tableName, owned by the supplied owner.
Timestamp	getActualDatabaseTime(Connection connection) Gets the time of the actual database.
Table	getActualTableMetaData(Connection connection, String owner, String tableName) Gets the meta data of the table identified by the supplied tableName.
List<String>	getActualTables(Connection connection, String owner) Gets the database tables owned by the supplied owner.
static DerbyDatabase	getInstance() Gets the one and only Derby Database instance.
List<String>	getPrimaryKeyColumns(Connection connection, String owner, String tableName) Gets the primary key columns of the table identified by the supplied tableName.
String	getTimestampColumnName() Gets the column name the database uses to get or insert a timestamp.
String	toString() Creates a String representation of this database object.

Methods inherited from class org.josef.jdbc.Database

execute, execute, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQueryWithLargeResultSet, executeQueryWithLargeResultSet, executeSingleDoubleResultQuery, executeSingleDoubleResultQuery, executeSingleLongResultQuery, executeSingleLongResultQuery, executeSingleOptionalResultQuery, executeSingleOptionalResultQuery, executeSingleResultQuery, executeSingleRowResultQuery, executeSingleRowResultQuery, executeSingleRowResultQuery, executeSingleRowResultQuery, getActualDatabase, getConstraint, getConstraint, getConstraints, getConstraints, getDatabaseTime, getDatabaseTime, getTableColumns, getTableMetaData, getTableMetaData, getTables, getTables

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DerbyDatabase getInstance()

Gets the one and only Derby Database instance.

Returns:

The one and only Derby Database instance.

getActualDatabaseTime

public Timestamp getActualDatabaseTime(Connection connection)
                                throws SQLException

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

Specified by:

getActualDatabaseTime in class 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

public String getTimestampColumnName()

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

Specified by:

getTimestampColumnName in class Database

Returns:

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

getActualTables

public 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..

Specified by:

getActualTables in class 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.

getActualTableMetaData

public 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..

Specified by:

getActualTableMetaData in class 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).

getPrimaryKeyColumns

public List<String> getPrimaryKeyColumns(Connection connection,
                                         String owner,
                                         String tableName)
                                  throws SQLException

Gets the primary key columns of the table identified by the supplied tableName.

Parameters:

connection - The database connection.

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

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

Returns:

List of primary key columns.
This could possibly be an empty list when no primary key has been defined, but never null.

Throws:

SQLException - When the primary key columns could not be retrieved.

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

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

getActualConstraints

public 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..

Specified by:

getActualConstraints in class 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:

UnsupportedOperationException - Always.

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

getActualConstraint

public 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..

Specified by:

getActualConstraint in class 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:

UnsupportedOperationException - Always.

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

toString

public String toString()

Creates a String representation of this database object.

Overrides:

toString in class Object

Returns:

String representation of this database object.