com.planet_ink.coffee_mud.core.database
Class DBConnection

java.lang.Object
  com.planet_ink.coffee_mud.core.database.DBConnection

public class DBConnection
extends java.lang.Object

Nested Class Summary

static class

DBConnection.FetchType

Field Summary

protected int	failuresInARow number of failures in a row
protected boolean	inUse Whether this dbconnection is being used
protected boolean	isReusable
protected java.lang.String	lastError if any SQL errors occur, they are here.
protected java.lang.String	lastSQL for tracking the last sql statement made
protected boolean	sqlserver

Constructor Summary

DBConnection(DBConnections parent, java.lang.String DBClass, java.lang.String DBService, java.lang.String DBUser, java.lang.String DBPass, boolean DBReuse)
construction

Usage: DBConnection("","","");

Method Summary

java.lang.String	catalog()
void	clearFailures() known errors should not be a reason to report a dead state Usage: clearFailures();
void	close() shut down this connection totally Usage: close()
protected void	closeStatements(java.lang.String Closer)
protected void	doneUsing(java.lang.String Closer) report this connection as being free Usage: doneUsing("roll back");
java.lang.String	getLastError() returns an error if there was one Usage: getLastError();
java.sql.PreparedStatement	getPreparedStatement() returns the prepared statement, if creates Usage: getPreparedStatement();
boolean	inSQLServerCommunication()
boolean	inUse() returns whether this connection is in use Usage: inUse();
boolean	isFakeDB()
boolean	isProbablyDead() returns whether this connection is *probably* dead Usage: isProbablyDead();
boolean	isProbablyLockedUp() returns whether this connection is *probably* locked up Usage: isProbablyLockedUp();
java.sql.ResultSet	query(java.lang.String queryString) execute a query, returning the resultset Usage: R=query("SELECT STATEMENT");
boolean	ready() returns whether this connection is ready for use Usage: ready();
boolean	rePrepare(java.lang.String SQL) set up this connection for use as a prepared statement Requires an already in use connection.
void	setPreparedClobs(java.lang.String[] vals)
int	update(java.lang.String updateString, int retryNum) execute an sql update, returning the status Usage: update("UPDATE STATEMENT");
boolean	use(java.lang.String openerSQL) set up this connection for use Usage: use("begin transaction")
boolean	useEmpty() set up this connection for use Usage: useEmpty()
boolean	usePrepared(java.lang.String SQL) set up this connection for use as a prepared statement Usage: usePrepared("SQL String")

Methods inherited from class java.lang.Object

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

Field Detail

inUse

protected boolean inUse

Whether this dbconnection is being used

lastError

protected java.lang.String lastError

if any SQL errors occur, they are here.

failuresInARow

protected int failuresInARow

number of failures in a row

sqlserver

protected boolean sqlserver

isReusable

protected boolean isReusable

lastSQL

protected java.lang.String lastSQL

for tracking the last sql statement made

Constructor Detail

DBConnection

public DBConnection(DBConnections parent,
                    java.lang.String DBClass,
                    java.lang.String DBService,
                    java.lang.String DBUser,
                    java.lang.String DBPass,
                    boolean DBReuse)
             throws java.sql.SQLException

construction

Usage: DBConnection("","","");

Parameters:

DBClass - JDBC Class

DBService - ODBC SERVICE

DBUser - ODBC LOGIN USERNAME

DBPass - ODBC LOGIN PASSWORD

DBReuse - Whether the connection can be reused.

Throws:

java.sql.SQLException

Method Detail

catalog

public java.lang.String catalog()

isFakeDB

public boolean isFakeDB()

close

public void close()

shut down this connection totally

Usage: close()

use

public boolean use(java.lang.String openerSQL)

set up this connection for use

Usage: use("begin transaction")

Parameters:

openerSQL - Any SQL string you'd like to send

Returns:

boolean The connection being used

useEmpty

public boolean useEmpty()

set up this connection for use

Usage: useEmpty()

Returns:

boolean The connection being used

usePrepared

public boolean usePrepared(java.lang.String SQL)

set up this connection for use as a prepared statement

Usage: usePrepared("SQL String")

Parameters:

SQL - Any SQL string you'd like to use

Returns:

boolean The connection being used

rePrepare

public boolean rePrepare(java.lang.String SQL)

set up this connection for use as a prepared statement Requires an already in use connection.

Usage: rePrepare("SQL String")

Parameters:

SQL - Any SQL string you'd like to use

Returns:

boolean The connection being used

closeStatements

protected void closeStatements(java.lang.String Closer)

doneUsing

protected void doneUsing(java.lang.String Closer)

report this connection as being free

Usage: doneUsing("roll back");

Parameters:

Closer - Any SQL string you'd like to send

query

public java.sql.ResultSet query(java.lang.String queryString)
                         throws java.sql.SQLException

execute a query, returning the resultset

Usage: R=query("SELECT STATEMENT");

Parameters:

queryString - SQL query-style string

Returns:

ResultSet The results of the query

Throws:

java.sql.SQLException

setPreparedClobs

public void setPreparedClobs(java.lang.String[] vals)
                      throws java.sql.SQLException

Throws:

java.sql.SQLException

update

public int update(java.lang.String updateString,
                  int retryNum)
           throws java.sql.SQLException

execute an sql update, returning the status

Usage: update("UPDATE STATEMENT");

Parameters:

updateString - SQL update-style string

retryNum - a retry number

Returns:

int The status of the update

Throws:

java.sql.SQLException

ready

public boolean ready()

returns whether this connection is ready for use

Usage: ready();

Returns:

boolean Whether this connection is ready

inUse

public boolean inUse()

returns whether this connection is in use

Usage: inUse();

Returns:

boolean Whether this connection is in use

clearFailures

public void clearFailures()

known errors should not be a reason to report a dead state

Usage: clearFailures();

inSQLServerCommunication

public boolean inSQLServerCommunication()

isProbablyDead

public boolean isProbablyDead()

returns whether this connection is *probably* dead

Usage: isProbablyDead();

Returns:

boolean Whether this connection is probably dead

isProbablyLockedUp

public boolean isProbablyLockedUp()

returns whether this connection is *probably* locked up

Usage: isProbablyLockedUp();

Returns:

boolean Whether this connection is locked up

getLastError

public java.lang.String getLastError()

returns an error if there was one

Usage: getLastError();

Returns:

String The last error SQL string, if any

getPreparedStatement

public java.sql.PreparedStatement getPreparedStatement()

returns the prepared statement, if creates

Usage: getPreparedStatement();

Returns:

PreparedStatement the prepared statement