com.middlemindgames.tdb

Class DataAccess

java.lang.Object

com.middlemindgames.tdb.DataAccess

All Implemented Interfaces:

DataAccessTemplate

public class DataAccess
extends java.lang.Object
implements DataAccessTemplate

DataAccess implementation class supporting Oracle databases. Default database will be ORACLE 10G EX, along with the ORACLE escape character ".

See Also:

DataAccessTemplate

Nested Class Summary

Nested classes/interfaces inherited from interface com.middlemindgames.tdb.DataAccessTemplate

DataAccessTemplate.DatabaseType

Constructor Summary

Constructors

Constructor and Description
DataAccess() Create new instance of the dataAccess class.
DataAccess(DataAccessTemplate.DatabaseType Type, java.lang.String EscapeChar, boolean AutoCommit) Create new instance of the dataAccess class.

Method Summary

Modifier and Type	Method and Description
static void	closeDbObjects(java.sql.Statement query, java.sql.ResultSet data) Clean up DB objects using a static method.
void	closeObjects(java.sql.Statement query, java.sql.ResultSet data) Clean up database objects.
boolean	connect() Connect to Oracle DB using credentials from configuration file.
java.sql.Statement	executeNonSelect(java.lang.String sql) Executes an SQL non-select query and returns the record change count.
int	executeNonSelectRowChange(java.lang.String sql) Executes an SQL non-select query and returns the record change count.
java.sql.Statement	executeSelect(java.lang.String sql) Executes an SQL select query and returns the Statement object with data.
java.sql.ResultSet	executeSelectResultSet(java.lang.String sql) Executes an SQL select query and returns the Statement object with data.
boolean	getAutoCommit() Auto commit getter.
java.sql.Connection	getConnection() Returns a reference to the connection object.
java.sql.Statement	getData(java.lang.String sql) Run an Oracle query.
java.lang.String	getPassword() Password getter.
java.lang.String	getPort() Port number getter.
java.lang.String	getServer() Server name getter.
java.lang.String	getSid() The SID for Oracle 10G databases, the schema for Mysql databases.
java.lang.String	getSqlEscapeChar() SQL escape character getter.
DataAccessTemplate.DatabaseType	getType() Database type getter.
java.lang.String	getUsername() Username getter.
void	setAutoCommit(boolean b) Auto commit setter.
void	setConnInfo(java.lang.String uname, java.lang.String pword, java.lang.String prt, java.lang.String SID, java.lang.String svr) Populate fields for database credentials.
void	SetPassword(java.lang.String s) Password setter.
void	SetPort(java.lang.String s) Port number setter.
void	setServer(java.lang.String s) Server name setter.
void	setSid(java.lang.String s) The SID for Oracle 10G databases, the schema name for Mysql databases.
void	setSqlEscapeChar(java.lang.String s) SQL escape character setter.
void	setType(DataAccessTemplate.DatabaseType t) Database type setter.
void	SetUsername(java.lang.String s) Username setter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAccess

public DataAccess(DataAccessTemplate.DatabaseType Type,
                  java.lang.String EscapeChar,
                  boolean AutoCommit)

Create new instance of the dataAccess class. Check if the required JDBC driver name space is available. Loads the driver based on the type provided.

Parameters:

Type - The database type to use, alters connection strings etc.

EscapeChar - The escape character to use for wrapping column and table names, used throughout the application.

AutoCommit - If true the JDBC commit call will be exempted, otherwise commit is called after each SQL query execution.

DataAccess

public DataAccess()

Create new instance of the dataAccess class. Check if the required JDBC driver name space is available. Loads the driver based on the default type of ORACLE, assumes default ORACLE escape character.

Method Detail

getSqlEscapeChar

public java.lang.String getSqlEscapeChar()

SQL escape character getter.

Specified by:

getSqlEscapeChar in interface DataAccessTemplate

Returns:

Returns the specified SQL escape character string for used in building SQL queries.

setSqlEscapeChar

public void setSqlEscapeChar(java.lang.String s)

SQL escape character setter.

Specified by:

setSqlEscapeChar in interface DataAccessTemplate

Parameters:

s - The SQL escape character that should be used with the current database.

getUsername

public java.lang.String getUsername()

Username getter.

Specified by:

getUsername in interface DataAccessTemplate

Returns:

The database connection username.

SetUsername

public void SetUsername(java.lang.String s)

Username setter.

Specified by:

SetUsername in interface DataAccessTemplate

Parameters:

s - The database connection username.

getPassword

public java.lang.String getPassword()

Password getter.

Specified by:

getPassword in interface DataAccessTemplate

Returns:

The database connection password.

SetPassword

public void SetPassword(java.lang.String s)

Password setter.

Specified by:

SetPassword in interface DataAccessTemplate

Parameters:

s - The database connection password.

getPort

public java.lang.String getPort()

Port number getter.

Specified by:

getPort in interface DataAccessTemplate

Returns:

The database port number.

SetPort

public void SetPort(java.lang.String s)

Port number setter.

Specified by:

SetPort in interface DataAccessTemplate

Parameters:

s - The database port number.

getServer

public java.lang.String getServer()

Server name getter.

Specified by:

getServer in interface DataAccessTemplate

Returns:

The hostname of the database server.

setServer

public void setServer(java.lang.String s)

Server name setter.

Specified by:

setServer in interface DataAccessTemplate

Parameters:

s - The database server.

getSid

public java.lang.String getSid()

The SID for Oracle 10G databases, the schema for Mysql databases. Sid getter.

Specified by:

getSid in interface DataAccessTemplate

Returns:

The sid value for this database.

setSid

public void setSid(java.lang.String s)

The SID for Oracle 10G databases, the schema name for Mysql databases. Sid setter.

Specified by:

setSid in interface DataAccessTemplate

Parameters:

s - The SID for Oracle databases, the schema name for Mysql databases.

getType

public DataAccessTemplate.DatabaseType getType()

Database type getter. Supported types are "ORACLE_10G_EX" and "MYSQL_5_5".

Specified by:

getType in interface DataAccessTemplate

Returns:

An enumeration value representing the current database types.

setType

public void setType(DataAccessTemplate.DatabaseType t)

Database type setter. Supported types are "ORACLE_10G_EX" and "MYSQL_5_5".

Specified by:

setType in interface DataAccessTemplate

Parameters:

t - A valid database type entry.

getAutoCommit

public boolean getAutoCommit()

Auto commit getter.

Specified by:

getAutoCommit in interface DataAccessTemplate

Returns:

If auto commit is false commits have to be done manually by the dataAccess implementation. If auto commit is true the database is automatically committing queries.

setAutoCommit

public void setAutoCommit(boolean b)

Auto commit setter.

Specified by:

setAutoCommit in interface DataAccessTemplate

Parameters:

b - If auto commit is false commits have to be done manually by the dataAccess implementation. If auto commit is true the database is automatically committing queries.

closeDbObjects

public static void closeDbObjects(java.sql.Statement query,
                                  java.sql.ResultSet data)

Clean up DB objects using a static method.

Parameters:

query - Statement object to close.

data - ResultSet object to close.

See Also:

closeObjects

closeObjects

public void closeObjects(java.sql.Statement query,
                         java.sql.ResultSet data)

Clean up database objects.

Specified by:

closeObjects in interface DataAccessTemplate

Parameters:

query - Statement object to close.

data - ResultSet object to close.

See Also:

closeDbObjects

setConnInfo

public void setConnInfo(java.lang.String uname,
                        java.lang.String pword,
                        java.lang.String prt,
                        java.lang.String SID,
                        java.lang.String svr)

Populate fields for database credentials.

Specified by:

setConnInfo in interface DataAccessTemplate

Parameters:

uname - Username.

pword - Password.

prt - Server Port.

SID - SID.

svr - Server Name.

connect

public boolean connect()

Connect to Oracle DB using credentials from configuration file. Connection is object field 'conn'.

Specified by:

connect in interface DataAccessTemplate

Returns:

Returns true if connection was successful, false if not.

See Also:

setConnInfo

getConnection

public java.sql.Connection getConnection()

Returns a reference to the connection object.

Specified by:

getConnection in interface DataAccessTemplate

Returns:

Returns a reference to the connection object.

See Also:

connect

getData

public java.sql.Statement getData(java.lang.String sql)

Run an Oracle query.

Specified by:

getData in interface DataAccessTemplate

Parameters:

sql - Oracle query text.

Returns:

Result set returned from Oracle query.

See Also:

connect

executeSelect

public java.sql.Statement executeSelect(java.lang.String sql)
                                 throws java.lang.Exception

Executes an SQL select query and returns the Statement object with data.

Specified by:

executeSelect in interface DataAccessTemplate

Parameters:

sql - A valid SQL select statement to execute.

Returns:

A JDBC Statement object.

Throws:

java.lang.Exception - Throws a generic exception.

See Also:

Statement

executeSelectResultSet

public java.sql.ResultSet executeSelectResultSet(java.lang.String sql)
                                          throws java.lang.Exception

Executes an SQL select query and returns the Statement object with data.

Specified by:

executeSelectResultSet in interface DataAccessTemplate

Parameters:

sql - A valid SQL select statement to execute.

Returns:

A JDBC ResultSet object.

Throws:

java.lang.Exception - Throws a generic exception.

See Also:

ResultSet

executeNonSelect

public java.sql.Statement executeNonSelect(java.lang.String sql)
                                    throws java.lang.Exception

Executes an SQL non-select query and returns the record change count.

Specified by:

executeNonSelect in interface DataAccessTemplate

Parameters:

sql - A valid SQL select statement to execute.

Returns:

A Statement representing the executed SQL query.

Throws:

java.lang.Exception - Throws a generic exception.

See Also:

Statement

executeNonSelectRowChange

public int executeNonSelectRowChange(java.lang.String sql)
                              throws java.lang.Exception

Executes an SQL non-select query and returns the record change count.

Specified by:

executeNonSelectRowChange in interface DataAccessTemplate

Parameters:

sql - A valid SQL select statement to execute.

Returns:

An integer representing the number of records altered by the non-select query.

Throws:

java.lang.Exception - Throws a generic exception.