quadbase.common.util.internal
Class DBInfoBasic

java.lang.Object
  |
  +--quadbase.common.util.internal.DBInfoBasic

All Implemented Interfaces:

IDatabaseInfo, IJNDIDatabaseInfo

Direct Known Subclasses:

DBInfo, DBInfo, DBInfo

public class DBInfoBasic

extends java.lang.Object

implements IDatabaseInfo, IJNDIDatabaseInfo

DBInfoBasic

This class provides an implementation for the quadbase.util.IDatabaseInfo interface. It stores information necessary to retrieve data from a database.

See Also:

IDatabaseInfo

Field Summary

protected java.sql.Connection	connection
protected boolean	doNotCloseConnection
protected java.lang.String	driver
protected java.util.Hashtable	env
protected java.util.Properties	info normally at least a "user" and "password" property should be included
protected java.lang.String	JNDIName
protected java.lang.String	query
protected java.lang.String	url
protected boolean	useJNDIDataSource
static java.lang.String	XMLTAG

Constructor Summary

DBInfoBasic(java.sql.Connection conn, java.lang.String query)
Create a new instance of DBInfoBasic using the given Connection object

DBInfoBasic(java.sql.Connection conn, java.lang.String query, java.applet.Applet applet)
Deprecated.

DBInfoBasic(DBInfoBasic dbInfo)

DBInfoBasic(IDatabaseInfo dbInfo)
Create a new instance of DBInfo

DBInfoBasic(IJNDIDatabaseInfo dbInfo)

DBInfoBasic(java.lang.String JNDIName, java.lang.String query, java.util.Hashtable env)
Create a new instance of DBInfoBasic

DBInfoBasic(java.lang.String url, java.lang.String driver, java.lang.String username, java.lang.String password, java.lang.String query)
Create a new instance of DBInfoBasic

DBInfoBasic(java.lang.String url, java.lang.String driver, java.lang.String username, java.lang.String password, java.lang.String query, java.applet.Applet applet)
Deprecated.

Method Summary

java.lang.Object	clone()
void	closeConnection() This function closes the connection to the database
boolean	equals(DBInfoBasic dbInfo)
boolean	equals(DBInfoBasic dbInfo, boolean checkQuery)
boolean	equalsIgnoreQuery(DBInfoBasic dbInfo)
boolean	establishConnection() This function establishes a connection to the database specified by the url string
java.sql.Connection	getConnection() Gets the connection object, if one exists
java.lang.String	getContextFactory()
java.lang.String	getDriverName() Gets the JDBC driver name
java.util.Hashtable	getEnvProperties() Gets environment properties of the initial context
java.lang.String	getJNDIName() Gets the JNDI datasource lookup name
java.lang.String	getPassword() Gets the password
java.lang.String	getProviderURL()
java.lang.String	getQuery() Get the SQL query
java.lang.String	getURLString() Gets the URL of database
java.lang.String	getUserID() Get the user name
boolean	isCloseConnectionEnabled()
boolean	isUseJNDIDataSource()
java.sql.Connection	openConnection() Gets the connection object to the database
static DBInfoBasic	read(java.io.DataInput din, int version)
static DBInfoBasic	readXML(org.w3c.dom.Node dnode, int version)
void	setConnection(java.sql.Connection conn) This function sets the connection field in this object.
void	setDriverName(java.lang.String driver) Sets the JDBC driver name
void	setEnvProperties(java.util.Hashtable env) set env properties
void	setJNDIName(java.lang.String JNDIName) set JNDI look up name
void	setPassword(java.lang.String password) Set the password
void	setQuery(java.lang.String query) Set the SQL query
void	setURLString(java.lang.String url) Sets the URL of database
void	setUseJNDIDataSource(boolean useJNDIDataSource) set if use JNDI data source
void	setUserID(java.lang.String username) Sets the user name
java.lang.String	toString()
void	write(java.io.DataOutput dout)
void	writeXML(java.io.OutputStream dout)

Methods inherited from class java.lang.Object

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

Field Detail

url

protected java.lang.String url

driver

protected java.lang.String driver

query

protected java.lang.String query

connection

protected java.sql.Connection connection

doNotCloseConnection

protected boolean doNotCloseConnection

XMLTAG

public static final java.lang.String XMLTAG

info

protected java.util.Properties info

normally at least a "user" and "password" property should be included

See Also:

java.sql.DriverManager

useJNDIDataSource

protected boolean useJNDIDataSource

JNDIName

protected java.lang.String JNDIName

env

protected java.util.Hashtable env

Constructor Detail

DBInfoBasic

public DBInfoBasic(java.lang.String url,
                   java.lang.String driver,
                   java.lang.String username,
                   java.lang.String password,
                   java.lang.String query)

Create a new instance of DBInfoBasic

Parameters:

url - URL of database in form of jdbc:databaseName://machineName(or IPaddress)/schemeName

driver - JDBC driver class name use

username - login user name

password - login password

query - SQL query to retrieve data from database

DBInfoBasic

public DBInfoBasic(java.lang.String url,
                   java.lang.String driver,
                   java.lang.String username,
                   java.lang.String password,
                   java.lang.String query,
                   java.applet.Applet applet)

Deprecated.

Create a new instance of DBInfoBasic

Parameters:

url - URL of database in form of jdbc:databaseName://machineName(or IPaddress)/schemeName

driver - JDBC driver class name use

username - login user name

password - login password

query - SQL query to retrieve data from database

applet - an applet or null if the program is an application

DBInfoBasic

public DBInfoBasic(java.lang.String JNDIName,
                   java.lang.String query,
                   java.util.Hashtable env)

Create a new instance of DBInfoBasic

Parameters:

JNDIName - look up for the data source

query - SQL query to retrieve data from database

env - evironment properties for initial context

DBInfoBasic

public DBInfoBasic(IJNDIDatabaseInfo dbInfo)

DBInfoBasic

public DBInfoBasic(DBInfoBasic dbInfo)

DBInfoBasic

public DBInfoBasic(IDatabaseInfo dbInfo)

Create a new instance of DBInfo

Parameters:

dbInfo - Another DBInfoURL of database in form of

DBInfoBasic

public DBInfoBasic(java.sql.Connection conn,
                   java.lang.String query,
                   java.applet.Applet applet)

Deprecated.

Create a new instance of DBInfoBasic using the given Connection object

Parameters:

conn - a connection to the database

query - SQL query to retrieve data from database

applet - the parent applet

DBInfoBasic

public DBInfoBasic(java.sql.Connection conn,
                   java.lang.String query)

Create a new instance of DBInfoBasic using the given Connection object

Parameters:

conn - a connection to the database

query - SQL query to retrieve data from database

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getURLString

public java.lang.String getURLString()

Gets the URL of database

Specified by:

getURLString in interface IDatabaseInfo

getDriverName

public java.lang.String getDriverName()

Gets the JDBC driver name

Specified by:

getDriverName in interface IDatabaseInfo

getUserID

public java.lang.String getUserID()

Get the user name

Specified by:

getUserID in interface IDatabaseInfo

getPassword

public java.lang.String getPassword()

Gets the password

Specified by:

getPassword in interface IDatabaseInfo

getConnection

public java.sql.Connection getConnection()

Description copied from interface: IDatabaseInfo

Gets the connection object, if one exists

Specified by:

getConnection in interface IDatabaseInfo

getQuery

public java.lang.String getQuery()

Get the SQL query

Specified by:

getQuery in interface IDatabaseInfo

getJNDIName

public java.lang.String getJNDIName()

Description copied from interface: IJNDIDatabaseInfo

Gets the JNDI datasource lookup name

Specified by:

getJNDIName in interface IJNDIDatabaseInfo

isUseJNDIDataSource

public boolean isUseJNDIDataSource()

getEnvProperties

public java.util.Hashtable getEnvProperties()

Description copied from interface: IJNDIDatabaseInfo

Gets environment properties of the initial context

Specified by:

getEnvProperties in interface IJNDIDatabaseInfo

getContextFactory

public java.lang.String getContextFactory()

getProviderURL

public java.lang.String getProviderURL()

setURLString

public void setURLString(java.lang.String url)

Sets the URL of database

setDriverName

public void setDriverName(java.lang.String driver)

Sets the JDBC driver name

setUserID

public void setUserID(java.lang.String username)

Sets the user name

setPassword

public void setPassword(java.lang.String password)

Set the password

setQuery

public void setQuery(java.lang.String query)

Set the SQL query

setJNDIName

public void setJNDIName(java.lang.String JNDIName)

set JNDI look up name

setEnvProperties

public void setEnvProperties(java.util.Hashtable env)

set env properties

setUseJNDIDataSource

public void setUseJNDIDataSource(boolean useJNDIDataSource)

set if use JNDI data source

setConnection

public void setConnection(java.sql.Connection conn)

This function sets the connection field in this object.

Parameters:

connection - A reference to the Connection object.

openConnection

public java.sql.Connection openConnection()
                                   throws java.lang.Exception

Description copied from interface: IJNDIDatabaseInfo

Gets the connection object to the database

Specified by:

openConnection in interface IJNDIDatabaseInfo

establishConnection

public boolean establishConnection()
                            throws java.sql.SQLException

This function establishes a connection to the database specified by the url string

Returns:

true is connection is established, false otherwise

closeConnection

public void closeConnection()

This function closes the connection to the database

isCloseConnectionEnabled

public boolean isCloseConnectionEnabled()

write

public void write(java.io.DataOutput dout)
           throws java.io.IOException

read

public static DBInfoBasic read(java.io.DataInput din,
                               int version)
                        throws java.io.IOException

writeXML

public void writeXML(java.io.OutputStream dout)
              throws java.io.IOException

readXML

public static DBInfoBasic readXML(org.w3c.dom.Node dnode,
                                  int version)
                           throws java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(DBInfoBasic dbInfo)

equalsIgnoreQuery

public boolean equalsIgnoreQuery(DBInfoBasic dbInfo)

equals

public boolean equals(DBInfoBasic dbInfo,
                      boolean checkQuery)