|
Sun Adapter for DB2 Universal Database | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.stc.connector.db2adapter.base.StatementAgentImpl com.stc.connector.db2adapter.base.PreparedStatementAgentImpl com.stc.connector.db2adapter.Db2PreparedStatementAgent com.stc.connector.db2adapter.Db2CallableStatementAgent
public abstract class Db2CallableStatementAgent
Agent hosts an Db2CallableStatement.
Field Summary |
---|
Fields inherited from class com.stc.connector.db2adapter.base.PreparedStatementAgentImpl |
---|
askGetMoreResults, askGetResultSet, bUseResultsAvailable, curRSetAgent, curRSetSig, nParam, nUpdateCount, retResultSet, retUpdateCount, sCommand |
Fields inherited from class com.stc.connector.db2adapter.base.StatementAgentImpl |
---|
concurrencyType, listener, resultSetConcurMap, resultsetDirection, resultSetDirMap, resultsetType, resultSetTypeMap, session, sqlException, statement, statementClassName |
Constructor Summary | |
---|---|
protected |
Db2CallableStatementAgent()
Default constructor. |
|
Db2CallableStatementAgent(com.stc.connector.db.Session session,
int iScroll,
int iConcur)
Db2CallableStatementAgent constructor. |
|
Db2CallableStatementAgent(com.stc.connector.db.Session session,
java.lang.String sCommand)
Db2CallableStatementAgent constructor. |
|
Db2CallableStatementAgent(com.stc.connector.db.Session session,
java.lang.String sCommand,
int iScroll,
int iConcur)
Db2CallableStatementAgent constructor. |
Method Summary | |
---|---|
void |
clearParameters()
If use Db2 native driver that supports clob, frees all temporary clobs when clears the value of all parameters. |
boolean |
execute()
Instantiates the ResultSet nodes added to this Procedure by matching the ResultSet object's signature at runtime. |
java.sql.Array |
getArray(int index)
Gets the Array value of the indexed parameter. |
java.math.BigDecimal |
getBigDecimal(int index)
Gets the decimal value of the indexed parameter. |
java.sql.Blob |
getBlob(int index)
Gets the Blob value of the indexed parameter. |
boolean |
getBoolean(int index)
Gets the boolean value of the indexed parameter. |
byte |
getByte(int index)
Gets the byte value of the indexed parameter. |
byte[] |
getBytes(int index)
Gets the byte array value of the indexed parameter. |
java.sql.Clob |
getClob(int index)
Gets the Clob value of the indexed parameter. |
java.sql.ResultSet |
getCurRS()
Get the curRS value. |
java.sql.Date |
getDate(int index)
Gets the date value of the indexed parameter. |
java.sql.Date |
getDate(int index,
java.util.Calendar calendar)
Gets the date value of the indexed parameter with time zone from calendar. |
double |
getDouble(int index)
Gets the double value of the indexed parameter. |
float |
getFloat(int index)
Gets the float value of the indexed parameter. |
int |
getInt(int index)
Gets the integer value of the indexed parameter. |
long |
getLong(int index)
Gets the long value of the indexed parameter. |
java.lang.Object |
getObject(int index)
Gets value of the indexed parameter as an instance of Object. |
java.lang.Object |
getObject(int index,
java.util.Map map)
Gets the value of the indexed parameter as an instance of Object and uses map for the customer mapping of the parameter value. |
java.sql.Ref |
getRef(int index)
Gets the Ref value of the indexed parameter. |
int[] |
getResultSetParamsPosition()
gets those parameter positions of a Procedure that are of type ResultSet. |
protected Db2CallableStatementResultSet[] |
getResultSetsObjects()
Gets the ResultSets added to this Procedure. |
protected java.lang.Class[] |
getResultSetTypes()
Gets the Class info about the ResultSets added to this Procedure. |
short |
getShort(int index)
Gets the short value of the indexed parameter. |
java.lang.String |
getSig(java.sql.ResultSet rs)
Gets the signature of ResultSet |
java.lang.String |
getString(int index)
Gets the string value of the indexed parameter. |
java.sql.Time |
getTime(int index)
Gets the time value of the indexed parameter. |
java.sql.Time |
getTime(int index,
java.util.Calendar calendar)
Gets time value of the indexed parameter with time zone from calendar. |
java.sql.Timestamp |
getTimestamp(int index)
Gets the timestamp value of the indexed parameter. |
java.sql.Timestamp |
getTimestamp(int index,
java.util.Calendar calendar)
Gets the timestamp value of the indexed parameter with time zone from calendar. |
int |
getUpdateCount()
Returns the records count of the last executed statement. |
void |
registerOutParameter(int index,
int iType)
Registers the indexed OUT parameter with specified type. |
void |
registerOutParameter(int index,
int iType,
int iScale)
Registers the indexed OUT parameter with specified type and scale. |
void |
registerOutParameter(int index,
int iType,
java.lang.String sType)
Registers the indexed OUT parameter with specified user-named type or REF type. |
protected abstract void |
registerOutParameters()
Registers all output parameters of the prepared call. |
boolean |
resultsAvailable()
Determines whether results (Update Counts and/or Result Sets) are available after an execute. |
void |
sessionClosed(com.stc.connector.db.SessionEvent evt)
If use an Db2 native driver that supports clob, frees all temporary clobs when the session is to be closed. |
void |
sessionOpen(com.stc.connector.db.SessionEvent evt)
Processes a SessionOpen event. |
void |
setClob(int index,
java.lang.Object obj)
Sets the Clob value of the indexed parameter. |
protected void |
setCurRS(java.sql.ResultSet val)
Set the curRS value. |
void |
setResultSetParamsPosition(int[] newResultSetParamsPosition)
marks those parameters of a Procedure that are of type ResultSet. |
protected void |
setResultSetsObjects(Db2CallableStatementResultSet[] newResultSetsObjects)
Moves the current resultset to nex and returns true if the next resultset is available. |
protected void |
setResultSetTypes(java.lang.Class[] resultSetTypes)
sets the Class info about the ResultSets added to this Procedure. |
boolean |
wasNull()
Checks whether or not the last OUT parameter read had the SQL NULL value. |
Methods inherited from class com.stc.connector.db2adapter.Db2PreparedStatementAgent |
---|
setDb2CursorOrds |
Methods inherited from class com.stc.connector.db2adapter.base.PreparedStatementAgentImpl |
---|
addBatch, curRSetSig, enableResultSetsAndUpdateCounts, enableResultSetsOnly, enableUpdateCountsOnly, executeQuery, executeUpdate, getCurRSetAgent, getPreparedStmt, getRSAgentList, getRSAgentSigs, matchResultSetSignature, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setCurRSetAgent, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setRSAgentList, setRSAgentSigs, setShort, setString, setTime, setTime, setTimestamp, setTimestamp |
Methods inherited from class com.stc.connector.db2adapter.base.StatementAgentImpl |
---|
cancel, clearBatch, clearWarnings, executeBatch, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetType, getWarnings, isClosed, queryName, resultSetConcurToString, resultSetDirToString, resultSetTypeToString, sessionClose, sessionReset, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout, stmtInvoke |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.stc.connector.appconn.db.StatementAgent |
---|
cancel, clearBatch, clearWarnings, executeBatch, getFetchDirection, getFetchSize, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetType, getWarnings, isClosed, queryName, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout, stmtInvoke |
Constructor Detail |
---|
protected Db2CallableStatementAgent()
public Db2CallableStatementAgent(com.stc.connector.db.Session session, java.lang.String sCommand)
session
- a Session object used to hold connection information.sCommand
- a SQL statement for invoking a stored procedure.public Db2CallableStatementAgent(com.stc.connector.db.Session session, int iScroll, int iConcur)
session
- a Session object used to hold connection information.iScroll
- resultset type; TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVEiConcur
- concurrency type; CONCUR_READ_ONLY, CONCUR_UPDATABLEpublic Db2CallableStatementAgent(com.stc.connector.db.Session session, java.lang.String sCommand, int iScroll, int iConcur)
session
- a Session object used to hold connection information.sCommand
- a SQL statement for invoking a stored procedure.iScroll
- resultset type; TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVEiConcur
- concurrency type; CONCUR_READ_ONLY, CONCUR_UPDATABLEMethod Detail |
---|
protected abstract void registerOutParameters() throws java.sql.SQLException
java.sql.SQLException
- which contains information about errors in accessing the database.public void sessionOpen(com.stc.connector.db.SessionEvent evt)
sessionOpen
in interface com.stc.connector.db.SessionEventListener
sessionOpen
in class PreparedStatementAgentImpl
evt
- a Session event which signals the connection is open.public void registerOutParameter(int index, int iType) throws java.sql.SQLException
index
- the position of the parameter.iType
- the JDBC type code defined by java.sql.Types.
java.sql.SQLException
- which contains information about errors in accessing the database.public void registerOutParameter(int index, int iType, int iScale) throws java.sql.SQLException
index
- the position of the parameter.iType
- the JDBC type code defined by java.sql.Types.iScale
- the desired number of digits to the right of the decimal point. It must be >= 0.
java.sql.SQLException
- which contains information about errors in accessing the database.public void registerOutParameter(int index, int iType, java.lang.String sType) throws java.sql.SQLException
index
- the position of the parameter.iType
- the JDBC type code defined by java.sql.Types.sType
- the fully-qualified SQL name of the user-named type.
java.sql.SQLException
- which contains information about errors in accessing the database.public boolean wasNull() throws java.sql.SQLException
java.sql.SQLException
- which contains information about errors in accessing the database.public java.lang.Object getObject(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.lang.Object getObject(int index, java.util.Map map) throws java.sql.SQLException
index
- the position of the parameter.map
- contains the mapping from SQL type names for user-defined types to class.
java.sql.SQLException
- which contains information about errors in accessing the database.public boolean getBoolean(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public byte getByte(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public short getShort(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public int getInt(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public long getLong(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public float getFloat(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public double getDouble(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.math.BigDecimal getBigDecimal(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Date getDate(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Date getDate(int index, java.util.Calendar calendar) throws java.sql.SQLException
index
- the position of the parameter.calendar
- the Calendar object to use to construct the Date object.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Time getTime(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Time getTime(int index, java.util.Calendar calendar) throws java.sql.SQLException
index
- the position of the parameter.calendar
- the Calendar object to use to construct the Time object.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Timestamp getTimestamp(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Timestamp getTimestamp(int index, java.util.Calendar calendar) throws java.sql.SQLException
index
- the position of the parameter.calendar
- the Calendar object to use to construct the Timestamp object.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.lang.String getString(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public byte[] getBytes(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Array getArray(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Blob getBlob(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Clob getClob(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public java.sql.Ref getRef(int index) throws java.sql.SQLException
index
- the position of the parameter.
java.sql.SQLException
- which contains information about errors in accessing the database.public void sessionClosed(com.stc.connector.db.SessionEvent evt)
evt
- a SessionEvent instance.public void clearParameters() throws java.sql.SQLException
clearParameters
in interface com.stc.connector.appconn.db.PreparedStatementAgent
clearParameters
in class PreparedStatementAgentImpl
java.sql.SQLException
- when there are problems in cleaning the parameters.public void setClob(int index, java.lang.Object obj) throws java.sql.SQLException
index
- index of the parameterobj
- the object value the parameter will be set with
java.sql.SQLException
- when there are problems in setting the CLOB value.public void setResultSetParamsPosition(int[] newResultSetParamsPosition)
public int[] getResultSetParamsPosition()
public java.lang.String getSig(java.sql.ResultSet rs)
protected void setResultSetsObjects(Db2CallableStatementResultSet[] newResultSetsObjects)
protected Db2CallableStatementResultSet[] getResultSetsObjects()
protected void setResultSetTypes(java.lang.Class[] resultSetTypes)
protected java.lang.Class[] getResultSetTypes()
public boolean execute() throws java.sql.SQLException
execute
in interface com.stc.connector.appconn.db.PreparedStatementAgent
execute
in class PreparedStatementAgentImpl
java.sql.SQLException
- when SQL problems occur.public int getUpdateCount() throws java.sql.SQLException
PreparedStatementAgentImpl
getUpdateCount
in interface com.stc.connector.appconn.db.PreparedStatementAgent
getUpdateCount
in interface com.stc.connector.appconn.db.StatementAgent
getUpdateCount
in class PreparedStatementAgentImpl
java.sql.SQLException
- when SQL problems occur.public boolean resultsAvailable() throws java.sql.SQLException
Db2PreparedStatementAgent
resultsAvailable
in interface com.stc.connector.appconn.db.PreparedStatementAgent
resultsAvailable
in class Db2PreparedStatementAgent
true
if Update Counts and/or Result Sets are available.
java.sql.SQLException
- when SQL problems occur. when SQL problems occur.protected void setCurRS(java.sql.ResultSet val)
val
- public java.sql.ResultSet getCurRS()
|
Sun Adapter for DB2 Universal Database | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |