xal.tools.database

Class DatabaseAdaptor

java.lang.Object

xal.tools.database.DatabaseAdaptor

Direct Known Subclasses:

OracleDatabaseAdaptor

public abstract class DatabaseAdaptor
extends java.lang.Object

DatabaseAdaptor provides a generic adaptor to wrap database specific code. For example, making a SQL array requires database specific code.

Constructor Summary

Constructors

Constructor and Description
DatabaseAdaptor()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	fetchAllSchemas(java.sql.Connection connection) Fetch all schemas from the connected database
java.util.List<java.lang.String>	fetchNontrivialSchemas(java.sql.Connection connection) Fetch the list of nontrivial schemas.
java.util.List<java.lang.String>	fetchPrimaryKeys(java.sql.Connection connection, java.lang.String schema, java.lang.String table) Fetch the primary keys for a specified table in a specified schema
java.util.List<java.lang.String>	fetchTables(java.sql.Connection connection, java.lang.String schema) Fetch tables for the specified schema
abstract java.sql.Array	getArray(java.lang.String type, java.sql.Connection connection, java.lang.Object array) Get an SQL Array given an SQL array type, connection and a primitive array
java.sql.ResultSet	getColumnsResultSet(java.sql.DatabaseMetaData metaData, java.lang.String schema, java.lang.String table) Get the result set of columns for the specified meta data, schema and table
java.sql.Connection	getConnection(ConnectionDictionary dictionary) Get a new database connection
java.sql.Connection	getConnection(java.lang.String urlSpec, java.lang.String user, java.lang.String password) Get a new database connection
static DatabaseAdaptor	getInstance() Get a new database adaptor using the default database adaptor.
java.sql.ResultSet	getPrimaryKeysResultSet(java.sql.DatabaseMetaData metaData, java.lang.String schema, java.lang.String table) Get the result set of primary keys for the specified meta data, schema and table
java.sql.ResultSet	getTablesResultSet(java.sql.DatabaseMetaData metaData, java.lang.String schema) Get the result set of tables for the specified meta data and schema
java.sql.Blob	newBlob(java.sql.Connection connection) Instantiate an empty Blob.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseAdaptor

public DatabaseAdaptor()

Method Detail

newBlob

public java.sql.Blob newBlob(java.sql.Connection connection)

Instantiate an empty Blob.

Parameters:

connection - the database connection

Returns:

a new instance of a Blob appropriate for this adaptor.

getArray

public abstract java.sql.Array getArray(java.lang.String type,
                                        java.sql.Connection connection,
                                        java.lang.Object array)
                                 throws DatabaseException

Get an SQL Array given an SQL array type, connection and a primitive array

Parameters:

type - An SQL array type identifying the type of array

connection - An SQL connection

array - The primitive Java array

Returns:

the SQL array which wraps the primitive array

Throws:

DatabaseException - if a database exception is thrown

getConnection

public java.sql.Connection getConnection(java.lang.String urlSpec,
                                         java.lang.String user,
                                         java.lang.String password)
                                  throws DatabaseException

Get a new database connection

Parameters:

urlSpec - The URL to which to connect

user - The user loggin into the database

password - the user's password

Throws:

DatabaseException - if a database exception is thrown

getConnection

public java.sql.Connection getConnection(ConnectionDictionary dictionary)
                                  throws DatabaseException

Get a new database connection

Parameters:

dictionary - A connection dictionary

Throws:

DatabaseException - if a database exception is thrown

getInstance

public static DatabaseAdaptor getInstance()

Get a new database adaptor using the default database adaptor. Site specific code should provide an implementation of this method using the site specific database drivers.

Returns:

return a new instance of the default database adaptor (OracleDatabaseAdaptor)

fetchAllSchemas

public java.util.List<java.lang.String> fetchAllSchemas(java.sql.Connection connection)
                                                 throws DatabaseException

Fetch all schemas from the connected database

Returns:

list of all schemas in the database

Throws:

DatabaseException

gov.sns.tools.database.DatabaseException - if the schema fetch fails

fetchNontrivialSchemas

public java.util.List<java.lang.String> fetchNontrivialSchemas(java.sql.Connection connection)
                                                        throws DatabaseException

Fetch the list of nontrivial schemas. By default, fetch all schemas. Driver specific subclasses should provide a more accurate implementation.

Parameters:

connection - database connection

Returns:

list of nontrivial schema names

Throws:

DatabaseException

fetchTables

public java.util.List<java.lang.String> fetchTables(java.sql.Connection connection,
                                                    java.lang.String schema)
                                             throws DatabaseException

Fetch tables for the specified schema

Parameters:

connection - The database connection

schema - The schema for which to fetch the tables

Returns:

a list of tables associated with the specified schema

Throws:

DatabaseException

DatabaseException - if the schema fetch fails

getTablesResultSet

public java.sql.ResultSet getTablesResultSet(java.sql.DatabaseMetaData metaData,
                                             java.lang.String schema)
                                      throws java.sql.SQLException

Get the result set of tables for the specified meta data and schema

Throws:

java.sql.SQLException

getColumnsResultSet

public java.sql.ResultSet getColumnsResultSet(java.sql.DatabaseMetaData metaData,
                                              java.lang.String schema,
                                              java.lang.String table)
                                       throws java.sql.SQLException

Get the result set of columns for the specified meta data, schema and table

Throws:

java.sql.SQLException

fetchPrimaryKeys

public java.util.List<java.lang.String> fetchPrimaryKeys(java.sql.Connection connection,
                                                         java.lang.String schema,
                                                         java.lang.String table)
                                                  throws DatabaseException

Fetch the primary keys for a specified table in a specified schema

Parameters:

connection - The database connection

schema - The schema to use

table - The table for which to fetch the primary keys

Returns:

a list of the primary keys as column names

Throws:

DatabaseException - Description of the Exception

getPrimaryKeysResultSet

public java.sql.ResultSet getPrimaryKeysResultSet(java.sql.DatabaseMetaData metaData,
                                                  java.lang.String schema,
                                                  java.lang.String table)
                                           throws java.sql.SQLException

Get the result set of primary keys for the specified meta data, schema and table

Throws:

java.sql.SQLException