com.heirloomcomputing.epli.runtime

Class SqlCursor

java.lang.Object

com.heirloomcomputing.epli.runtime.SqlCursor

public class SqlCursor
extends java.lang.Object

SqlCursor manages one SQL CURSOR operations.

Author:

Heirloom Computing, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CURSOR_NAME
static int	MODE_ANSI
static int	MODE_ORACLE
static int	ORACLE_UNSUPPORTED_FEATURE

Constructor Summary

Constructors

Constructor and Description
SqlCursor(java.lang.String name) create a SqlCursor
SqlCursor(java.lang.String name, boolean withHold, SqlCursors parent) create a SqlCursor with attributes

Method Summary

Modifier and Type	Method and Description
boolean	close() close the cursor
boolean	deallocate() deallocate storage associated with the cursor
void	declare(java.sql.PreparedStatement ps1) declare the cursor to be associated with the prepared statement
SqlCursor	generate() generate a prepared statement
java.lang.Boolean	getHighValuesAsBytes() indicate if HIGH VALUES is supported by the database associated with this cursor
int	getOpenSequence() return the current open sequence of this cursor
java.sql.PreparedStatement	getPreparedStatement() return the prepared statement associated with this cursor
java.sql.ResultSet	getResultSet() get the result set as a result of opening (executing) the cursor
java.sql.SQLWarning	getSQLWarning() return the SQLWarning most recently issued
boolean	isHold() indicate if the WITH HOLD marker is on for this cursor
boolean	isInvalid() indicate if the current connection is invalid
boolean	isOpen() indicate if the cursor is currently open
boolean	isPrepared() indicate if the cursor has been prepared
boolean	isValid() indicate if the current connection is valid
void	log(java.lang.String s) log a message to the SQL Context log
void	log(java.lang.Throwable t) log an exception to the SQL context log
boolean	ofPSName(java.lang.String psName) indicate if the prepared statement name matches
boolean	open() open the cursor
SqlCursor	reset() reset the cursor
SqlCursor	reset(boolean withHold) reset this SQL Cursor
void	resetParameters() reset parameters to the SQL cursor
void	setFetchSize(int value) set the number of rows to fetch at a time
void	setLogMode(boolean state) set the log mode
void	setMaxRows(int value) set the maximum number of rows this cursor should retrieve
SqlCursor	setObject(int slot, java.lang.Object parameter) set the object associated with this cursor
SqlCursor	setObject(int slot, java.lang.Object parameter, java.lang.Object nullIndicator) set the object associated with this cursor
SqlCursor	setObject(int slot, java.lang.Object parameter, java.lang.Object nullIndicator, int oracleType) set the object associated with this cursor
SqlCursor	setObject(int slot, java.lang.Object parameter, java.lang.Object nullIndicator, int oracleType, java.lang.String dateFormat) set the object associated with this cursor
SqlCursor	setObject(java.lang.Object parameter) set the cursor parameter to this cursor
SqlCursor	setObject(java.lang.Object parameter, java.lang.Object nullIndicator) set the cursor parameter associated with this cursor
SqlCursor	setObject(java.lang.Object parameter, java.lang.Object nullIndicator, int oracleType) set the cursor parameter associated with this cursor
SqlCursor	setObject(java.lang.Object parameter, java.lang.Object nullIndicator, int oracleType, java.lang.String dateFormat) set the cursor parameter associated with this cursor
void	setPrefetchSize(int value) set the prefetch amount of rows
void	setPs(java.sql.PreparedStatement ps) set the prepared statement
void	setPSName(java.lang.String psName) set the prepared statement name
void	setQueryTimeout(int value) set the query timeout in milliseconds
void	setResultSet(java.sql.ResultSet rs) set the result set associated with this cursor
void	setValid(boolean state) set the valid state of this connection
int	updateWhereCurrent(java.lang.String updateString) update the current row(s) associated with this cursor
int	updateWhereCurrent(java.lang.String updateString, java.lang.Object[] params) update the current row(s) associated with this cursor
int	updateWhereCurrent(java.lang.String updateString, java.lang.Object[] params, java.lang.Object[] indics) update the current row(s) associated with this cursor

Methods inherited from class java.lang.Object

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

Field Detail

ORACLE_UNSUPPORTED_FEATURE

public static final int ORACLE_UNSUPPORTED_FEATURE

See Also:

Constant Field Values

DEFAULT_CURSOR_NAME

public static final java.lang.String DEFAULT_CURSOR_NAME

See Also:

Constant Field Values

MODE_ANSI

public static final int MODE_ANSI

See Also:

Constant Field Values

MODE_ORACLE

public static final int MODE_ORACLE

See Also:

Constant Field Values

Constructor Detail

SqlCursor

public SqlCursor(java.lang.String name)

create a SqlCursor

Parameters:

name - - the name of the cursor

SqlCursor

public SqlCursor(java.lang.String name,
                 boolean withHold,
                 SqlCursors parent)

create a SqlCursor with attributes

Parameters:

name - - the name of the cursor

withHold - - true if created WITH HOLD (open after commits)

parent - - the SqlCursors to use as a parent

Method Detail

setPrefetchSize

public void setPrefetchSize(int value)

set the prefetch amount of rows

Parameters:

value - - the number of rows to prefetch

setFetchSize

public void setFetchSize(int value)

set the number of rows to fetch at a time

Parameters:

value - - the number of rows to fetch

setMaxRows

public void setMaxRows(int value)

set the maximum number of rows this cursor should retrieve

Parameters:

value - - the maximum number of rows

setQueryTimeout

public void setQueryTimeout(int value)

set the query timeout in milliseconds

Parameters:

value - - the timeout in milliseconds

setLogMode

public void setLogMode(boolean state)

set the log mode

Parameters:

state - - true to turn loggin on

log

public final void log(java.lang.String s)

log a message to the SQL Context log

Parameters:

s - - the String message to log

log

public final void log(java.lang.Throwable t)

log an exception to the SQL context log

Parameters:

t - - the Throwable exception to log

getSQLWarning

public java.sql.SQLWarning getSQLWarning()

return the SQLWarning most recently issued

Returns:

the SQLWarning most recently issued

isValid

public boolean isValid()

indicate if the current connection is valid

Returns:

true if the current connection is valid

isInvalid

public boolean isInvalid()

indicate if the current connection is invalid

Returns:

true if the current connection is not valid

setValid

public void setValid(boolean state)

set the valid state of this connection

Parameters:

state - - true if this connection is currently valid, false if not

resetParameters

public final void resetParameters()

reset parameters to the SQL cursor

reset

public final SqlCursor reset(boolean withHold)

reset this SQL Cursor

Parameters:

withHold - - true if this cursor should be marked as WITH HOLD (surviving commits)

Returns:

this to allow for chaining

reset

public final SqlCursor reset()

reset the cursor

Returns:

this to allow for chaining

isHold

public final boolean isHold()

indicate if the WITH HOLD marker is on for this cursor

Returns:

true if the cursor was defined WITH HOLD (persists across commits)

setObject

public final SqlCursor setObject(java.lang.Object parameter)

set the cursor parameter to this cursor

Parameters:

parameter - the parameter associated with the cursor

Returns:

this to allow for chaining

setObject

public final SqlCursor setObject(java.lang.Object parameter,
                                 java.lang.Object nullIndicator)

set the cursor parameter associated with this cursor

Parameters:

parameter - the parameter associated with the cursor

nullIndicator - the object indicating whether this parameter contains null

Returns:

this to allow for chaining

setObject

public final SqlCursor setObject(java.lang.Object parameter,
                                 java.lang.Object nullIndicator,
                                 int oracleType)

set the cursor parameter associated with this cursor

Parameters:

parameter - the parameter associated with the cursor

nullIndicator - the object indicating whether this parameter contains null

oracleType - the Oracle column type

Returns:

this to facilitate chaining

setObject

public final SqlCursor setObject(java.lang.Object parameter,
                                 java.lang.Object nullIndicator,
                                 int oracleType,
                                 java.lang.String dateFormat)

set the cursor parameter associated with this cursor

Parameters:

parameter - the parameter associated with the cursor

nullIndicator - the object indicating whether this parameter contains null

oracleType - the Oracle column type

dateFormat - for date columns the String representing the date format

Returns:

this to facilitate chaining

setObject

public final SqlCursor setObject(int slot,
                                 java.lang.Object parameter)
                          throws java.sql.SQLException

set the object associated with this cursor

Parameters:

slot - the slot number to set

parameter - the Object at that slot number

Returns:

this to facilitate chaining

Throws:

java.sql.SQLException - if the underlying JDBC operation failed

setObject

public final SqlCursor setObject(int slot,
                                 java.lang.Object parameter,
                                 java.lang.Object nullIndicator)
                          throws java.sql.SQLException

set the object associated with this cursor

Parameters:

slot - the slot number to set

parameter - the Object at that slot number

nullIndicator - the Object that indicates whether this parameter is null

Returns:

this to facilitate chaining

Throws:

java.sql.SQLException - if the underlying JDBC operation failed

setObject

public final SqlCursor setObject(int slot,
                                 java.lang.Object parameter,
                                 java.lang.Object nullIndicator,
                                 int oracleType)
                          throws java.sql.SQLException

set the object associated with this cursor

Parameters:

slot - the slot number to set

parameter - the Object at that slot number

nullIndicator - the Object that indicates whether this parameter is null

oracleType - the Oracle type number associated with this object

Returns:

this to facilitate chaining

Throws:

java.sql.SQLException - if the underlying JDBC operation failed

setObject

public final SqlCursor setObject(int slot,
                                 java.lang.Object parameter,
                                 java.lang.Object nullIndicator,
                                 int oracleType,
                                 java.lang.String dateFormat)
                          throws java.sql.SQLException

set the object associated with this cursor

Parameters:

slot - the slot number to set

parameter - the Object at that slot number

nullIndicator - the Object that indicates whether this parameter is null

oracleType - the Oracle type number associated with this object

dateFormat - for date columns the String representing the date format

Returns:

this to facilitate chaining

Throws:

java.sql.SQLException - if the underlying JDBC operation failed

generate

public final SqlCursor generate()
                         throws java.sql.SQLException

generate a prepared statement

Returns:

the SQLCursor that results from preparing the cursor

Throws:

java.sql.SQLException - should an error occur

setPSName

public final void setPSName(java.lang.String psName)

set the prepared statement name

Parameters:

psName - the prepared statement name

ofPSName

public final boolean ofPSName(java.lang.String psName)

indicate if the prepared statement name matches

Parameters:

psName - the prepared statement name to check

Returns:

true if the name of this cursor matches that name

open

public final boolean open()
                   throws java.sql.SQLException

open the cursor

Returns:

true if the cursor was opened

Throws:

java.sql.SQLException - if an error occurred during opening

isOpen

public final boolean isOpen()

indicate if the cursor is currently open

Returns:

true if the cursor is opened

isPrepared

public final boolean isPrepared()

indicate if the cursor has been prepared

Returns:

true if the cursor is prepared

close

public final boolean close()
                    throws java.sql.SQLException

close the cursor

Returns:

true if the cursor was closed

Throws:

java.sql.SQLException - if an error occurred while attempting to close the cursor

deallocate

public final boolean deallocate()
                         throws java.sql.SQLException

deallocate storage associated with the cursor

Returns:

true if deallocation was successful

Throws:

java.sql.SQLException - if an error occurred during deallocation

declare

public final void declare(java.sql.PreparedStatement ps1)
                   throws java.sql.SQLException

declare the cursor to be associated with the prepared statement

Parameters:

ps1 - a PreparedStatement associated with the cursor

Throws:

java.sql.SQLException - if an error occurred

getResultSet

public final java.sql.ResultSet getResultSet()
                                      throws java.sql.SQLException

get the result set as a result of opening (executing) the cursor

Returns:

the SQL ResultSet returned by this cursor

Throws:

java.sql.SQLException - if an error occurred

setResultSet

public void setResultSet(java.sql.ResultSet rs)
                  throws java.sql.SQLException

set the result set associated with this cursor

Parameters:

rs - the ResultSet associated with this cursor

Throws:

java.sql.SQLException - if an error occurred while checking if this cursor is open

getPreparedStatement

public final java.sql.PreparedStatement getPreparedStatement()

return the prepared statement associated with this cursor

Returns:

the PreparedStatement associated with this cursor

updateWhereCurrent

public final int updateWhereCurrent(java.lang.String updateString,
                                    java.lang.Object[] params,
                                    java.lang.Object[] indics)
                             throws java.sql.SQLException

update the current row(s) associated with this cursor

Parameters:

updateString - a String indicating the update operation

params - - the parameters to update

indics - - the indices to update

Returns:

the number of rows updated

Throws:

java.sql.SQLException - if an error occurred during update

updateWhereCurrent

public final int updateWhereCurrent(java.lang.String updateString,
                                    java.lang.Object[] params)
                             throws java.sql.SQLException

update the current row(s) associated with this cursor

Parameters:

updateString - a String indicating the update operation

params - - the parameters to update

Returns:

the number of rows updated

Throws:

java.sql.SQLException - if an error occurred during update

updateWhereCurrent

public final int updateWhereCurrent(java.lang.String updateString)
                             throws java.sql.SQLException

update the current row(s) associated with this cursor

Parameters:

updateString - a String indicating the update operation

Returns:

the number of rows updated

Throws:

java.sql.SQLException - if an error occurred during update

setPs

public void setPs(java.sql.PreparedStatement ps)

set the prepared statement

Parameters:

ps - the PreparedStatement associated with this SqlCursor

getHighValuesAsBytes

public java.lang.Boolean getHighValuesAsBytes()

indicate if HIGH VALUES is supported by the database associated with this cursor

Returns:

true if HIGH VALUES is allowed

getOpenSequence

public int getOpenSequence()

return the current open sequence of this cursor

Returns:

the sequence number