com.metamatrix.jdbc
Class MMCallableStatement

java.lang.Object
  extended by com.metamatrix.jdbc.WrapperImpl
      extended by com.metamatrix.jdbc.MMStatement
          extended by com.metamatrix.jdbc.MMPreparedStatement
              extended by com.metamatrix.jdbc.MMCallableStatement
All Implemented Interfaces:
java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement, java.sql.Wrapper

public class MMCallableStatement
extends MMPreparedStatement
implements java.sql.CallableStatement

This class inherits Statement methods, which deal with SQL statements in general and also inherits PreparedStatement methods, which deal with IN parameters. This object provides a way to call stored procedures in MetaMatrix. This call is written in an escape syntax that may take one of two forms: one form with result parameter, and the other without one. A result parameter, a kind of OUT parameter is the return value for the stored procedure. Both forms may have a variable number of parameters used for input(IN parameters), output(OUT parameters), or both (INOUT parameters).

The methods in this class can be used to retrieve values of OUT parameters or the output aspect of INOUT parameters.


Field Summary
 
Fields inherited from class com.metamatrix.jdbc.MMPreparedStatement
batchParameterList, prepareSql
 
Fields inherited from class com.metamatrix.jdbc.MMStatement
CANCELLED, commandStatus, currentRequestID, NO_TIMEOUT, outParamIndexMap, queryTimeout, resultSet, TIMED_OUT, updateCounts
 
Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
 
Method Summary
 void close()
          In many cases, it is desirable to immediately release a Statements's database and JDBC resources instead of waiting for this to happen when it is automatically closed; the close method provides this immediate release.
protected  RequestMessage createRequestMessage(java.lang.String[] commands, boolean isBatchedCommand, java.lang.Boolean requiresResultSet)
           
 java.sql.Array getArray(int parameterIndex)
           
 java.sql.Array getArray(java.lang.String parameterName)
           
 java.math.BigDecimal getBigDecimal(int parameterIndex)
          Gets the value of a OUTPUT parameter as a java.math.BigDecimal object.
 java.math.BigDecimal getBigDecimal(int parameterIndex, int scale)
          Deprecated.  
 java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
           
 java.sql.Blob getBlob(int parameterIndex)
          Gets the value of a OUTPUT parameter as a java.sql.Blob object.
 java.sql.Blob getBlob(java.lang.String parameterName)
           
 boolean getBoolean(int parameterIndex)
          Gets the value of a OUTPUT parameter as a boolean.
 boolean getBoolean(java.lang.String parameterName)
           
 byte getByte(int parameterIndex)
          Gets the value of a OUTPUT parameter as a byte.
 byte getByte(java.lang.String parameterName)
           
 byte[] getBytes(int parameterIndex)
           
 byte[] getBytes(java.lang.String parameterName)
           
 java.io.Reader getCharacterStream(int parameterIndex)
           
 java.io.Reader getCharacterStream(java.lang.String parameterName)
           
 java.sql.Clob getClob(int parameterIndex)
          Gets the value of a OUTPUT parameter as a java.sql.Clob object.
 java.sql.Clob getClob(java.lang.String parameterName)
           
 java.sql.Date getDate(int parameterIndex)
          Gets the value of a OUTPUT parameter as a java.sql.Date object.
 java.sql.Date getDate(int parameterIndex, java.util.Calendar cal)
          Gets the value of a OUTPUT parameter as a java.sql.Date object.
 java.sql.Date getDate(java.lang.String parameterName)
           
 java.sql.Date getDate(java.lang.String parameterName, java.util.Calendar cal)
           
 double getDouble(int parameterIndex)
          Gets the value of a OUTPUT parameter as a double.
 double getDouble(java.lang.String parameterName)
           
 float getFloat(int parameterIndex)
          Gets the value of a OUTPUT parameter as a float.
 float getFloat(java.lang.String parameterName)
           
 int getInt(int parameterIndex)
          Gets the value of a OUTPUT parameter as a int.
 int getInt(java.lang.String parameterName)
           
 long getLong(int parameterIndex)
          Gets the value of a OUTPUT parameter as a long.
 long getLong(java.lang.String parameterName)
           
 java.io.Reader getNCharacterStream(int parameterIndex)
           
 java.io.Reader getNCharacterStream(java.lang.String parameterName)
           
 java.sql.NClob getNClob(int parameterIndex)
           
 java.sql.NClob getNClob(java.lang.String parameterName)
           
 java.lang.String getNString(int parameterIndex)
           
 java.lang.String getNString(java.lang.String parameterName)
           
 java.lang.Object getObject(int parameterIndex)
          Gets the value of a OUTPUT parameter as an object.
 java.lang.Object getObject(int parameterIndex, java.util.Map<java.lang.String,java.lang.Class<?>> map)
           
 java.lang.Object getObject(java.lang.String parameterName)
           
 java.lang.Object getObject(java.lang.String parameterName, java.util.Map<java.lang.String,java.lang.Class<?>> map)
           
 java.sql.Ref getRef(int parameterIndex)
           
 java.sql.Ref getRef(java.lang.String parameterName)
           
 java.sql.RowId getRowId(int parameterIndex)
           
 java.sql.RowId getRowId(java.lang.String parameterName)
           
 short getShort(int parameterIndex)
          Gets the value of a OUTPUT parameter as a short.
 short getShort(java.lang.String parameterName)
           
 java.sql.SQLXML getSQLXML(int parameterIndex)
           
 java.sql.SQLXML getSQLXML(java.lang.String parameterName)
           
 java.lang.String getString(int parameterIndex)
          Gets the value of a OUTPUT parameter as a String.
 java.lang.String getString(java.lang.String parameterName)
           
 java.sql.Time getTime(int parameterIndex)
          Gets the value of a OUTPUT parameter as a java.sql.Time object.
 java.sql.Time getTime(int parameterIndex, java.util.Calendar cal)
          Gets the value of a OUTPUT parameter as a java.sql.Timestamp object.
 java.sql.Time getTime(java.lang.String parameterName)
           
 java.sql.Time getTime(java.lang.String parameterName, java.util.Calendar cal)
           
 java.sql.Timestamp getTimestamp(int parameterIndex)
          Gets the value of a OUTPUT parameter as a java.sql.Timestamp object.
 java.sql.Timestamp getTimestamp(int parameterIndex, java.util.Calendar cal)
          Gets the value of a OUTPUT parameter as a java.sql.Timestamp object.
 java.sql.Timestamp getTimestamp(java.lang.String parameterName)
           
 java.sql.Timestamp getTimestamp(java.lang.String parameterName, java.util.Calendar cal)
           
 java.net.URL getURL(int parameterIndex)
           
 java.net.URL getURL(java.lang.String parameterName)
           
 void registerOutParameter(int parameterIndex, int jdbcSqlType)
          Register the OUT parameter in the ordinal position parameterIndex to jdbcsql type.
 void registerOutParameter(int parameterIndex, int jdbcSqlType, int scale)
          Register the OUT parameter in the ordinal position parameterIndex to jdbcsql type.
 void registerOutParameter(int parameterIndex, int jdbcSqlType, java.lang.String typeName)
          Register the OUT parameter in the ordinal position parameterIndex to jdbcsql type.
 void registerOutParameter(java.lang.String parameterName, int sqlType)
           
 void registerOutParameter(java.lang.String parameterName, int sqlType, int scale)
           
 void registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName)
           
 void setAsciiStream(java.lang.String parameterName, java.io.InputStream x)
           
 void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length)
           
 void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, long length)
           
 void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)
           
 void setBinaryStream(java.lang.String parameterName, java.io.InputStream x)
           
 void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length)
           
 void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, long length)
           
 void setBlob(java.lang.String parameterName, java.sql.Blob x)
           
 void setBlob(java.lang.String parameterName, java.io.InputStream inputStream)
           
 void setBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length)
           
 void setBoolean(java.lang.String parameterName, boolean x)
           
 void setByte(java.lang.String parameterName, byte x)
           
 void setBytes(java.lang.String parameterName, byte[] x)
           
 void setCharacterStream(java.lang.String parameterName, java.io.Reader reader)
           
 void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length)
           
 void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, long length)
           
 void setClob(java.lang.String parameterName, java.sql.Clob x)
           
 void setClob(java.lang.String parameterName, java.io.Reader reader)
           
 void setClob(java.lang.String parameterName, java.io.Reader reader, long length)
           
 void setDate(java.lang.String parameterName, java.sql.Date x)
           
 void setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)
           
 void setDouble(java.lang.String parameterName, double x)
           
 void setFloat(java.lang.String parameterName, float x)
           
 void setInt(java.lang.String parameterName, int x)
           
 void setLong(java.lang.String parameterName, long x)
           
 void setNCharacterStream(java.lang.String parameterName, java.io.Reader value)
           
 void setNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length)
           
 void setNClob(java.lang.String parameterName, java.sql.NClob value)
           
 void setNClob(java.lang.String parameterName, java.io.Reader reader)
           
 void setNClob(java.lang.String parameterName, java.io.Reader reader, long length)
           
 void setNString(java.lang.String parameterName, java.lang.String value)
           
 void setNull(java.lang.String parameterName, int sqlType)
           
 void setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)
           
 void setObject(java.lang.String parameterName, java.lang.Object x)
           
 void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType)
           
 void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)
           
 void setRowId(java.lang.String parameterName, java.sql.RowId x)
           
 void setShort(java.lang.String parameterName, short x)
           
 void setSQLXML(java.lang.String parameterName, java.sql.SQLXML xmlObject)
           
 void setString(java.lang.String parameterName, java.lang.String x)
           
 void setTime(java.lang.String parameterName, java.sql.Time x)
           
 void setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal)
           
 void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x)
           
 void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal)
           
 void setURL(java.lang.String parameterName, java.net.URL val)
           
 boolean wasNull()
          Indicates whether the last OUT parameter read was a return null.
 
Methods inherited from class com.metamatrix.jdbc.MMPreparedStatement
addBatch, addBatch, clearBatch, clearParameters, execute, execute, executeBatch, executeQuery, executeQuery, executeUpdate, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
 
Methods inherited from class com.metamatrix.jdbc.MMStatement
accumulateWarnings, attachStylesheet, cancel, cancelRequest, checkStatement, clearStylesheet, clearWarnings, copyPropertiesToRequest, createResultSet, execute, execute, execute, executeSql, executeUpdate, executeUpdate, executeUpdate, getAnnotations, getConnection, getConnectionProperties, getDebugLog, getDQP, getExecutionProperty, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMMConnection, getMoreResults, getMoreResults, getPlanDescription, getQueryTimeout, getRequestIdentifier, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getServerTimeZone, getUpdateCount, getWarnings, hasResultSet, isClosed, isPoolable, resetExecutionState, sendRequestMessageAndWait, setAnalysisInfo, setCursorName, setEscapeProcessing, setExecutionProperty, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPartialResults, setPayload, setPoolable, setQueryTimeout, timeoutOccurred
 
Methods inherited from class com.metamatrix.jdbc.WrapperImpl
isWrapperFor, unwrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
 
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 

Method Detail

createRequestMessage

protected RequestMessage createRequestMessage(java.lang.String[] commands,
                                              boolean isBatchedCommand,
                                              java.lang.Boolean requiresResultSet)
Overrides:
createRequestMessage in class MMPreparedStatement

close

public void close()
           throws java.sql.SQLException
In many cases, it is desirable to immediately release a Statements's database and JDBC resources instead of waiting for this to happen when it is automatically closed; the close method provides this immediate release.

Specified by:
close in interface java.sql.Statement
Overrides:
close in class MMStatement
Throws:
java.sql.SQLException - should never occur.

getBigDecimal

public java.math.BigDecimal getBigDecimal(int parameterIndex,
                                          int scale)
                                   throws java.sql.SQLException
Deprecated. 

Gets the value of a OUTPUT parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

Specified by:
getBigDecimal in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as an BigDecimal object.
Throws:
java.sql.SQLException - if param datatype is not NUMERIC

getBigDecimal

public java.math.BigDecimal getBigDecimal(int parameterIndex)
                                   throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.math.BigDecimal object.

Specified by:
getBigDecimal in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as an BigDecimal object.
Throws:
java.sql.SQLException - if param datatype is not NUMERIC

getBlob

public java.sql.Blob getBlob(int parameterIndex)
                      throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Blob object.

Specified by:
getBlob in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a Blob object.
Throws:
java.sql.SQLException

getBoolean

public boolean getBoolean(int parameterIndex)
                   throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a boolean.

Specified by:
getBoolean in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a boolean value.
Throws:
java.sql.SQLException - if param datatype is not BIT

getByte

public byte getByte(int parameterIndex)
             throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a byte.

Specified by:
getByte in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a byte value.
Throws:
java.sql.SQLException - if param datatype is not TINYINT

getClob

public java.sql.Clob getClob(int parameterIndex)
                      throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Clob object.

Specified by:
getClob in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a Clob object.
Throws:
java.sql.SQLException

getDate

public java.sql.Date getDate(int parameterIndex)
                      throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Date object.

Specified by:
getDate in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a Date object.
Throws:
java.sql.SQLException - if param datatype is not DATE

getDate

public java.sql.Date getDate(int parameterIndex,
                             java.util.Calendar cal)
                      throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Date object. Calender object contains the timezone info for the Date.

Specified by:
getDate in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Calendar - object used to construct the Date object.
Returns:
The parameter at the given index is returned as a Date object.
Throws:
java.sql.SQLException - if param datatype is not DATE

getDouble

public double getDouble(int parameterIndex)
                 throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a double.

Specified by:
getDouble in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a double value.
Throws:
java.sql.SQLException - if param datatype is not DOUBLE or FLOAT

getFloat

public float getFloat(int parameterIndex)
               throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a float.

Specified by:
getFloat in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a float value.
Throws:
java.sql.SQLException - if param datatype is not FLOAT

getInt

public int getInt(int parameterIndex)
           throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a int.

Specified by:
getInt in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a int value.
Throws:
java.sql.SQLException - if param datatype is not INTEGER

getLong

public long getLong(int parameterIndex)
             throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a long.

Specified by:
getLong in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a long value.
Throws:
java.sql.SQLException - if param datatype is not BIGINT

getObject

public java.lang.Object getObject(int parameterIndex)
                           throws java.sql.SQLException

Gets the value of a OUTPUT parameter as an object.

Specified by:
getObject in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as an object.
Throws:
java.sql.SQLException

getShort

public short getShort(int parameterIndex)
               throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a short.

Specified by:
getShort in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a short value.
Throws:
java.sql.SQLException - if param datatype is not SMALLINT

getString

public java.lang.String getString(int parameterIndex)
                           throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a String.

Specified by:
getString in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a String object.
Throws:
java.sql.SQLException - if param datatype is not CHAR, VARCHAR, LONGVARCHAR

getTime

public java.sql.Time getTime(int parameterIndex)
                      throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Time object.

Specified by:
getTime in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a Time object.
Throws:
java.sql.SQLException - if param datatype is not TIME

getTime

public java.sql.Time getTime(int parameterIndex,
                             java.util.Calendar cal)
                      throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Timestamp object. Calendar object contains the timezone information.

Specified by:
getTime in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Calendar - object used to construct the Date object.
Returns:
The parameter at the given index is returned as a Time object.
Throws:
java.sql.SQLException - if param datatype is not TIME

getTimestamp

public java.sql.Timestamp getTimestamp(int parameterIndex)
                                throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Timestamp object.

Specified by:
getTimestamp in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Returns:
The parameter at the given index is returned as a Timestamp object.
Throws:
java.sql.SQLException - if param datatype is not TIMESTAMP

getTimestamp

public java.sql.Timestamp getTimestamp(int parameterIndex,
                                       java.util.Calendar cal)
                                throws java.sql.SQLException

Gets the value of a OUTPUT parameter as a java.sql.Timestamp object. Calendar object contains the timezone information.

Specified by:
getTimestamp in interface java.sql.CallableStatement
Parameters:
parameterIndex - whose value is to be fetched from the result.
Calendar - object used to construct the Date object.
Returns:
The parameter at the given index is returned as a Timestamp object.
Throws:
java.sql.SQLException - if param datatype is not TIMESTAMP

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int jdbcSqlType)
                          throws java.sql.SQLException

Register the OUT parameter in the ordinal position parameterIndex to jdbcsql type. Scale is used by setXXX methods to determine number of decimals.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
Parameters:
parameterIndex. - Index of the OUT parameter in the stored procedure.
jdbcSqlType. - SQL type codes from java.sql.Types
SQLException, - should never occur
Throws:
java.sql.SQLException

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int jdbcSqlType,
                                 int scale)
                          throws java.sql.SQLException

Register the OUT parameter in the ordinal position parameterIndex to jdbcsql type. Scale is used by setXXX methods to determine number of decimals.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
Parameters:
parameterIndex. - Index of the OUT parameter in the stored procedure.
jdbcSqlType. - SQL type codes from java.sql.Types
scale. - The number of decimal digits on the OUT param.
SQLException, - should never occur
Throws:
java.sql.SQLException

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int jdbcSqlType,
                                 java.lang.String typeName)
                          throws java.sql.SQLException

Register the OUT parameter in the ordinal position parameterIndex to jdbcsql type. The param typename(SQL name for user-named type) is ignored as SQL3 datatypes are not supported.

Specified by:
registerOutParameter in interface java.sql.CallableStatement
Parameters:
parameterIndex. - Index of the OUT parameter in the stored procedure.
jdbcSqlType. - SQL type codes from java.sql.Types
typeName. - SQL name of user-named type being used
SQLException, - should never occur
Throws:
java.sql.SQLException

wasNull

public boolean wasNull()
                throws java.sql.SQLException

Indicates whether the last OUT parameter read was a return null.

Specified by:
wasNull in interface java.sql.CallableStatement
Returns:
true if the last param read was null else false.
Throws:
SQLException, - if the statement is already closed.
java.sql.SQLException

getSQLXML

public java.sql.SQLXML getSQLXML(int parameterIndex)
                          throws java.sql.SQLException
Specified by:
getSQLXML in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getArray

public java.sql.Array getArray(int parameterIndex)
                        throws java.sql.SQLException
Specified by:
getArray in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getArray

public java.sql.Array getArray(java.lang.String parameterName)
                        throws java.sql.SQLException
Specified by:
getArray in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
                                   throws java.sql.SQLException
Specified by:
getBigDecimal in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getBlob

public java.sql.Blob getBlob(java.lang.String parameterName)
                      throws java.sql.SQLException
Specified by:
getBlob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getBoolean

public boolean getBoolean(java.lang.String parameterName)
                   throws java.sql.SQLException
Specified by:
getBoolean in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getByte

public byte getByte(java.lang.String parameterName)
             throws java.sql.SQLException
Specified by:
getByte in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getBytes

public byte[] getBytes(int parameterIndex)
                throws java.sql.SQLException
Specified by:
getBytes in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getBytes

public byte[] getBytes(java.lang.String parameterName)
                throws java.sql.SQLException
Specified by:
getBytes in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getCharacterStream

public java.io.Reader getCharacterStream(int parameterIndex)
                                  throws java.sql.SQLException
Specified by:
getCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getCharacterStream

public java.io.Reader getCharacterStream(java.lang.String parameterName)
                                  throws java.sql.SQLException
Specified by:
getCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getClob

public java.sql.Clob getClob(java.lang.String parameterName)
                      throws java.sql.SQLException
Specified by:
getClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getDate

public java.sql.Date getDate(java.lang.String parameterName)
                      throws java.sql.SQLException
Specified by:
getDate in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getDate

public java.sql.Date getDate(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.SQLException
Specified by:
getDate in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getDouble

public double getDouble(java.lang.String parameterName)
                 throws java.sql.SQLException
Specified by:
getDouble in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getFloat

public float getFloat(java.lang.String parameterName)
               throws java.sql.SQLException
Specified by:
getFloat in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getInt

public int getInt(java.lang.String parameterName)
           throws java.sql.SQLException
Specified by:
getInt in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getLong

public long getLong(java.lang.String parameterName)
             throws java.sql.SQLException
Specified by:
getLong in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getNCharacterStream

public java.io.Reader getNCharacterStream(int parameterIndex)
                                   throws java.sql.SQLException
Specified by:
getNCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getNCharacterStream

public java.io.Reader getNCharacterStream(java.lang.String parameterName)
                                   throws java.sql.SQLException
Specified by:
getNCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getNClob

public java.sql.NClob getNClob(int parameterIndex)
                        throws java.sql.SQLException
Specified by:
getNClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getNClob

public java.sql.NClob getNClob(java.lang.String parameterName)
                        throws java.sql.SQLException
Specified by:
getNClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getNString

public java.lang.String getNString(int parameterIndex)
                            throws java.sql.SQLException
Specified by:
getNString in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getNString

public java.lang.String getNString(java.lang.String parameterName)
                            throws java.sql.SQLException
Specified by:
getNString in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getObject

public java.lang.Object getObject(java.lang.String parameterName)
                           throws java.sql.SQLException
Specified by:
getObject in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getObject

public java.lang.Object getObject(int parameterIndex,
                                  java.util.Map<java.lang.String,java.lang.Class<?>> map)
                           throws java.sql.SQLException
Specified by:
getObject in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getObject

public java.lang.Object getObject(java.lang.String parameterName,
                                  java.util.Map<java.lang.String,java.lang.Class<?>> map)
                           throws java.sql.SQLException
Specified by:
getObject in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getRef

public java.sql.Ref getRef(int parameterIndex)
                    throws java.sql.SQLException
Specified by:
getRef in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getRef

public java.sql.Ref getRef(java.lang.String parameterName)
                    throws java.sql.SQLException
Specified by:
getRef in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getRowId

public java.sql.RowId getRowId(int parameterIndex)
                        throws java.sql.SQLException
Specified by:
getRowId in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getRowId

public java.sql.RowId getRowId(java.lang.String parameterName)
                        throws java.sql.SQLException
Specified by:
getRowId in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getSQLXML

public java.sql.SQLXML getSQLXML(java.lang.String parameterName)
                          throws java.sql.SQLException
Specified by:
getSQLXML in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getShort

public short getShort(java.lang.String parameterName)
               throws java.sql.SQLException
Specified by:
getShort in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getString

public java.lang.String getString(java.lang.String parameterName)
                           throws java.sql.SQLException
Specified by:
getString in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getTime

public java.sql.Time getTime(java.lang.String parameterName)
                      throws java.sql.SQLException
Specified by:
getTime in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getTime

public java.sql.Time getTime(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.SQLException
Specified by:
getTime in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName)
                                throws java.sql.SQLException
Specified by:
getTimestamp in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName,
                                       java.util.Calendar cal)
                                throws java.sql.SQLException
Specified by:
getTimestamp in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getURL

public java.net.URL getURL(int parameterIndex)
                    throws java.sql.SQLException
Specified by:
getURL in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

getURL

public java.net.URL getURL(java.lang.String parameterName)
                    throws java.sql.SQLException
Specified by:
getURL in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType)
                          throws java.sql.SQLException
Specified by:
registerOutParameter in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 int scale)
                          throws java.sql.SQLException
Specified by:
registerOutParameter in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 java.lang.String typeName)
                          throws java.sql.SQLException
Specified by:
registerOutParameter in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x)
                    throws java.sql.SQLException
Specified by:
setAsciiStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException
Specified by:
setAsciiStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x,
                           long length)
                    throws java.sql.SQLException
Specified by:
setAsciiStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBigDecimal

public void setBigDecimal(java.lang.String parameterName,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException
Specified by:
setBigDecimal in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x)
                     throws java.sql.SQLException
Specified by:
setBinaryStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException
Specified by:
setBinaryStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x,
                            long length)
                     throws java.sql.SQLException
Specified by:
setBinaryStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBlob

public void setBlob(java.lang.String parameterName,
                    java.sql.Blob x)
             throws java.sql.SQLException
Specified by:
setBlob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBlob

public void setBlob(java.lang.String parameterName,
                    java.io.InputStream inputStream)
             throws java.sql.SQLException
Specified by:
setBlob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBlob

public void setBlob(java.lang.String parameterName,
                    java.io.InputStream inputStream,
                    long length)
             throws java.sql.SQLException
Specified by:
setBlob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBoolean

public void setBoolean(java.lang.String parameterName,
                       boolean x)
                throws java.sql.SQLException
Specified by:
setBoolean in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setByte

public void setByte(java.lang.String parameterName,
                    byte x)
             throws java.sql.SQLException
Specified by:
setByte in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setBytes

public void setBytes(java.lang.String parameterName,
                     byte[] x)
              throws java.sql.SQLException
Specified by:
setBytes in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setCharacterStream

public void setCharacterStream(java.lang.String parameterName,
                               java.io.Reader reader)
                        throws java.sql.SQLException
Specified by:
setCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setCharacterStream

public void setCharacterStream(java.lang.String parameterName,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException
Specified by:
setCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setCharacterStream

public void setCharacterStream(java.lang.String parameterName,
                               java.io.Reader reader,
                               long length)
                        throws java.sql.SQLException
Specified by:
setCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setClob

public void setClob(java.lang.String parameterName,
                    java.sql.Clob x)
             throws java.sql.SQLException
Specified by:
setClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setClob

public void setClob(java.lang.String parameterName,
                    java.io.Reader reader)
             throws java.sql.SQLException
Specified by:
setClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setClob

public void setClob(java.lang.String parameterName,
                    java.io.Reader reader,
                    long length)
             throws java.sql.SQLException
Specified by:
setClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x)
             throws java.sql.SQLException
Specified by:
setDate in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.SQLException
Specified by:
setDate in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setDouble

public void setDouble(java.lang.String parameterName,
                      double x)
               throws java.sql.SQLException
Specified by:
setDouble in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setFloat

public void setFloat(java.lang.String parameterName,
                     float x)
              throws java.sql.SQLException
Specified by:
setFloat in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setInt

public void setInt(java.lang.String parameterName,
                   int x)
            throws java.sql.SQLException
Specified by:
setInt in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setLong

public void setLong(java.lang.String parameterName,
                    long x)
             throws java.sql.SQLException
Specified by:
setLong in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNCharacterStream

public void setNCharacterStream(java.lang.String parameterName,
                                java.io.Reader value)
                         throws java.sql.SQLException
Specified by:
setNCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNCharacterStream

public void setNCharacterStream(java.lang.String parameterName,
                                java.io.Reader value,
                                long length)
                         throws java.sql.SQLException
Specified by:
setNCharacterStream in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNClob

public void setNClob(java.lang.String parameterName,
                     java.sql.NClob value)
              throws java.sql.SQLException
Specified by:
setNClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNClob

public void setNClob(java.lang.String parameterName,
                     java.io.Reader reader)
              throws java.sql.SQLException
Specified by:
setNClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNClob

public void setNClob(java.lang.String parameterName,
                     java.io.Reader reader,
                     long length)
              throws java.sql.SQLException
Specified by:
setNClob in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNString

public void setNString(java.lang.String parameterName,
                       java.lang.String value)
                throws java.sql.SQLException
Specified by:
setNString in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType)
             throws java.sql.SQLException
Specified by:
setNull in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.SQLException
Specified by:
setNull in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x)
               throws java.sql.SQLException
Specified by:
setObject in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException
Specified by:
setObject in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException
Specified by:
setObject in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setRowId

public void setRowId(java.lang.String parameterName,
                     java.sql.RowId x)
              throws java.sql.SQLException
Specified by:
setRowId in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setSQLXML

public void setSQLXML(java.lang.String parameterName,
                      java.sql.SQLXML xmlObject)
               throws java.sql.SQLException
Specified by:
setSQLXML in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setShort

public void setShort(java.lang.String parameterName,
                     short x)
              throws java.sql.SQLException
Specified by:
setShort in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setString

public void setString(java.lang.String parameterName,
                      java.lang.String x)
               throws java.sql.SQLException
Specified by:
setString in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x)
             throws java.sql.SQLException
Specified by:
setTime in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException
Specified by:
setTime in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x)
                  throws java.sql.SQLException
Specified by:
setTimestamp in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException
Specified by:
setTimestamp in interface java.sql.CallableStatement
Throws:
java.sql.SQLException

setURL

public void setURL(java.lang.String parameterName,
                   java.net.URL val)
            throws java.sql.SQLException
Specified by:
setURL in interface java.sql.CallableStatement
Throws:
java.sql.SQLException


Copyright © 2009. All Rights Reserved.