com.heirloomcomputing.epli.runtime

Class SqlCursors

java.lang.Object

com.heirloomcomputing.epli.runtime.SqlCursors

public class SqlCursors
extends java.lang.Object

SqlCursors is a wrapper on the cursor concept. [HCI ticket#1419 mnh 2013-03-14] provide mechanism to find a previously allocated cursor FOR a particular statement-name. [HCI ticket#1419 mnh 2013-03-14] also, change raw type Hashtable reference to typed reference to satisfy Java programming conventions.

Author:

Heirloom Computing, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CURSOR_NAME

Constructor Summary

Constructors

Constructor and Description
SqlCursors()

Method Summary

Modifier and Type	Method and Description
SqlCursor	allocate(java.lang.Object cursorName) allocate a cursor by cursor name
SqlCursor	allocate(java.lang.Object passCursorName, boolean withHold) allocate a cursor by cursor name
SqlCursor	allocateOpen(java.lang.Object passCursorName, boolean withHold) allocate a cursor by cursor name and then open it
SqlCursor	allocateOpen(java.lang.String passCursorName, java.lang.Integer loc) [HCI US812 mnh 2016-3-22] allocate and open a cursor binding it to the result set retrieved from a CALLed stored procedure associated with locator variable LOC
int	assignNextOpenSequence() update the open sequence number
void	close(java.lang.Object cursorName) close a specific cursor among this group of SqlCursors
void	closeAll() close all cursors in this group of SqlCursors
void	closeAllNotHeld() close all cursors not marked as WITH HOLD in this group of SqlCursors
boolean	deallocate(java.lang.Object passCursorName) deallocate a spcific cursor among these SqlCursors
void	deallocateAll() deallocate all cursors
void	deallocatePrepare(java.lang.Object passPsName) deallocates any cursors associated with a prepared statement
SqlCursor	findStmtNameOrAllocate(java.lang.String psName, java.lang.String crName) [HCI ticket#1419 mnh 2013-03-14] allow "EXECUTE stmt-name" to find a cursor for a stmt-name
SqlCursor	getCursor(java.lang.Object cursorName) obtain cursor by name
java.util.Hashtable<java.lang.String,SqlCursor>	getCursors() return all the SqlCursor s in a table by SqlCursor name
SqlCursor	open(java.lang.Object cursorName) open a specific cursor among this group of SqlCursors
void	saveResultSet(java.lang.String storedProcName, java.sql.ResultSet resultSet) [HCI US812 mnh 2016-3-22] save one (of possibly many) result sets that come from the execution of a stored procedure.
void	setLogMode(boolean value) set the log mode for this group of cursors

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CURSOR_NAME

public static final java.lang.String DEFAULT_CURSOR_NAME

See Also:

Constant Field Values

Constructor Detail

SqlCursors

public SqlCursors()

Method Detail

setLogMode

public void setLogMode(boolean value)

set the log mode for this group of cursors

Parameters:

value - true to turn logging on

getCursor

public final SqlCursor getCursor(java.lang.Object cursorName)

obtain cursor by name

Parameters:

cursorName - the cursor to look for in this group of SqlCursors

Returns:

the SqlCursor associated with this name or null if none is associated

getCursors

public final java.util.Hashtable<java.lang.String,SqlCursor> getCursors()

return all the SqlCursor s in a table by SqlCursor name

Returns:

a Hashtable<> of SqlCursor by name

allocate

public final SqlCursor allocate(java.lang.Object cursorName)

allocate a cursor by cursor name

Parameters:

cursorName - the name to allocate

Returns:

the SqlCursor allocated

allocate

public final SqlCursor allocate(java.lang.Object passCursorName,
                                boolean withHold)

allocate a cursor by cursor name

Parameters:

passCursorName - the name to allocate

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

Returns:

the SqlCursor allocated

allocateOpen

public final SqlCursor allocateOpen(java.lang.Object passCursorName,
                                    boolean withHold)
                             throws java.sql.SQLException

allocate a cursor by cursor name and then open it

Parameters:

passCursorName - the name to allocate

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

Returns:

the SqlCursor allocated

Throws:

a - SQLException if an error occurred

java.sql.SQLException

saveResultSet

public final void saveResultSet(java.lang.String storedProcName,
                                java.sql.ResultSet resultSet)
                         throws java.sql.SQLException

[HCI US812 mnh 2016-3-22] save one (of possibly many) result sets that come from the execution of a stored procedure. later dynamic sql calls will ASSOCIATE a "locator" variable with that procedure and ALLOCATE it to a cursor. NOTE: because DB drivers close the ResultSet when the statement is closed, we create a copy in an in-memory form for later asynchronous retrieval. This is required because of the mismatch between JDBC ResultSet concepts and EXEC SQL locators and cursors.

Parameters:

storedProcName - the stored procedure name

resultSet - the associated ResultSet

Throws:

java.sql.SQLException - if an error occurred

allocateOpen

public final SqlCursor allocateOpen(java.lang.String passCursorName,
                                    java.lang.Integer loc)
                             throws java.sql.SQLException

[HCI US812 mnh 2016-3-22] allocate and open a cursor binding it to the result set retrieved from a CALLed stored procedure associated with locator variable LOC

Parameters:

passCursorName - the cursor name

loc - the locator variable

Returns:

the SqlCursor

Throws:

java.sql.SQLException - if an error occurred

findStmtNameOrAllocate

public final SqlCursor findStmtNameOrAllocate(java.lang.String psName,
                                              java.lang.String crName)
                                       throws java.sql.SQLException

[HCI ticket#1419 mnh 2013-03-14] allow "EXECUTE stmt-name" to find a cursor for a stmt-name

Parameters:

psName - the prepared statement name

crName - the cursor name

Returns:

the resulting SqlCursor

Throws:

java.sql.SQLException - if an error occurred

deallocate

public final boolean deallocate(java.lang.Object passCursorName)
                         throws java.sql.SQLException

deallocate a spcific cursor among these SqlCursors

Parameters:

passCursorName - the cursor name to deallocate

Returns:

true if the cursor was deallocated

Throws:

java.sql.SQLException - if an error occurred

deallocateAll

public final void deallocateAll()
                         throws java.sql.SQLException

deallocate all cursors

Throws:

java.sql.SQLException - if an error occurred

open

public final SqlCursor open(java.lang.Object cursorName)
                     throws java.sql.SQLException

open a specific cursor among this group of SqlCursors

Parameters:

cursorName - the cursor name to look for and open

Returns:

the SqlCursor that was opened or null if the name could not be found

Throws:

java.sql.SQLException - if an error occurred

close

public final void close(java.lang.Object cursorName)
                 throws java.sql.SQLException

close a specific cursor among this group of SqlCursors

Parameters:

cursorName - - the cursor to close

Throws:

java.sql.SQLException - if an error occurred

closeAll

public final void closeAll()

close all cursors in this group of SqlCursors

closeAllNotHeld

public final void closeAllNotHeld()
                           throws java.sql.SQLException

close all cursors not marked as WITH HOLD in this group of SqlCursors

Throws:

java.sql.SQLException

deallocatePrepare

public final void deallocatePrepare(java.lang.Object passPsName)
                             throws java.sql.SQLException

deallocates any cursors associated with a prepared statement

Parameters:

passPsName - the prepared statement name to deallocate

Throws:

java.sql.SQLException

assignNextOpenSequence

public int assignNextOpenSequence()

update the open sequence number

Returns:

the current open sequence number for this group of SqlCursors