sapphire.util

Interface DBAccess

public interface DBAccess

Method Summary

Modifier and Type	Method and Description
boolean	checkExists(java.lang.String existsSQL) Checks the existence of a record using a SQL query.
boolean	checkPreparedExists(java.lang.String existsSQL, java.lang.Object[] o1) Checks the existence of a record using a prepared SQL query with bind variables.
void	closeCall() Closes the default callablestatement.
void	closeCall(java.lang.String name) Closes a named callablestatement.
void	closeResultSet() Closes the default resultset.
void	closeResultSet(java.lang.String name) Closes a named resultset.
void	closeStatement() Closes the default prepared statement.
void	closeStatement(java.lang.String name) Closes a named prepared statement.
void	createPreparedResultSet(java.lang.String sql, java.lang.Object[] objectlist) Creates a new auto-named result set based on bind variables.
void	createPreparedResultSet(java.lang.String name, java.lang.String sql, java.lang.Object[] objectlist) Creates a new named result set based on bind variables.
void	createResultSet(java.lang.String sql) Creates a new auto-named result set.
void	createResultSet(java.lang.String name, java.lang.String sql) Creates a new named result set.
int	executePreparedUpdate(java.lang.String sql, java.lang.Object[] objectlist) Executes a statement (insert, update or delete) based on bind bind variables.
void	executeSQL(java.lang.String sql) executeSQL Method
int	executeUpdate(java.lang.String sql) executeUpdate Method
java.math.BigDecimal	getBigDecimal(java.lang.String column) Returns a column big decimal value from the current record of the default resultset.
java.math.BigDecimal	getBigDecimal(java.lang.String name, java.lang.String column) Returns a column big decimal value from the current record of a resultset.
java.lang.String	getBinaryStream(java.lang.String column) Deprecated. This method is replaced by getClob to retrieve from nvarchar(max) column
java.lang.String	getBinaryStream(java.lang.String name, java.lang.String column) Deprecated. This method is replaced by getClob to retrieve from nvarchar(max) column
java.sql.Blob	getBlob(java.lang.String column) Returns a column blob value from the current record of the default resultset.
java.sql.Blob	getBlob(java.lang.String name, java.lang.String column) Returns a column blob value from the current record of a resultset.
java.lang.String	getClob(java.lang.String column) Returns a column clob value from the current record of the default resultset.
java.lang.String	getClob(java.lang.String name, java.lang.String column) Returns a column clob value from the current record of a resultset
int	getColumnCount() getColumnCount Method
int	getColumnCount(java.lang.String name) getColumnCount Method
java.lang.String	getColumnName(int col) getColumnName Method
java.lang.String	getColumnName(java.lang.String name, int col) getColumnName Method
java.sql.Connection	getConnection() getConnection Method
int	getCount(java.lang.String countSQL) Returns an int being the result of a select count(*) type query
int	getInt(java.lang.String column) Returns a column integer value from the current record of the default resultset.
int	getInt(java.lang.String name, java.lang.String column) Returns a column integer value from the current record of a resultset.
boolean	getNext() Moves to the next record in the objects resultset.
boolean	getNext(java.lang.String name) Moves to the next record of a resultset.
int	getPreparedCount(java.lang.String countSQL, java.lang.Object[] o1) Returns an int being the result of a select count(*) type query
int	getQueryTimeout() getQueryTimeout Method
java.sql.ResultSet	getResultSet() getResultSet Method
java.sql.ResultSet	getResultSet(java.lang.String name) getResultSet Method
java.lang.String	getString(java.lang.String column) Returns a column string value from the current record of the default resultset.
java.lang.String	getString(java.lang.String name, java.lang.String column) Returns a column string value from the current record of a resultset.
java.sql.Timestamp	getTimestamp(java.lang.String column) Returns a column timestamp value from the current record of the default resultset.
java.sql.Timestamp	getTimestamp(java.lang.String name, java.lang.String column) Returns a column timestamp value from the current record of a resultset.
java.lang.String	getValue(java.lang.String column) Returns a not null string value from the current record of the default resultset.
java.lang.String	getValue(java.lang.String name, java.lang.String column) Returns a not null string value from the current record of a resultset.
java.lang.String	hint(java.lang.String table) Deprecated. This method is no longer required for SQLServer implementations due to the implementation of row versioning isolation mode
boolean	isOracle() isOracle Method
boolean	isSqlServer() isSqlServer Method
java.lang.String	newName() Returns a unique name that can be used when creating resultsets or prepared statements.
java.sql.CallableStatement	prepareCall(java.lang.String statement) Prepares a new auto-named callable statement.
java.sql.CallableStatement	prepareCall(java.lang.String name, java.lang.String statement) Prepares a new named callable statement.
java.sql.PreparedStatement	prepareStatement(java.lang.String statement) Prepares a new auto-named callable statement.
java.sql.PreparedStatement	prepareStatement(java.lang.String name, java.lang.String statement) Prepares a new named prepared statement.
void	setQueryTimeout(int queryTimeout) setQueryTimeout Method

Method Detail

newName

java.lang.String newName()

Returns a unique name that can be used when creating resultsets or prepared statements. The name is guaranteed to be unique for the current instance.

Returns:

A unique name

checkExists

boolean checkExists(java.lang.String existsSQL)
             throws SapphireException

Checks the existence of a record using a SQL query.

Parameters:

existsSQL - Query to check existence of a row

Returns:

True if at least one record was found, false otherwise

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

checkPreparedExists

boolean checkPreparedExists(java.lang.String existsSQL,
                            java.lang.Object[] o1)
                     throws SapphireException

Checks the existence of a record using a prepared SQL query with bind variables.

Parameters:

existsSQL - Query with bind variables to check existence of a row

o1 - array to holder corresponding bind values

Returns:

True if at least one record was found, false otherwise

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getCount

int getCount(java.lang.String countSQL)
      throws SapphireException

Returns an int being the result of a select count(*) type query

Parameters:

countSQL - Query of the sort: select count(*) from ...

Returns:

count the value returned from the single row/column that the query should return

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getPreparedCount

int getPreparedCount(java.lang.String countSQL,
                     java.lang.Object[] o1)
              throws SapphireException

Returns an int being the result of a select count(*) type query

Parameters:

countSQL - Query of the sort: select count(*) from ... with bind variable place holders ?...

o1 - array to holder corresponding bind values

Returns:

count the value returned from the single row/column that the query should return

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

createResultSet

void createResultSet(java.lang.String name,
                     java.lang.String sql)
              throws SapphireException

Creates a new named result set.

Parameters:

name - A name for the result set created

sql - Query to generate a result set

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

createResultSet

void createResultSet(java.lang.String sql)
              throws SapphireException

Creates a new auto-named result set.

Parameters:

sql - Query to generate a result set

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

createPreparedResultSet

void createPreparedResultSet(java.lang.String sql,
                             java.lang.Object[] objectlist)
                      throws SapphireException

Creates a new auto-named result set based on bind variables. Queries with bind variables are typically faster on repetition than non-bound queries. Example: database.createPreparedResultSet( "name", "select * from table where department=? and salary > ?, new Object [] { "Finance", new Integer( 100000 ) } )

Parameters:

sql - Query to generate a result set (including ?s for parameters)

objectlist - Array of object corresponding to the ?s in the sql statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

createPreparedResultSet

void createPreparedResultSet(java.lang.String name,
                             java.lang.String sql,
                             java.lang.Object[] objectlist)
                      throws SapphireException

Creates a new named result set based on bind variables. Queries with bind variables are typically faster on repetition than non-bound queries. Example: database.createPreparedResultSet( "select * from table where department=? and salary > ?, new Object [] { "Finance", new Integer( 100000 ) } )

Parameters:

name - A name for the result set created

sql - Query to generate a result set (including ?s for parameters)

objectlist - Array of object corresponding to the ?s in the sql statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

prepareCall

java.sql.CallableStatement prepareCall(java.lang.String name,
                                       java.lang.String statement)
                                throws SapphireException

Prepares a new named callable statement.

Parameters:

name - A name for the callable statement created

statement - sql to generate a callable statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

prepareCall

java.sql.CallableStatement prepareCall(java.lang.String statement)
                                throws SapphireException

Prepares a new auto-named callable statement.

Parameters:

statement - sql to generate a callable statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

prepareStatement

java.sql.PreparedStatement prepareStatement(java.lang.String name,
                                            java.lang.String statement)
                                     throws SapphireException

Prepares a new named prepared statement.

Parameters:

name - A name for the prepared statement created

statement - sql to generate a prepared statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

prepareStatement

java.sql.PreparedStatement prepareStatement(java.lang.String statement)
                                     throws SapphireException

Prepares a new auto-named callable statement.

Parameters:

statement - sql to generate a prepared statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getNext

boolean getNext(java.lang.String name)
         throws SapphireException

Moves to the next record of a resultset.

Parameters:

name - The name of the result set

Returns:

Ttrue if another record exists in the result set, false otherwise

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getNext

boolean getNext()
         throws SapphireException

Moves to the next record in the objects resultset.

Returns:

True if another record exists in the result set, false otherwise

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getString

java.lang.String getString(java.lang.String name,
                           java.lang.String column)
                    throws SapphireException

Returns a column string value from the current record of a resultset.

Parameters:

name - The name of the result set

name - The name of the column in the result set

Returns:

The value of the returned string

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getString

java.lang.String getString(java.lang.String column)
                    throws SapphireException

Returns a column string value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned string

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getValue

java.lang.String getValue(java.lang.String name,
                          java.lang.String column)
                   throws SapphireException

Returns a not null string value from the current record of a resultset.

Parameters:

name - The name of the result set

name - The name of the column in the result set

Returns:

The value of the returned string

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getValue

java.lang.String getValue(java.lang.String column)
                   throws SapphireException

Returns a not null string value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned string

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String name,
                                   java.lang.String column)
                            throws SapphireException

Returns a column big decimal value from the current record of a resultset.

Parameters:

name - The name of the result set

column - The name of the column in the result set

Returns:

The value of the returned big decimal

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String column)
                            throws SapphireException

Returns a column big decimal value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned big decimal

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getInt

int getInt(java.lang.String name,
           java.lang.String column)
    throws SapphireException

Returns a column integer value from the current record of a resultset.

Parameters:

name - The name of the result set

name - The name of the column in the result set

Returns:

The value of the returned int

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getInt

int getInt(java.lang.String column)
    throws SapphireException

Returns a column integer value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned int

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getTimestamp

java.sql.Timestamp getTimestamp(java.lang.String name,
                                java.lang.String column)
                         throws SapphireException

Returns a column timestamp value from the current record of a resultset.

Parameters:

name - The name of the result set

name - The name of the column in the result set

Returns:

The value of the returned timestamp

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getTimestamp

java.sql.Timestamp getTimestamp(java.lang.String column)
                         throws SapphireException

Returns a column timestamp value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned timestamp

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getBinaryStream

java.lang.String getBinaryStream(java.lang.String name,
                                 java.lang.String column)
                          throws SapphireException

Deprecated. This method is replaced by getClob to retrieve from nvarchar(max) column

Returns a column binary stream from the current record of the resultset This is used currently to get the "image" datatype value from a Microsoft SQL Server database as a string.

Parameters:

name -

column -

Returns:

Throws:

SapphireException

getBinaryStream

java.lang.String getBinaryStream(java.lang.String column)
                          throws SapphireException

Deprecated. This method is replaced by getClob to retrieve from nvarchar(max) column

Returns a column binary stream from the current record of the resultset This is used currently to get the "image" datatype value from a Microsoft SQL Server database as a string.

Parameters:

column - name of the column

Returns:

Throws:

SapphireException

getBlob

java.sql.Blob getBlob(java.lang.String name,
                      java.lang.String column)
               throws SapphireException

Returns a column blob value from the current record of a resultset.

Parameters:

name - The name of the result set

name - The name of the column in the result set

Returns:

The value of the returned blob

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getBlob

java.sql.Blob getBlob(java.lang.String column)
               throws SapphireException

Returns a column blob value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned blob

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getClob

java.lang.String getClob(java.lang.String name,
                         java.lang.String column)
                  throws SapphireException

Returns a column clob value from the current record of a resultset

Parameters:

name - The name of the result set

name - The name of the column in the result set

Returns:

The value of the returned clob

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getClob

java.lang.String getClob(java.lang.String column)
                  throws SapphireException

Returns a column clob value from the current record of the default resultset.

Parameters:

column - The name of the column in the result set

Returns:

The value of the returned clob

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

closeResultSet

void closeResultSet(java.lang.String name)

Closes a named resultset.

Parameters:

name - The name of the result set

closeResultSet

void closeResultSet()

Closes the default resultset.

closeCall

void closeCall(java.lang.String name)

Closes a named callablestatement.

Parameters:

name - The name of the callablestatement

closeCall

void closeCall()

Closes the default callablestatement.

closeStatement

void closeStatement(java.lang.String name)

Closes a named prepared statement.

Parameters:

name - The name of the prepared statement

closeStatement

void closeStatement()

Closes the default prepared statement.

executeSQL

void executeSQL(java.lang.String sql)
         throws SapphireException

executeSQL Method

Parameters:

sql - DDL statement to be executed

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

executeUpdate

int executeUpdate(java.lang.String sql)
           throws SapphireException

executeUpdate Method

Parameters:

sql - Update statement to be executed

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getColumnCount

int getColumnCount(java.lang.String name)
            throws SapphireException

getColumnCount Method

Parameters:

name - The name of the result set

Returns:

The number of columns in the named result set

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getColumnCount

int getColumnCount()
            throws SapphireException

getColumnCount Method

Returns:

The number of columns in the default result set

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getColumnName

java.lang.String getColumnName(java.lang.String name,
                               int col)
                        throws SapphireException

getColumnName Method

Parameters:

name - The name of the result set

col - A column number in the result set

Returns:

The name of the column

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getColumnName

java.lang.String getColumnName(int col)
                        throws SapphireException

getColumnName Method

Parameters:

col - A column number in the result set

Returns:

The name of the column

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getResultSet

java.sql.ResultSet getResultSet()
                         throws SapphireException

getResultSet Method

Returns:

The java.sql.ResultSet

Throws:

SapphireException - Thrown when the result set name is invalid

getResultSet

java.sql.ResultSet getResultSet(java.lang.String name)
                         throws SapphireException

getResultSet Method

Parameters:

name - The name of the result set

Returns:

The java.sql.ResultSet

Throws:

SapphireException - Thrown when the result set name is invalid

getConnection

java.sql.Connection getConnection()

getConnection Method

Returns:

The java.sql.Connection which correspond to a pooled connection tied to the transaction

executePreparedUpdate

int executePreparedUpdate(java.lang.String sql,
                          java.lang.Object[] objectlist)
                   throws SapphireException

Executes a statement (insert, update or delete) based on bind bind variables. Statements with bind variables are typically faster on repetition than non-bound statements. Example: database.executePreparedUpdate( "update user set department=? and salary > ? where userid=?, new Object [] { "Finance", new Integer( 100000 ), "1001" } )

Parameters:

sql - Statement to execute (including ?s for parameters)

objectlist - Array of object corresponding to the ?s in the sql statement

Throws:

SapphireException - Thrown when an unexpected SQL errors occurs

getQueryTimeout

int getQueryTimeout()

getQueryTimeout Method

Returns:

The time out in seconds for any SQL query or statement to be executed

setQueryTimeout

void setQueryTimeout(int queryTimeout)

setQueryTimeout Method

Parameters:

queryTimeout - Set SQL query or statement to be executed to the time out value in seconds. This overrides the configured system default query time out

hint

java.lang.String hint(java.lang.String table)

Deprecated. This method is no longer required for SQLServer implementations due to the implementation of row versioning isolation mode

hint Method

Parameters:

table - The table name from the query

Returns:

The table is returned unaltered

isOracle

boolean isOracle()

isOracle Method

Returns:

Boolean indicating if Oracle DBMS

isSqlServer

boolean isSqlServer()

isSqlServer Method

Returns:

Boolean indicating if SqlServer DBMS