gov.nih.nlm.nls.lvg.Db

Class DbBase

java.lang.Object

gov.nih.nlm.nls.lvg.Db.DbBase

public class DbBase
extends java.lang.Object

This class provides base interfaces to LVG database. This class utilize Java DataBase Connectivity (JDBC) to connection to LVG database (Instant DB).

History:

Version:

V-2021

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
DbBase()

Method Summary

Modifier and Type	Method and Description
static void	CloseConnection(java.sql.Connection conn) Close a specified connection (session) with a database
static void	CloseConnection(java.sql.Connection conn, Configuration config) Close a specified connection (session) with a database
static java.lang.String	FormatSqlStr(java.lang.String in) Format a regular string to a legal SQL string for "'".
static java.sql.Connection	OpenConnection(Configuration config) Open a connection using URL specified in configuration bundle
static java.sql.Connection	OpenConnection(java.lang.String driverName, java.lang.String url, java.lang.String userName, java.lang.String password) Open a connection to a specified URL of the database and specifying a JDBC driver
static void	ShutdownDb(java.sql.Connection conn, Configuration config) Close a specified connection (session) with a database
(package private) static void	SubmitDMLs(java.lang.String query, Configuration config) Submit a query to a specific database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbBase

public DbBase()

Method Detail

OpenConnection

public static java.sql.Connection OpenConnection(Configuration config)
                                          throws java.sql.SQLException

Open a connection using URL specified in configuration bundle

Parameters:

config - configuration bundle

Returns:

a connection (session) with the specific database

Throws:

java.sql.SQLException - if there is a database error happens

OpenConnection

public static java.sql.Connection OpenConnection(java.lang.String driverName,
                                                 java.lang.String url,
                                                 java.lang.String userName,
                                                 java.lang.String password)
                                          throws java.sql.SQLException

Open a connection to a specified URL of the database and specifying a JDBC driver

Parameters:

driverName - JDBC connection driver

url - JDBC connection URL

userName - user name for the DB

password - password for the DB

Returns:

a connection (session) with the specific database

Throws:

java.sql.SQLException - if there is a database error happens

CloseConnection

public static void CloseConnection(java.sql.Connection conn)
                            throws java.sql.SQLException

Close a specified connection (session) with a database

Parameters:

conn - database connection

Throws:

java.sql.SQLException - if there is a database error happens

CloseConnection

public static void CloseConnection(java.sql.Connection conn,
                                   Configuration config)
                            throws java.sql.SQLException

Close a specified connection (session) with a database

Parameters:

conn - database connection

config - configuration bundle

Throws:

java.sql.SQLException - if there is a database error happens

ShutdownDb

public static void ShutdownDb(java.sql.Connection conn,
                              Configuration config)
                       throws java.sql.SQLException

Close a specified connection (session) with a database

Parameters:

conn - database connection

config - configuration bundle

Throws:

java.sql.SQLException - if there is a database error happens

FormatSqlStr

public static java.lang.String FormatSqlStr(java.lang.String in)

Format a regular string to a legal SQL string for "'".

Parameters:

in - a regualr string used as SQL

Returns:

a legal SQL string

SubmitDMLs

static void SubmitDMLs(java.lang.String query,
                       Configuration config)

Submit a query to a specific database.

Parameters:

query - a SQL query to be submitted

config - LVG configuration obj for DB connection