- java.lang.Object
-
- org.hsqldb.jdbc.JDBCPreparedStatement
-
- org.hsqldb.jdbc.JDBCCallableStatement
-
- All Implemented Interfaces:
java.lang.AutoCloseable,java.sql.CallableStatement,java.sql.PreparedStatement,java.sql.Statement,java.sql.Wrapper
public class JDBCCallableStatement extends JDBCPreparedStatement implements java.sql.CallableStatement
The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.{?= call <procedure-name>[(<arg1>,<arg2>, ...)]} {call <procedure-name>[(<arg1>,<arg2>, ...)]}IN parameter values are set using the
setmethods inherited fromPreparedStatement. The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via thegetmethods provided here.A
CallableStatementcan return oneResultSetobject or multipleResultSetobjects. MultipleResultSetobjects are handled using operations inherited fromStatement.For maximum portability, a call's
ResultSetobjects and update counts should be processed prior to getting the values of output parameters.HSQLDB-Specific Information:
Beyond the XOpen/ODBC extended scalar functions, stored procedures are typically supported in ways that vary greatly from one DBMS implementation to the next. So, it is almost guaranteed that the code for a stored procedure written under a specific DBMS product will not work without at least some modification in the context of another vendor's product or even across a single vendor's product lines. Moving stored procedures from one DBMS product line to another almost invariably involves complex porting issues and often may not be possible at all. Be warned.One kind of HSQLDB stored procedures and functions is SQL/JRT, Java routines that map directly onto the static methods of compiled Java classes found on the class path of the engine at runtime. The CREATE PROCEDURE or CREATE FUNCTION statements are used in SQL to support the Java methods.
The other kind of HSQLDB stored procedures is SQL/PSM routines that are written entirely in the SQL procedural language. Overloaded methods are supported and resolved according to the type of parameters. With procedures,
OUTandIN OUTparameters are also supported.In addition, HSQLDB stored procedure call mechanism allows the more general HSQLDB SQL expression evaluation mechanism. This extension provides the ability to evaluate simple SQL expressions, possibly containing Java method invocations.
With HSQLDB, executing a
CALLstatement that produces an opaque (OTHER) or known scalar object reference has virtually the same effect as:CREATE TABLE DUAL (dummy VARCHAR); INSERT INTO DUAL VALUES(NULL); SELECT <simple-expression> FROM DUAL;
HSQLDB functions can return a single result set. HSQLDB procedures can return one or more result sets. Here is a very simple example of an HSQLDB stored procedure generating a user-defined result set:package mypackage; import java.sql.ResultSet; import java.sql.SQLException; class MyLibraryClass { public static ResultSet mySp() throws SQLException { return ctx.getConnection().createStatement().executeQuery("select * from my_table"); } }
(campbell-burnet@users)- Since:
- JDK 1.1, HSQLDB 1.9.0
- Author:
- Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
- See Also:
JDBCConnection.prepareCall(java.lang.String),JDBCResultSet
-
-
Constructor Summary
Constructors Constructor Description JDBCCallableStatement(JDBCConnection c, java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)Constructs a new JDBCCallableStatement with the specified connection and result type.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidclose()Does the specialized work required to free this object's resources and that of its parent classes.voidcloseOnCompletion()Specifies that thisStatementwill be closed when all its dependent result sets are closed.java.sql.ResultSetexecuteQuery()Executes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.java.sql.ArraygetArray(int parameterIndex)Retrieves the value of the designated JDBCARRAYparameter as anArrayobject in the Java programming language.java.sql.ArraygetArray(java.lang.String parameterName)Retrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language.java.math.BigDecimalgetBigDecimal(int parameterIndex)Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.java.math.BigDecimalgetBigDecimal(int parameterIndex, int scale)Deprecated.usegetBigDecimal(int parameterIndex)orgetBigDecimal(String parameterName)java.math.BigDecimalgetBigDecimal(java.lang.String parameterName)Retrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.java.sql.BlobgetBlob(int parameterIndex)Retrieves the value of the designated JDBCBLOBparameter as aBlobobject in the Java programming language.java.sql.BlobgetBlob(java.lang.String parameterName)Retrieves the value of a JDBCBLOBparameter as aBlobobject in the Java programming language.booleangetBoolean(int parameterIndex)Retrieves the value of the designated JDBCBITorBOOLEANparameter as abooleanin the Java programming language.booleangetBoolean(java.lang.String parameterName)Retrieves the value of a JDBCBITorBOOLEANparameter as abooleanin the Java programming language.bytegetByte(int parameterIndex)Retrieves the value of the designated JDBCTINYINTparameter as abytein the Java programming language.bytegetByte(java.lang.String parameterName)Retrieves the value of a JDBCTINYINTparameter as abytein the Java programming language.byte[]getBytes(int parameterIndex)Retrieves the value of the designated JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.byte[]getBytes(java.lang.String parameterName)Retrieves the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.java.io.ReadergetCharacterStream(int parameterIndex)Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.java.io.ReadergetCharacterStream(java.lang.String parameterName)Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.java.sql.ClobgetClob(int parameterIndex)Retrieves the value of the designated JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language.java.sql.ClobgetClob(java.lang.String parameterName)Retrieves the value of a JDBCCLOBparameter as aClobobject in the Java programming language.java.sql.DategetDate(int parameterIndex)Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject.java.sql.DategetDate(int parameterIndex, java.util.Calendar cal)Retrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date.java.sql.DategetDate(java.lang.String parameterName)Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject.java.sql.DategetDate(java.lang.String parameterName, java.util.Calendar cal)Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date.doublegetDouble(int parameterIndex)Retrieves the value of the designated JDBCDOUBLEparameter as adoublein the Java programming language.doublegetDouble(java.lang.String parameterName)Retrieves the value of a JDBCDOUBLEparameter as adoublein the Java programming language.floatgetFloat(int parameterIndex)Retrieves the value of the designated JDBCFLOATparameter as afloatin the Java programming language.floatgetFloat(java.lang.String parameterName)Retrieves the value of a JDBCFLOATparameter as afloatin the Java programming language.intgetInt(int parameterIndex)Retrieves the value of the designated JDBCINTEGERparameter as anintin the Java programming language.intgetInt(java.lang.String parameterName)Retrieves the value of a JDBCINTEGERparameter as anintin the Java programming language.longgetLong(int parameterIndex)Retrieves the value of the designated JDBCBIGINTparameter as alongin the Java programming language.longgetLong(java.lang.String parameterName)Retrieves the value of a JDBCBIGINTparameter as alongin the Java programming language.java.io.ReadergetNCharacterStream(int parameterIndex)Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.java.io.ReadergetNCharacterStream(java.lang.String parameterName)Retrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.java.sql.NClobgetNClob(int parameterIndex)Retrieves the value of the designated JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.java.sql.NClobgetNClob(java.lang.String parameterName)Retrieves the value of a JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.java.lang.StringgetNString(int parameterIndex)Retrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.java.lang.StringgetNString(java.lang.String parameterName)Retrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.java.lang.ObjectgetObject(int parameterIndex)Retrieves the value of the designated parameter as anObjectin the Java programming language.<T> TgetObject(int parameterIndex, java.lang.Class<T> type)Returns an object representing the value of OUT parameterparameterIndexand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported.java.lang.ObjectgetObject(int parameterIndex, java.util.Map<java.lang.String,java.lang.Class<?>> map)Returns an object representing the value of OUT parameterparameterIndexand usesmapfor the custom mapping of the parameter value.java.lang.ObjectgetObject(java.lang.String parameterName)Retrieves the value of a parameter as anObjectin the Java programming language.<T> TgetObject(java.lang.String parameterName, java.lang.Class<T> type)Returns an object representing the value of OUT parameterparameterNameand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported.java.lang.ObjectgetObject(java.lang.String parameterName, java.util.Map<java.lang.String,java.lang.Class<?>> map)Returns an object representing the value of OUT parameterparameterNameand usesmapfor the custom mapping of the parameter value.java.sql.RefgetRef(int parameterIndex)Retrieves the value of the designated JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.java.sql.RefgetRef(java.lang.String parameterName)Retrieves the value of a JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.java.sql.ResultSetgetResultSet()Retrieves the current result as aResultSetobject.java.sql.RowIdgetRowId(int parameterIndex)Retrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.java.sql.RowIdgetRowId(java.lang.String parameterName)Retrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.shortgetShort(int parameterIndex)Retrieves the value of the designated JDBCSMALLINTparameter as ashortin the Java programming language.shortgetShort(java.lang.String parameterName)Retrieves the value of a JDBCSMALLINTparameter as ashortin the Java programming language.java.sql.SQLXMLgetSQLXML(int parameterIndex)Retrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.java.sql.SQLXMLgetSQLXML(java.lang.String parameterName)Retrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.java.lang.StringgetString(int parameterIndex)Retrieves the value of the designated JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.java.lang.StringgetString(java.lang.String parameterName)Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.java.sql.TimegetTime(int parameterIndex)Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject.java.sql.TimegetTime(int parameterIndex, java.util.Calendar cal)Retrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time.java.sql.TimegetTime(java.lang.String parameterName)Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject.java.sql.TimegetTime(java.lang.String parameterName, java.util.Calendar cal)Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time.java.sql.TimestampgetTimestamp(int parameterIndex)Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.java.sql.TimestampgetTimestamp(int parameterIndex, java.util.Calendar cal)Retrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject.java.sql.TimestampgetTimestamp(java.lang.String parameterName)Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.java.sql.TimestampgetTimestamp(java.lang.String parameterName, java.util.Calendar cal)Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject.java.net.URLgetURL(int parameterIndex)Retrieves the value of the designated JDBCDATALINKparameter as ajava.net.URLobject.java.net.URLgetURL(java.lang.String parameterName)Retrieves the value of a JDBCDATALINKparameter as ajava.net.URLobject.booleanisCloseOnCompletion()Returns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.voidregisterOutParameter(int parameterIndex, int sqlType)Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType.voidregisterOutParameter(int parameterIndex, int sqlType, int scale)Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType.voidregisterOutParameter(int parameterIndex, int sqlType, java.lang.String typeName)Registers the designated output parameter.voidregisterOutParameter(int parameterIndex, java.sql.SQLType sqlType)Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType.voidregisterOutParameter(int parameterIndex, java.sql.SQLType sqlType, int scale)Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType.voidregisterOutParameter(int parameterIndex, java.sql.SQLType sqlType, java.lang.String typeName)Registers the designated output parameter.voidregisterOutParameter(java.lang.String parameterName, int sqlType)Registers the OUT parameter namedparameterNameto the JDBC typesqlType.voidregisterOutParameter(java.lang.String parameterName, int sqlType, int scale)Registers the parameter namedparameterNameto be of JDBC typesqlType.voidregisterOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName)Registers the designated output parameter.voidregisterOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType)Registers the OUT parameter namedparameterNameto the JDBC typesqlType.voidregisterOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, int scale)Registers the parameter namedparameterNameto be of JDBC typesqlType.voidregisterOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, java.lang.String typeName)Registers the designated output parameter.voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x)Sets the designated parameter to the given input stream.voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x, long length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x)Sets the designated parameter to the given input stream.voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x, long length)Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBlob(java.lang.String parameterName, java.io.InputStream inputStream)Sets the designated parameter to anInputStreamobject.voidsetBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length)Sets the designated parameter to aInputStreamobject.voidsetBlob(java.lang.String parameterName, java.sql.Blob x)Sets the designated parameter to the givenjava.sql.Blobobject.voidsetBoolean(java.lang.String parameterName, boolean x)Sets the designated parameter to the given Javabooleanvalue.voidsetByte(java.lang.String parameterName, byte x)Sets the designated parameter to the given Javabytevalue.voidsetBytes(java.lang.String parameterName, byte[] x)Sets the designated parameter to the given Java array of bytes.voidsetCharacterStream(java.lang.String parameterName, java.io.Reader reader)Sets the designated parameter to the givenReaderobject.voidsetCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length)Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(java.lang.String parameterName, java.io.Reader reader, long length)Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetClob(java.lang.String parameterName, java.io.Reader reader)Sets the designated parameter to aReaderobject.voidsetClob(java.lang.String parameterName, java.io.Reader reader, long length)Sets the designated parameter to aReaderobject.voidsetClob(java.lang.String parameterName, java.sql.Clob x)Sets the designated parameter to the givenjava.sql.Clobobject.voidsetDate(java.lang.String parameterName, java.sql.Date x)Sets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application.voidsetDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDouble(java.lang.String parameterName, double x)Sets the designated parameter to the given Javadoublevalue.voidsetFloat(java.lang.String parameterName, float x)Sets the designated parameter to the given Javafloatvalue.voidsetInt(java.lang.String parameterName, int x)Sets the designated parameter to the given Javaintvalue.voidsetLong(java.lang.String parameterName, long x)Sets the designated parameter to the given Javalongvalue.voidsetNCharacterStream(java.lang.String parameterName, java.io.Reader value)Sets the designated parameter to aReaderobject.voidsetNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length)Sets the designated parameter to aReaderobject.voidsetNClob(java.lang.String parameterName, java.io.Reader reader)Sets the designated parameter to aReaderobject.voidsetNClob(java.lang.String parameterName, java.io.Reader reader, long length)Sets the designated parameter to aReaderobject.voidsetNClob(java.lang.String parameterName, java.sql.NClob value)Sets the designated parameter to ajava.sql.NClobobject.voidsetNString(java.lang.String parameterName, java.lang.String value)Sets the designated parameter to the givenStringobject.voidsetNull(java.lang.String parameterName, int sqlType)Sets the designated parameter to SQLNULL.voidsetNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)Sets the designated parameter to SQLNULL.voidsetObject(java.lang.String parameterName, java.lang.Object x)Sets the value of the designated parameter with the given object.voidsetObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType)Sets the value of the designated parameter with the given object.voidsetObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)Sets the value of the designated parameter with the given object.voidsetObject(java.lang.String parameterName, java.lang.Object x, java.sql.SQLType targetSqlType)Sets the value of the designated parameter with the given object.voidsetObject(java.lang.String parameterName, java.lang.Object x, java.sql.SQLType targetSqlType, int scaleOrLength)Sets the value of the designated parameter with the given object.voidsetRowId(java.lang.String parameterName, java.sql.RowId x)Sets the designated parameter to the givenjava.sql.RowIdobject.voidsetShort(java.lang.String parameterName, short x)Sets the designated parameter to the given Javashortvalue.voidsetSQLXML(java.lang.String parameterName, java.sql.SQLXML xmlObject)Sets the designated parameter to the givenjava.sql.SQLXMLobject.voidsetString(java.lang.String parameterName, java.lang.String x)Sets the designated parameter to the given JavaStringvalue.voidsetTime(java.lang.String parameterName, java.sql.Time x)Sets the designated parameter to the givenjava.sql.Timevalue.voidsetTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(java.lang.String parameterName, java.sql.Timestamp x)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal)Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetURL(java.lang.String parameterName, java.net.URL val)Sets the designated parameter to the givenjava.net.URLobject.booleanwasNull()Retrieves whether the last OUT parameter read had the value of SQLNULL.-
Methods inherited from class org.hsqldb.jdbc.JDBCPreparedStatement
addBatch, addBatch, cancel, clearBatch, clearParameters, clearWarnings, execute, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMetaData, getMoreResults, getMoreResults, getParameterMetaData, getParameterMetaDataDirect, getQueryTimeout, getResultSetConcurrency, getResultSetHoldability, getResultSetMetaData, getResultSetType, getSQL, getStatementID, getUpdateCount, getWarnings, isClosed, isPoolable, isRowCount, isWrapperFor, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setCursorName, setDate, setDate, setDouble, setEscapeProcessing, setFetchDirection, setFetchSize, setFloat, setInt, setLargeMaxRows, setLong, setMaxFieldSize, setMaxRows, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setPoolable, setQueryTimeout, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL, toString, unwrap
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeLargeUpdate, 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, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
-
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isPoolable, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
-
-
-
-
Constructor Detail
-
JDBCCallableStatement
public JDBCCallableStatement(JDBCConnection c, java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws org.hsqldb.HsqlException, java.sql.SQLException
Constructs a new JDBCCallableStatement with the specified connection and result type.- Parameters:
c- the connection on which this statement will executesql- the SQL statement this object representsresultSetType- the type of result this statement will produceresultSetConcurrency- (updatability)resultSetHoldability- (validity beyond commit)- Throws:
org.hsqldb.HsqlException- if the statement is not accepted by the databasejava.sql.SQLException- if preprocessing by driver fails
-
-
Method Detail
-
registerOutParameter
public void registerOutParameter(int parameterIndex, int sqlType) throws java.sql.SQLExceptionRegisters the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypeshould bejava.sql.Types.OTHER. The methodgetObject(int)retrieves the value.HSQLDB-Specific Information:
HSQLDB supports this feature. This method can be called after a PrepareCall method. HSQLDB has already determined which parameters are OUT or INOUT parameters, therefore this method only checks and throws an exception if the parameter is not of the correct form. The data type argument is ignoredThe
getmethod to read the value of the parameter is determined by the engine based on the data type of the parameter. Furthermore, HSQLDB supports multiple OUT and INOUT parameters for stored procedures.- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- See Also:
Types
-
getResultSet
public java.sql.ResultSet getResultSet() throws java.sql.SQLExceptionDescription copied from class:JDBCPreparedStatementRetrieves the current result as aResultSetobject. This method should be called only once per result.HSQLDB-Specific Information:
Without an interceding call to executeXXX, each invocation of this method will produce a new, initialized ResultSet instance referring to the current result, if any.- Specified by:
getResultSetin interfacejava.sql.Statement- Overrides:
getResultSetin classJDBCPreparedStatement- Returns:
- the current result as a
ResultSetobject ornullif the result is an update count or there are no more results - Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedStatement- See Also:
JDBCPreparedStatement.execute()
-
registerOutParameter
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws java.sql.SQLExceptionRegisters the parameter in ordinal positionparameterIndexto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the SQL type code defined byjava.sql.Types.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- See Also:
Types
-
wasNull
public boolean wasNull() throws java.sql.SQLExceptionRetrieves whether the last OUT parameter read had the value of SQLNULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it isnullor not.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
wasNullin interfacejava.sql.CallableStatement- Returns:
trueif the last parameter read was SQLNULL;falseotherwise- Throws:
java.sql.SQLException- if a database access error occurs or this method is called on a closedCallableStatement
-
getString
public java.lang.String getString(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
CHAR, theStringobject returned has exactly the same value the SQLCHARvalue had in the database, including any padding added by the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getStringin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setString(java.lang.String, java.lang.String)
-
getBoolean
public boolean getBoolean(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCBITorBOOLEANparameter as abooleanin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBooleanin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isfalse. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setBoolean(java.lang.String, boolean)
-
getByte
public byte getByte(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCTINYINTparameter as abytein the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBytein interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setByte(java.lang.String, byte)
-
getShort
public short getShort(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCSMALLINTparameter as ashortin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getShortin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setShort(java.lang.String, short)
-
getInt
public int getInt(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCINTEGERparameter as anintin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getIntin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setInt(java.lang.String, int)
-
getLong
public long getLong(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCBIGINTparameter as alongin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getLongin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setLong(java.lang.String, long)
-
getFloat
public float getFloat(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCFLOATparameter as afloatin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getFloatin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setFloat(java.lang.String, float)
-
getDouble
public double getDouble(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCDOUBLEparameter as adoublein the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getDoublein interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setDouble(java.lang.String, double)
-
getBigDecimal
@Deprecated public java.math.BigDecimal getBigDecimal(int parameterIndex, int scale) throws java.sql.SQLExceptionDeprecated.usegetBigDecimal(int parameterIndex)orgetBigDecimal(String parameterName)Retrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with scale digits to the right of the decimal point.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBigDecimalin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onscale- the number of digits to the right of the decimal point- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)
-
getBytes
public byte[] getBytes(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBytesin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setBytes(java.lang.String, byte[])
-
getDate
public java.sql.Date getDate(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getDatein interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public java.sql.Time getTime(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getTimein interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public java.sql.Timestamp getTimestamp(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.HSQLDB-Specific Information:
The JDBC specification for this method is vague. HSQLDB interprets the specification as follows:- If the SQL type of the column is WITH TIME ZONE, then the UTC value of the returned java.sql.Timestamp object is the UTC of the SQL value without modification.
- If the SQL type of the column is WITHOUT TIME ZONE, then the UTC value of the returned java.sql.Timestamp will represent the correct timestamp for the time zone (including daylight saving time) of the SQL session.
- Specified by:
getTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
getObject
public java.lang.Object getObject(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated parameter as anObjectin the Java programming language. If the value is an SQLNULL, the driver returns a Javanull.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getObjectin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- A
java.lang.Objectholding the OUT parameter value - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- See Also:
Types,setObject(java.lang.String, java.lang.Object, int, int)
-
getBigDecimal
public java.math.BigDecimal getBigDecimal(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBigDecimalin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value in full precision. If the value is
SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- JDK 1.2
- See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)
-
getObject
public java.lang.Object getObject(int parameterIndex, java.util.Map<java.lang.String,java.lang.Class<?>> map) throws java.sql.SQLExceptionReturns an object representing the value of OUT parameterparameterIndexand usesmapfor the custom mapping of the parameter value.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getObjectin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onmap- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Objectholding the OUT parameter value - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
- See Also:
setObject(java.lang.String, java.lang.Object, int, int)
-
getRef
public java.sql.Ref getRef(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getRefin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
getBlob
public java.sql.Blob getBlob(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCBLOBparameter as aBlobobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBlobin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
getClob
public java.sql.Clob getClob(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCCLOBparameter as ajava.sql.Clobobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getClobin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
getArray
public java.sql.Array getArray(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCARRAYparameter as anArrayobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getArrayin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as an
Arrayobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.2
-
getDate
public java.sql.Date getDate(int parameterIndex, java.util.Calendar cal) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getDatein interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- JDK 1.2
- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public java.sql.Time getTime(int parameterIndex, java.util.Calendar cal) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getTimein interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- JDK 1.2
- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public java.sql.Timestamp getTimestamp(int parameterIndex, java.util.Calendar cal) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.HSQLDB-Specific Information:
The JDBC specification for this method is vague. HSQLDB interprets the specification as follows:- If the SQL type of the column is WITH TIME ZONE, then the UTC value of the returned java.sql.Timestamp object is the UTC of the SQL value without modification. In other words, the Calendar object is not used.
- If the SQL type of the column is WITHOUT TIME ZONE, then the UTC value of the returned java.sql.Timestamp will represent the correct timestamp for the time zone (including daylight saving time) of the given Calendar object.
- In this case, if the cal argument is null, then the default Calendar of the JVM is used, which results in the same Object as one returned by the getTimestamp() methods without the Calendar parameter.
- Specified by:
getTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- JDK 1.2
- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
registerOutParameter
public void registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLExceptionRegisters the designated output parameter. This version of the methodregisterOutParametershould be used for a user-defined orREFoutput parameter. Examples of user-defined types include:STRUCT,DISTINCT,JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a
REFparameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined andREFparameters. Although it is intended for user-defined andREFparameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the typeName parameter is ignored.Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...sqlType- a value fromTypestypeName- the fully-qualified name of an SQL structured type- Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- Since:
- JDK 1.2
- See Also:
Types
-
registerOutParameter
public void registerOutParameter(java.lang.String parameterName, int sqlType) throws java.sql.SQLExceptionRegisters the OUT parameter namedparameterNameto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypeshould bejava.sql.Types.OTHER. The methodgetObject(int)retrieves the value.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
Types
-
registerOutParameter
public void registerOutParameter(java.lang.String parameterName, int sqlType, int scale) throws java.sql.SQLExceptionRegisters the parameter namedparameterNameto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- SQL type code defined byjava.sql.Types.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
Types
-
registerOutParameter
public void registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName) throws java.sql.SQLExceptionRegisters the designated output parameter. This version of the methodregisterOutParametershould be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.
Note: When reading the value of an out parameter, you must use the
getXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- a value fromTypestypeName- the fully-qualified name of an SQL structured type- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- ifsqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type or if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQL 1.7.0
- See Also:
Types
-
getURL
public java.net.URL getURL(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCDATALINKparameter as ajava.net.URLobject.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getURLin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...- Returns:
- a
java.net.URLobject that represents the JDBCDATALINKvalue used as the designated parameter - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs, this method is called on a closedCallableStatement, or if the URL being returned is not a valid URL on the Java platformjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setURL(java.lang.String, java.net.URL)
-
setURL
public void setURL(java.lang.String parameterName, java.net.URL val) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.net.URLobject. The driver converts this to an SQLDATALINKvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
setURLin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterval- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closedCallableStatementor if a URL is malformedjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getURL(int)
-
setNull
public void setNull(java.lang.String parameterName, int sqlType) throws java.sql.SQLExceptionSets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setNullin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- the SQL type code defined injava.sql.Types- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
setBoolean
public void setBoolean(java.lang.String parameterName, boolean x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setBooleanin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getBoolean(int)
-
setByte
public void setByte(java.lang.String parameterName, byte x) throws java.sql.SQLExceptionSets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setBytein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getByte(int)
-
setShort
public void setShort(java.lang.String parameterName, short x) throws java.sql.SQLExceptionSets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setShortin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getShort(int)
-
setInt
public void setInt(java.lang.String parameterName, int x) throws java.sql.SQLExceptionSets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setIntin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getInt(int)
-
setLong
public void setLong(java.lang.String parameterName, long x) throws java.sql.SQLExceptionSets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setLongin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getLong(int)
-
setFloat
public void setFloat(java.lang.String parameterName, float x) throws java.sql.SQLExceptionSets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setFloatin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getFloat(int)
-
setDouble
public void setDouble(java.lang.String parameterName, double x) throws java.sql.SQLExceptionSets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setDoublein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getDouble(int)
-
setBigDecimal
public void setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setBigDecimalin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getBigDecimal(int, int)
-
setString
public void setString(java.lang.String parameterName, java.lang.String x) throws java.sql.SQLExceptionSets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setStringin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getString(int)
-
setBytes
public void setBytes(java.lang.String parameterName, byte[] x) throws java.sql.SQLExceptionSets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setBytesin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getBytes(int)
-
setDate
public void setDate(java.lang.String parameterName, java.sql.Date x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATEvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setDatein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getDate(int)
-
setTime
public void setTime(java.lang.String parameterName, java.sql.Time x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setTimein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTime(int)
-
setTimestamp
public void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTimestamp(int)
-
setAsciiStream
public void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setAsciiStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
setBinaryStream
public void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setBinaryStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
setObject
public void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData), the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database- specific abstract data types.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scale- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
Types,getObject(int)
-
setObject
public void setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. This method is similar tosetObject(String parameterName, Object x, int targetSqlType, int scaleOrLength), except that it assumes a scale of zero.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getObject(int)
-
setObject
public void setObject(java.lang.String parameterName, java.lang.Object x) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object.The JDBC specification specifies a standard mapping from Java
Objecttypes to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData, the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the
setNullor thesetObject(String parameterName, Object x, int sqlType)method should be used instead ofsetObject(String parameterName, Object x).HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closedCallableStatementor if the givenObjectparameter is ambiguousjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getObject(int)
-
setCharacterStream
public void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the UNICODE data used as the designated parameterlength- the number of characters in the stream- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
setDate
public void setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setDatein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getDate(int)
-
setTime
public void setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setTimein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTime(int)
-
setTimestamp
public void setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
getTimestamp(int)
-
setNull
public void setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName) throws java.sql.SQLExceptionSets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type.
Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setNullin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREFvalue- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
getString
public java.lang.String getString(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
CHAR, theStringobject returned has exactly the same value the SQLCHARvalue had in the database, including any padding added by the database.HSQLDB-Specific Information:
HSQLDB supports this feature.Calling this method always throws an
SQLException.- Specified by:
getStringin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setString(java.lang.String, java.lang.String)
-
getBoolean
public boolean getBoolean(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCBITorBOOLEANparameter as abooleanin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBooleanin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isfalse. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setBoolean(java.lang.String, boolean)
-
getByte
public byte getByte(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCTINYINTparameter as abytein the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBytein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setByte(java.lang.String, byte)
-
getShort
public short getShort(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCSMALLINTparameter as ashortin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getShortin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setShort(java.lang.String, short)
-
getInt
public int getInt(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCINTEGERparameter as anintin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.Calling this method always throws an
SQLException.- Specified by:
getIntin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setInt(java.lang.String, int)
-
getLong
public long getLong(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCBIGINTparameter as alongin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getLongin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setLong(java.lang.String, long)
-
getFloat
public float getFloat(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCFLOATparameter as afloatin the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getFloatin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setFloat(java.lang.String, float)
-
getDouble
public double getDouble(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCDOUBLEparameter as adoublein the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getDoublein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result is0. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setDouble(java.lang.String, double)
-
getBytes
public byte[] getBytes(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBytesin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setBytes(java.lang.String, byte[])
-
getDate
public java.sql.Date getDate(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getDatein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public java.sql.Time getTime(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getTimein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public java.sql.Timestamp getTimestamp(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.HSQLDB-Specific Information:
The JDBC specification for this method is vague. HSQLDB interprets the specification as follows:- If the SQL type of the column is WITH TIME ZONE, then the UTC value of the returned java.sql.Timestamp object is the UTC of the SQL value without modification.
- If the SQL type of the column is WITHOUT TIME ZONE, then the UTC value of the returned java.sql.Timestamp will represent the correct timestamp for the time zone (including daylight saving time) of the SQL session.
- Specified by:
getTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
getObject
public java.lang.Object getObject(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a parameter as anObjectin the Java programming language. If the value is an SQLNULL, the driver returns a Javanull.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- A
java.lang.Objectholding the OUT parameter value. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
Types,setObject(java.lang.String, java.lang.Object, int, int)
-
getBigDecimal
public java.math.BigDecimal getBigDecimal(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBigDecimalin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value in full precision. If the value is
SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setBigDecimal(java.lang.String, java.math.BigDecimal)
-
getObject
public java.lang.Object getObject(java.lang.String parameterName, java.util.Map<java.lang.String,java.lang.Class<?>> map) throws java.sql.SQLExceptionReturns an object representing the value of OUT parameterparameterNameand usesmapfor the custom mapping of the parameter value.This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method
registerOutParameter. By registering the target JDBC type asjava.sql.Types.OTHER, this method can be used to read database-specific abstract data types.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametermap- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Objectholding the OUT parameter value - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setObject(java.lang.String, java.lang.Object, int, int)
-
getRef
public java.sql.Ref getRef(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCREF(<structured-type>)parameter as aRefobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getRefin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
getBlob
public java.sql.Blob getBlob(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCBLOBparameter as aBlobobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getBlobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
getClob
public java.sql.Clob getClob(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCCLOBparameter as aClobobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
getArray
public java.sql.Array getArray(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getArrayin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as an
Arrayobject in Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
-
getDate
public java.sql.Date getDate(java.lang.String parameterName, java.util.Calendar cal) throws java.sql.SQLExceptionRetrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getDatein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setDate(java.lang.String, java.sql.Date)
-
getTime
public java.sql.Time getTime(java.lang.String parameterName, java.util.Calendar cal) throws java.sql.SQLExceptionRetrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getTimein interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTime(java.lang.String, java.sql.Time)
-
getTimestamp
public java.sql.Timestamp getTimestamp(java.lang.String parameterName, java.util.Calendar cal) throws java.sql.SQLExceptionRetrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.HSQLDB-Specific Information:
The JDBC specification for this method is vague. HSQLDB interprets the specification as follows:- If the SQL type of the column is WITH TIME ZONE, then the UTC value of the returned java.sql.Timestamp object is the UTC of the SQL value without modification. In other words, the Calendar object is not used.
- If the SQL type of the column is WITHOUT TIME ZONE, then the UTC value of the returned java.sql.Timestamp will represent the correct timestamp for the time zone (including daylight saving time) of the given Calendar object.
- In this case, if the cal argument is null, then the default Calendar of the JVM is used, which results in the same Object as one returned by the getTimestamp() methods without the Calendar parameter.
- Specified by:
getTimestampin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametercal- theCalendarobject the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL, the result isnull. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setTimestamp(java.lang.String, java.sql.Timestamp)
-
getURL
public java.net.URL getURL(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCDATALINKparameter as ajava.net.URLobject.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getURLin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
java.net.URLobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closedCallableStatement, or if there is a problem with the URLjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.4, HSQLDB 1.7.0
- See Also:
setURL(java.lang.String, java.net.URL)
-
getRowId
public java.sql.RowId getRowId(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getRowIdin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...- Returns:
- a
RowIdobject that represents the JDBCROWIDvalue is used as the designated parameter. If the parameter contains a SQLNULL, then anullvalue is returned. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getRowId
public java.sql.RowId getRowId(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCROWIDparameter as ajava.sql.RowIdobject.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getRowIdin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- a
RowIdobject that represents the JDBCROWIDvalue is used as the designated parameter. If the parameter contains a SQLNULL, then anullvalue is returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setRowId
public void setRowId(java.lang.String parameterName, java.sql.RowId x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.RowIdobject. The driver converts this to a SQLROWIDwhen it sends it to the database.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
setRowIdin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNString
public void setNString(java.lang.String parameterName, java.lang.String value) throws java.sql.SQLExceptionSets the designated parameter to the givenStringobject. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHAR- Specified by:
setNStringin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNCharacterStream
public void setNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Specified by:
setNCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter valuelength- the number of characters in the parameter data.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNClob
public void setNClob(java.lang.String parameterName, java.sql.NClob value) throws java.sql.SQLExceptionSets the designated parameter to ajava.sql.NClobobject. The object implements thejava.sql.NClobinterface. ThisNClobobject maps to a SQLNCLOB.- Specified by:
setNClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setClob
public void setClob(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. Thereadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHARor aCLOB- Specified by:
setClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter to be setreader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the length specified is less than zero; a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setBlob
public void setBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length) throws java.sql.SQLExceptionSets the designated parameter to aInputStreamobject. Theinputstreammust contain the number of characters specified by length, otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetBinaryStream (int, InputStream, int)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOB- Specified by:
setBlobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter to be set the second is 2, ...inputStream- An object that contains the data to set the parameter value to.length- the number of bytes in the parameter data.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the number of bytes in theInputStreamdoes not match the specified length; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setNClob
public void setNClob(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. Thereadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHARor aNCLOB- Specified by:
setNClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter to be setreader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getNClob
public java.sql.NClob getNClob(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getNClobin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
NClobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getNClob
public java.sql.NClob getNClob(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of a JDBCNCLOBparameter as ajava.sql.NClobobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getNClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
NClobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setSQLXML
public void setSQLXML(java.lang.String parameterName, java.sql.SQLXML xmlObject) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.SQLXMLobject. The driver converts this to anSQL XMLvalue when it sends it to the database.- Specified by:
setSQLXMLin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterxmlObject- aSQLXMLobject that maps anSQL XMLvalue- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closedCallableStatementor thejava.xml.transform.Result,WriterorOutputStreamhas not been closed for theSQLXMLobjectjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getSQLXML
public java.sql.SQLXML getSQLXML(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getSQLXMLin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...- Returns:
- a
SQLXMLobject that maps anSQL XMLvalue - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getSQLXML
public java.sql.SQLXML getSQLXML(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of the designatedSQL XMLparameter as ajava.sql.SQLXMLobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getSQLXMLin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- a
SQLXMLobject that maps anSQL XMLvalue - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getNString
public java.lang.String getNString(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
NCHAR, theStringobject returned has exactly the same value the SQLNCHARvalue had in the database, including any padding added by the database.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getNStringin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...- Returns:
- a
Stringobject that maps anNCHAR,NVARCHARorLONGNVARCHARvalue - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
setNString(java.lang.String, java.lang.String)
-
getNString
public java.lang.String getNString(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of the designatedNCHAR,NVARCHARorLONGNVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
NCHAR, theStringobject returned has exactly the same value the SQLNCHARvalue had in the database, including any padding added by the database.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getNStringin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- a
Stringobject that maps anNCHAR,NVARCHARorLONGNVARCHARvalue - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
- See Also:
setNString(java.lang.String, java.lang.String)
-
getNCharacterStream
public java.io.Reader getNCharacterStream(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language. It is intended for use when accessingNCHAR,NVARCHARandLONGNVARCHARparameters.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getNCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getNCharacterStream
public java.io.Reader getNCharacterStream(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language. It is intended for use when accessingNCHAR,NVARCHARandLONGNVARCHARparameters.HSQLDB-Specific Information:
HSQLDB does not yet support this feature.Calling this method always throws an
SQLException.- Specified by:
getNCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getCharacterStream
public java.io.Reader getCharacterStream(int parameterIndex) throws java.sql.SQLExceptionRetrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language. - Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatement- Since:
- JDK 1.6, HSQLDB 2.0
-
getCharacterStream
public java.io.Reader getCharacterStream(java.lang.String parameterName) throws java.sql.SQLExceptionRetrieves the value of the designated parameter as ajava.io.Readerobject in the Java programming language.HSQLDB-Specific Information:
HSQLDB supports this feature.- Specified by:
getCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- a
java.io.Readerobject that contains the parameter value; if the value is SQLNULL, the value returned isnullin the Java programming language - Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setBlob
public void setBlob(java.lang.String parameterName, java.sql.Blob x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Blobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.- Specified by:
setBlobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- aBlobobject that maps an SQLBLOBvalue- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setClob
public void setClob(java.lang.String parameterName, java.sql.Clob x) throws java.sql.SQLExceptionSets the designated parameter to the givenjava.sql.Clobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.- Specified by:
setClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- aClobobject that maps an SQLCLOBvalue- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setAsciiStream
public void setAsciiStream(java.lang.String parameterName, java.io.InputStream x, long length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setAsciiStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setBinaryStream
public void setBinaryStream(java.lang.String parameterName, java.io.InputStream x, long length) throws java.sql.SQLExceptionSets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setBinaryStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setCharacterStream
public void setCharacterStream(java.lang.String parameterName, java.io.Reader reader, long length) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Specified by:
setCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the UNICODE data used as the designated parameterlength- the number of characters in the stream- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setAsciiStream
public void setAsciiStream(java.lang.String parameterName, java.io.InputStream x) throws java.sql.SQLExceptionSets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStreamwhich takes a length parameter.- Specified by:
setAsciiStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setBinaryStream
public void setBinaryStream(java.lang.String parameterName, java.io.InputStream x) throws java.sql.SQLExceptionSets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStreamwhich takes a length parameter.- Specified by:
setBinaryStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
setCharacterStream
public void setCharacterStream(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLExceptionSets the designated parameter to the givenReaderobject. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStreamwhich takes a length parameter.- Specified by:
setCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the Unicode data- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method JDK 1.6, HSQLDB 2.0
-
setNCharacterStream
public void setNCharacterStream(java.lang.String parameterName, java.io.Reader value) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStreamwhich takes a length parameter.- Specified by:
setNCharacterStreamin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter value- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method JDK 1.6, HSQLDB 2.0
-
setClob
public void setClob(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHARor aCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClobwhich takes a length parameter.- Specified by:
setClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterreader- An object that contains the data to set the parameter value to.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method JDK 1.6, HSQLDB 2.0
-
setBlob
public void setBlob(java.lang.String parameterName, java.io.InputStream inputStream) throws java.sql.SQLExceptionSets the designated parameter to anInputStreamobject. This method differs from thesetBinaryStream (int, InputStream)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlobwhich takes a length parameter.- Specified by:
setBlobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterinputStream- An object that contains the data to set the parameter value to.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method JDK 1.6, HSQLDB 2.0
-
setNClob
public void setNClob(java.lang.String parameterName, java.io.Reader reader) throws java.sql.SQLExceptionSets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHARor aNCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClobwhich takes a length parameter.- Specified by:
setNClobin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterreader- An object that contains the data to set the parameter value to.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method JDK 1.6, HSQLDB 2.0
-
getObject
public <T> T getObject(int parameterIndex, java.lang.Class<T> type) throws java.sql.SQLExceptionReturns an object representing the value of OUT parameterparameterIndexand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported. If the conversion is not supported or null is specified for the type, aSQLExceptionis thrown.At a minimum, an implementation must support the conversions defined in Appendix B, Table B-3 and conversion of appropriate user defined SQL types to a Java type which implements
SQLData, orStruct. Additional conversions may be supported and are vendor defined.- Specified by:
getObjectin interfacejava.sql.CallableStatement- Type Parameters:
T- the type of the class modeled by this Class object- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so ontype- Class representing the Java data type to convert the designated parameter to.- Returns:
- an instance of
typeholding the OUT parameter value - Throws:
java.sql.SQLException- if conversion is not supported, type is null or another error occurs. The getCause() method of the exception may provide a more detailed exception, for example, if a conversion error occursjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.7, HSQLDB 2.0.1
-
getObject
public <T> T getObject(java.lang.String parameterName, java.lang.Class<T> type) throws java.sql.SQLExceptionReturns an object representing the value of OUT parameterparameterNameand will convert from the SQL type of the parameter to the requested Java data type, if the conversion is supported. If the conversion is not supported or null is specified for the type, aSQLExceptionis thrown.At a minimum, an implementation must support the conversions defined in Appendix B, Table B-3 and conversion of appropriate user defined SQL types to a Java type which implements
SQLData, orStruct. Additional conversions may be supported and are vendor defined.- Specified by:
getObjectin interfacejava.sql.CallableStatement- Type Parameters:
T- the type of the class modeled by this Class object- Parameters:
parameterName- the name of the parametertype- Class representing the Java data type to convert the designated parameter to.- Returns:
- an instance of
typeholding the OUT parameter value - Throws:
java.sql.SQLException- if conversion is not supported, type is null or another error occurs. The getCause() method of the exception may provide a more detailed exception, for example, if a conversion error occursjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- JDK 1.7, HSQLDB 2.0.1
-
setObject
public void setObject(java.lang.String parameterName, java.lang.Object x, java.sql.SQLType targetSqlType, int scaleOrLength) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. If the second argument is anInputStreamthen the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReaderthen the reader must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLExceptionwhen the prepared statement is executed.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData), the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type to be sent to the database. The scale argument may further qualify this type.scaleOrLength- forjava.sql.JDBCType.DECIMALorjava.sql.JDBCType.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStreamandReader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementor if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zerojava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
setObject
public void setObject(java.lang.String parameterName, java.lang.Object x, java.sql.SQLType targetSqlType) throws java.sql.SQLExceptionSets the value of the designated parameter with the given object. This method is similar tosetObject(String parameterName, Object x, SQLType targetSqlType, int scaleOrLength), except that it assumes a scale of zero.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
setObjectin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type to be sent to the database- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified targetSqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
registerOutParameter
public void registerOutParameter(int parameterIndex, java.sql.SQLType sqlType) throws java.sql.SQLExceptionRegisters the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypemay beJDBCType.OTHERor aSQLTypethat is supported by the JDBC driver. The methodgetObject(int)retrieves the value.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter. If the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
registerOutParameter
public void registerOutParameter(int parameterIndex, java.sql.SQLType sqlType, int scale) throws java.sql.SQLExceptionRegisters the parameter in ordinal positionparameterIndexto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so onsqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
registerOutParameter
public void registerOutParameter(int parameterIndex, java.sql.SQLType sqlType, java.lang.String typeName) throws java.sql.SQLExceptionRegisters the designated output parameter. This version of the methodregisterOutParametershould be used for a user-defined orREFoutput parameter. Examples of user-defined types include:STRUCT,DISTINCT,JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a
REFparameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined andREFparameters. Although it is intended for user-defined andREFparameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the typeName parameter is ignored.Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.
The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...sqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.typeName- the fully-qualified name of an SQL structured type- Throws:
java.sql.SQLException- if the parameterIndex is not valid; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
registerOutParameter
public void registerOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType) throws java.sql.SQLExceptionRegisters the OUT parameter namedparameterNameto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.If the JDBC type expected to be returned to this output parameter is specific to this particular database,
sqlTypeshould beJDBCType.OTHERor aSQLTypethat is supported by the JDBC driver. The methodgetObject(int)retrieves the value.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter. If the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType or if the JDBC driver does not support this method- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
registerOutParameter
public void registerOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, int scale) throws java.sql.SQLExceptionRegisters the parameter namedparameterNameto be of JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeJDBCType.NUMERICorJDBCType.DECIMAL.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.scale- the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType or if the JDBC driver does not support this method- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
registerOutParameter
public void registerOutParameter(java.lang.String parameterName, java.sql.SQLType sqlType, java.lang.String typeName) throws java.sql.SQLExceptionRegisters the designated output parameter. This version of the methodregisterOutParametershould be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.All OUT parameters must be registered before a stored procedure is executed.
For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.Note: When reading the value of an out parameter, you must use the
getXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type.The default implementation will throw
SQLFeatureNotSupportedException- Specified by:
registerOutParameterin interfacejava.sql.CallableStatement- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined bySQLTypeto use to register the OUT Parameter.typeName- the fully-qualified name of an SQL structured type- Throws:
java.sql.SQLException- if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closedCallableStatementjava.sql.SQLFeatureNotSupportedException- if the JDBC driver does not support the specified sqlType or if the JDBC driver does not support this method- Since:
- 1.8
- See Also:
JDBCType,SQLType
-
close
public void close() throws java.sql.SQLExceptionDoes the specialized work required to free this object's resources and that of its parent classes.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.sql.Statement- Overrides:
closein classJDBCPreparedStatement- Throws:
java.sql.SQLException- if a database access error occurs
-
closeOnCompletion
public void closeOnCompletion() throws java.sql.SQLExceptionSpecifies that thisStatementwill be closed when all its dependent result sets are closed. If execution of theStatementdoes not produce any result sets, this method has no effect.Note: Multiple calls to
closeOnCompletiondo not toggle the effect on thisStatement. However, a call tocloseOnCompletiondoes effect both the subsequent execution of statements, and statements that currently have open, dependent, result sets.- Specified by:
closeOnCompletionin interfacejava.sql.Statement- Throws:
java.sql.SQLException- if this method is called on a closedStatement
-
isCloseOnCompletion
public boolean isCloseOnCompletion() throws java.sql.SQLExceptionReturns a value indicating whether thisStatementwill be closed when all its dependent result sets are closed.- Specified by:
isCloseOnCompletionin interfacejava.sql.Statement- Returns:
trueif theStatementwill be closed when all of its dependent result sets are closed;falseotherwise- Throws:
java.sql.SQLException- if this method is called on a closedStatement
-
executeQuery
public java.sql.ResultSet executeQuery() throws java.sql.SQLExceptionExecutes the SQL query in thisPreparedStatementobject and returns theResultSetobject generated by the query.HSQLDB-Specific Information:
HSQLDB supports this method for a call to a FUNCTION that returns a result. For a PROCEDURE that returns one or more results, the first result is returned.If the FUNCTION or PROCEDURE does not return a ResultSet, an
SQLExceptionis thrown.- Specified by:
executeQueryin interfacejava.sql.PreparedStatement- Overrides:
executeQueryin classJDBCPreparedStatement- Returns:
- a
ResultSetobject that contains the data produced by the query; nevernull - Throws:
java.sql.SQLException- if a database access error occurs, this method is called on a closedPreparedStatementor the SQL statement does not return aResultSetobject
-
-