com.middlemindgames.tdb

Interface DataAccessTemplate

All Known Implementing Classes:

DataAccess

public interface DataAccessTemplate

Abstract dataAccess class, base template for SQL database access. Created on 07/07/2015 Abstract implementation of the dataAccess class. Used to separate support for multiple JDBC database drivers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataAccessTemplate.DatabaseType Lists the supported database types.

Method Summary

Modifier and Type	Method and Description
void	closeObjects(java.sql.Statement query, java.sql.ResultSet data) Clean up DB objects.
boolean	connect() Connects to the data connection information provided.
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 ResultSet 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) Runs an SQL 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) Standard connection initialization method.
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.

Method Detail

closeObjects

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

Clean up DB objects. Static Method.

Parameters:

query - Statement object to close.

data - ResultSet object to close.

setConnInfo

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

Standard connection initialization method.

Parameters:

uname - Database username.

pword - Database password.

prt - Database port.

SID - Database SID on Oracle connections, SCHEMA for MYSQL connections, INSTANCE for MSSQL connections.

svr - The target server hosting the database.

connect

boolean connect()

Connects to the data connection information provided. Uses the information provided in setConnInfo to connect to the target database.

Returns:

Returns true of the connection was successful, false if not.

See Also:

setConnInfo

getConnection

java.sql.Connection getConnection()

Returns a reference to the connection object.

Returns:

Returns a reference to the connection object.

See Also:

connect

getData

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

Runs an SQL query.

Parameters:

sql - Oracle query text.

Returns:

Result set returned from SQL query.

See Also:

connect

executeSelect

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

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

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

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

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

Parameters:

sql - A valid SQL select statement to execute.

Returns:

A JDBC Statement object.

Throws:

java.lang.Exception - Throws a generic exception.

See Also:

ResultSet

executeNonSelect

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

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

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.

executeNonSelectRowChange

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

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

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.

getSqlEscapeChar

java.lang.String getSqlEscapeChar()

SQL escape character getter.

Returns:

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

setSqlEscapeChar

void setSqlEscapeChar(java.lang.String s)

SQL escape character setter.

Parameters:

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

getUsername

java.lang.String getUsername()

Username getter.

Returns:

The database connection username.

SetUsername

void SetUsername(java.lang.String s)

Username setter.

Parameters:

s - The database connection username.

getPassword

java.lang.String getPassword()

Password getter.

Returns:

The database connection password.

SetPassword

void SetPassword(java.lang.String s)

Password setter.

Parameters:

s - The database connection password.

getPort

java.lang.String getPort()

Port number getter.

Returns:

The database port number.

SetPort

void SetPort(java.lang.String s)

Port number setter.

Parameters:

s - The database port number.

getServer

java.lang.String getServer()

Server name getter.

Returns:

The host name of the database server.

setServer

void setServer(java.lang.String s)

Server name setter.

Parameters:

s - The database server.

getSid

java.lang.String getSid()

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

Returns:

The sid value for this database.

setSid

void setSid(java.lang.String s)

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

Parameters:

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

getType

DataAccessTemplate.DatabaseType getType()

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

Returns:

An enumeration value representing the current database types.

setType

void setType(DataAccessTemplate.DatabaseType t)

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

Parameters:

t - A valid database type entry.

getAutoCommit

boolean getAutoCommit()

Auto commit getter.

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

void setAutoCommit(boolean b)

Auto commit setter.

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.