gov.nih.nlm.nls.lexAccess.Db

Class DbBase

java.lang.Object

gov.nih.nlm.nls.lexAccess.Db.DbBase

public class DbBase
extends java.lang.Object

This class provides base interfaces to LexAccess database. This class utilizes Java Database Connectivity (JDBC) to connection to database (Instant DB or other DBs).

History:

• SCR-98, chlu,, 12-13-12, add option to access different releases
• SCR-101, chlu, 12-19-12, add lexicon version option

Version:

V-2013

Author:

NLM NLS Development Team

Constructor Summary

Constructors

Constructor and Description
DbBase()

Method Summary

Methods

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 inStr) Format a String to SQL standard format
static java.sql.Connection	OpenConnection(Configuration config) Open a connection using URL specified in configuration bundle
static java.sql.Connection	OpenConnection(Configuration config, java.lang.String dbVersion) 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
(package private) static void	SubmitDML(java.lang.String query, Configuration config) Submit a query to a specific database.
static java.lang.String	ToSqlStr(java.lang.String in) Convert a String to SQL standard format on escape characters

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 SQL error happens

OpenConnection

public static java.sql.Connection OpenConnection(Configuration config,
                                 java.lang.String dbVersion)

Open a connection using URL specified in configuration bundle

Parameters:

config - configuration bundle

dbVersion - db Version to override the param in config

Returns:

a connection (session) with the specific database

Throws:

java.sql.SQLException - if there is a SQL 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 SQL 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 SQL 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 SQL error happens

FormatSqlStr

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

Format a String to SQL standard format

Parameters:

inStr - input SQL query string

Returns:

formatted SQL query string

ToSqlStr

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

Convert a String to SQL standard format on escape characters

Parameters:

in - input SQL string

Returns:

converted SQL string

SubmitDML

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

Submit a query to a specific database.

Parameters:

query - a SQL query to be submitted

config - a configuration object