edu.iris.dmc.pdcc.util
Class PdccDbUtil

java.lang.Object
  edu.iris.dmc.pdcc.util.PdccDbUtil

public class PdccDbUtil

extends java.lang.Object

Generic utility methods for database access in PDCC.

Version:

6/2/2004

Author:

Robert Casey, IRIS DMC

Constructor Summary

PdccDbUtil()

Method Summary

static void	buildPdccDb(java.lang.String schemaFile, java.lang.String hostName, java.lang.String dbmsName, java.lang.String driverClass, java.lang.String dbName, java.lang.String userName, java.lang.String passWord) Synonym of buildPdccDb with deletePrevious flag turned off.
static void	buildPdccDb(java.lang.String schemaFile, java.lang.String hostName, java.lang.String dbmsName, java.lang.String driverClass, java.lang.String dbName, java.lang.String userName, java.lang.String passWord, boolean deletePrevious) Construct a PDCC database using the provided schema file and database access parameters.
static java.lang.String	getSchemaFile(java.lang.String configFile, java.lang.String sessionConfigName) Return the pathname of the schema file pertaining to the indicated pdcc session name in the named configFile.
static void	main(java.lang.String[] args) Invoke utility commands from the command line.
static java.sql.Connection	openDbConnection(java.lang.String configFile, java.lang.String dbConfigName) A synonym of openDbConnection that accepts a config file and database configuration name as parameters to open the database connection.
static java.sql.Connection	openDbConnection(java.lang.String hostName, java.lang.String dbmsName, java.lang.String driverClass, java.lang.String dbName, java.lang.String userName, java.lang.String passWord) Return an open database connection for use in queries and updates.
static java.sql.Connection	openDefaultDbConnection(java.lang.String configFile, java.lang.String sessionConfigName) Similar method to openDbConnection that accepts a config file and session configuration name as parameters to open a default database connection.
static void	rebuildPdccDb(java.lang.String schemaFile, java.lang.String hostName, java.lang.String dbmsName, java.lang.String driverClass, java.lang.String dbName, java.lang.String userName, java.lang.String passWord) Synonym of buildPdccDb with deletePrevious flag turned on.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdccDbUtil

public PdccDbUtil()

Method Detail

buildPdccDb

public static void buildPdccDb(java.lang.String schemaFile,
                               java.lang.String hostName,
                               java.lang.String dbmsName,
                               java.lang.String driverClass,
                               java.lang.String dbName,
                               java.lang.String userName,
                               java.lang.String passWord,
                               boolean deletePrevious)

Construct a PDCC database using the provided schema file and database access parameters. Delete previous tables in database if deletePrevious is set to true.

buildPdccDb

public static void buildPdccDb(java.lang.String schemaFile,
                               java.lang.String hostName,
                               java.lang.String dbmsName,
                               java.lang.String driverClass,
                               java.lang.String dbName,
                               java.lang.String userName,
                               java.lang.String passWord)

Synonym of buildPdccDb with deletePrevious flag turned off.

rebuildPdccDb

public static void rebuildPdccDb(java.lang.String schemaFile,
                                 java.lang.String hostName,
                                 java.lang.String dbmsName,
                                 java.lang.String driverClass,
                                 java.lang.String dbName,
                                 java.lang.String userName,
                                 java.lang.String passWord)

Synonym of buildPdccDb with deletePrevious flag turned on. Use with care! This method will delete all previously constructed table, removing all data in this database. Applications should present verification to the user that they wish to undertake such table deletion.

openDbConnection

public static java.sql.Connection openDbConnection(java.lang.String hostName,
                                                   java.lang.String dbmsName,
                                                   java.lang.String driverClass,
                                                   java.lang.String dbName,
                                                   java.lang.String userName,
                                                   java.lang.String passWord)
                                            throws PdccDbException

Return an open database connection for use in queries and updates. This is the public interface for use by applications. Return a null value on failure.

Throws:

PdccDbException

openDbConnection

public static java.sql.Connection openDbConnection(java.lang.String configFile,
                                                   java.lang.String dbConfigName)
                                            throws PdccDbException

A synonym of openDbConnection that accepts a config file and database configuration name as parameters to open the database connection. Returns a null value on failure.

Throws:

PdccDbException

openDefaultDbConnection

public static java.sql.Connection openDefaultDbConnection(java.lang.String configFile,
                                                          java.lang.String sessionConfigName)
                                                   throws PdccDbException

Similar method to openDbConnection that accepts a config file and session configuration name as parameters to open a default database connection. This is intended for opening a default database, which is the first database configuration name listed under the provided session config name. Returns a null value on failure.

Throws:

PdccDbException

getSchemaFile

public static java.lang.String getSchemaFile(java.lang.String configFile,
                                             java.lang.String sessionConfigName)
                                      throws PdccDbException

Return the pathname of the schema file pertaining to the indicated pdcc session name in the named configFile.

Throws:

PdccDbException

main

public static void main(java.lang.String[] args)

Invoke utility commands from the command line.