com.sun.gjc.spi.base.CallableStatementWrapper Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.gjc.spi.base;
import java.io.InputStream;
import java.io.Reader;
import java.math.BigDecimal;
import java.net.URL;
import java.sql.*;
import java.util.Calendar;
import java.util.Map;
/**
* Abstract class for wrapping PreparedStatement
*/
public abstract class CallableStatementWrapper extends PreparedStatementWrapper implements CallableStatement {
protected CallableStatement callableStatement = null;
/**
* Creates a new instance of CallableStatementWrapper
*
* @param con ConnectionWrapper
* @param statement Statement that is to be wrapped
*/
public CallableStatementWrapper(Connection con, CallableStatement statement,
boolean cachingEnabled) throws SQLException{
super(con, statement, cachingEnabled);
callableStatement = statement;
}
/**
* Registers the OUT parameter in ordinal position
* parameterIndex to the JDBC type
* sqlType. All OUT parameters must be registered
* before a stored procedure is executed.
*
* The JDBC type specified by sqlType for an OUT
* parameter determines the Java type that must be used
* in the get method 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, sqlType
* should be java.sql.Types.OTHER. The method
* {@link #getObject} retrieves the value.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param sqlType the JDBC type code defined by java.sql.Types.
* If the parameter is of JDBC type NUMERIC
* or DECIMAL, the version of
* registerOutParameter that accepts a scale value
* should be used.
* @throws java.sql.SQLException if a database access error occurs
* @see java.sql.Types
*/
public void registerOutParameter(int parameterIndex, int sqlType) throws SQLException {
callableStatement.registerOutParameter(parameterIndex, sqlType);
}
/**
* Registers the parameter in ordinal position
* parameterIndex to be of JDBC type
* sqlType. This method must be called
* before a stored procedure is executed.
*
* The JDBC type specified by sqlType for an OUT
* parameter determines the Java type that must be used
* in the get method to read the value of that parameter.
*
* This version of registerOutParameter should be
* used when the parameter is of JDBC type NUMERIC
* or DECIMAL.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param sqlType the SQL type code defined by java.sql.Types.
* @param 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 a database access error occurs
* @see java.sql.Types
*/
public void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException {
callableStatement.registerOutParameter(parameterIndex, sqlType, scale);
}
/**
* Retrieves whether the last OUT parameter read had the value of
* SQL NULL. Note that this method should be called only after
* calling a getter method; otherwise, there is no value to use in
* determining whether it is null or not.
*
* @return true if the last parameter read was SQL
* NULL; false otherwise
* @throws java.sql.SQLException if a database access error occurs
*/
public boolean wasNull() throws SQLException {
return callableStatement.wasNull();
}
/**
* Retrieves the value of the designated JDBC CHAR,
* VARCHAR, or LONGVARCHAR parameter as a
* String in the Java programming language.
*
* For the fixed-length type JDBC CHAR,
* the String object
* returned has exactly the same value the JDBC
* CHAR value had in the
* database, including any padding added by the database.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL,
* the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setString
*/
public String getString(int parameterIndex) throws SQLException {
return callableStatement.getString(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC BIT parameter as a
* boolean in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL,
* the result is false.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBoolean
*/
public boolean getBoolean(int parameterIndex) throws SQLException {
return callableStatement.getBoolean(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC TINYINT parameter
* as a byte in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setByte
*/
public byte getByte(int parameterIndex) throws SQLException {
return callableStatement.getByte(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC SMALLINT parameter
* as a short in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setShort
*/
public short getShort(int parameterIndex) throws SQLException {
return callableStatement.getShort(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC INTEGER parameter
* as an int in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setInt
*/
public int getInt(int parameterIndex) throws SQLException {
return callableStatement.getInt(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC BIGINT parameter
* as a long in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setLong
*/
public long getLong(int parameterIndex) throws SQLException {
return callableStatement.getLong(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC FLOAT parameter
* as a float in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setFloat
*/
public float getFloat(int parameterIndex) throws SQLException {
return callableStatement.getFloat(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC DOUBLE parameter as a double
* in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setDouble
*/
public double getDouble(int parameterIndex) throws SQLException {
return callableStatement.getDouble(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC NUMERIC parameter as a
* java.math.BigDecimal object with scale digits to
* the right of the decimal point.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param scale the number of digits to the right of the decimal point
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBigDecimal
* @deprecated use getBigDecimal(int parameterIndex)
* or getBigDecimal(String parameterName)
*/
@Deprecated
public BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException {
return callableStatement.getBigDecimal(parameterIndex, scale);
}
/**
* Retrieves the value of the designated JDBC BINARY or
* VARBINARY parameter as an array of byte
* values in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBytes
*/
public byte[] getBytes(int parameterIndex) throws SQLException {
return callableStatement.getBytes(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC DATE parameter as a
* java.sql.Date object.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setDate
*/
public Date getDate(int parameterIndex) throws SQLException {
return callableStatement.getDate(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC TIME parameter as a
* java.sql.Time object.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTime
*/
public Time getTime(int parameterIndex) throws SQLException {
return callableStatement.getTime(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC TIMESTAMP parameter as a
* java.sql.Timestamp object.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTimestamp
*/
public Timestamp getTimestamp(int parameterIndex) throws SQLException {
return callableStatement.getTimestamp(parameterIndex);
}
/**
* Retrieves the value of the designated parameter as an Object
* in the Java programming language. If the value is an SQL NULL,
* the driver returns a Java null.
*
* 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 as java.sql.Types.OTHER, this method can be used
* to read database-specific abstract data types.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return A java.lang.Object holding the OUT parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see java.sql.Types
* @see #setObject
*/
public Object getObject(int parameterIndex) throws SQLException {
return callableStatement.getObject(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC NUMERIC parameter as a
* java.math.BigDecimal object with as many digits to the
* right of the decimal point as the value contains.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value in full precision. If the value is
* SQL NULL, the result is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBigDecimal
* @since 1.2
*/
public BigDecimal getBigDecimal(int parameterIndex) throws SQLException {
return callableStatement.getBigDecimal(parameterIndex);
}
/**
* Retrieves the value of the designated JDBC REF(<structured-type>)
* parameter as a {@link java.sql.Ref} object in the Java programming language.
*
* @param i the first parameter is 1, the second is 2,
* and so on
* @return the parameter value as a Ref object in the
* Java programming language. If the value was SQL NULL, the value
* null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.2
*/
public Ref getRef(int i) throws SQLException {
return callableStatement.getRef(i);
}
/**
* Retrieves the value of the designated JDBC BLOB parameter as a
* {@link java.sql.Blob} object in the Java programming language.
*
* @param i the first parameter is 1, the second is 2, and so on
* @return the parameter value as a Blob object in the
* Java programming language. If the value was SQL NULL, the value
* null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.2
*/
public Blob getBlob(int i) throws SQLException {
return callableStatement.getBlob(i);
}
/**
* Retrieves the value of the designated JDBC CLOB parameter as a
* Clob object in the Java programming language.
*
* @param i the first parameter is 1, the second is 2, and
* so on
* @return the parameter value as a Clob object in the
* Java programming language. If the value was SQL NULL, the
* value null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.2
*/
public Clob getClob(int i) throws SQLException {
return callableStatement.getClob(i);
}
/**
* Retrieves the value of the designated JDBC ARRAY parameter as an
* {@link java.sql.Array} object in the Java programming language.
*
* @param i the first parameter is 1, the second is 2, and
* so on
* @return the parameter value as an Array object in
* the Java programming language. If the value was SQL NULL, the
* value null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.2
*/
public Array getArray(int i) throws SQLException {
return callableStatement.getArray(i);
}
/**
* Retrieves the value of the designated JDBC DATE parameter as a
* java.sql.Date object, using
* the given Calendar object
* to construct the date.
* With a Calendar object, the driver
* can calculate the date taking into account a custom timezone and locale.
* If no Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param cal the Calendar object the driver will use
* to construct the date
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setDate
* @since 1.2
*/
public Date getDate(int parameterIndex, Calendar cal) throws SQLException {
return callableStatement.getDate(parameterIndex, cal);
}
/**
* Retrieves the value of the designated JDBC TIME parameter as a
* java.sql.Time object, using
* the given Calendar object
* to construct the time.
* With a Calendar object, the driver
* can calculate the time taking into account a custom timezone and locale.
* If no Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param cal the Calendar object the driver will use
* to construct the time
* @return the parameter value; if the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTime
* @since 1.2
*/
public Time getTime(int parameterIndex, Calendar cal) throws SQLException {
return callableStatement.getTime(parameterIndex, cal);
}
/**
* Retrieves the value of the designated JDBC TIMESTAMP parameter as a
* java.sql.Timestamp object, using
* the given Calendar object to construct
* the Timestamp object.
* With a Calendar object, the driver
* can calculate the timestamp taking into account a custom timezone and locale.
* If no Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param cal the Calendar object the driver will use
* to construct the timestamp
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTimestamp
* @since 1.2
*/
public Timestamp getTimestamp(int parameterIndex, Calendar cal) throws SQLException {
return callableStatement.getTimestamp(parameterIndex, cal);
}
/**
* Registers the designated output parameter. This version of
* the method registerOutParameter
* should be used for a user-defined or REF output parameter. Examples
* of user-defined types include: STRUCT, DISTINCT,
* JAVA_OBJECT, and named array types.
*
* Before executing a stored procedure call, you must explicitly
* call registerOutParameter to register the type from
* java.sql.Types for each
* OUT parameter. For a user-defined 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-defined and REF parameters.
*
* Although it is intended for user-defined and REF parameters,
* this method may be used to register a parameter of any JDBC type.
* If the parameter does not have a user-defined or REF type, 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.
*
* @param paramIndex the first parameter is 1, the second is 2,...
* @param sqlType a value from {@link java.sql.Types}
* @param typeName the fully-qualified name of an SQL structured type
* @throws java.sql.SQLException if a database access error occurs
* @see java.sql.Types
* @since 1.2
*/
public void registerOutParameter(int paramIndex, int sqlType, String typeName) throws SQLException {
callableStatement.registerOutParameter(paramIndex, sqlType, typeName);
}
/**
* Registers the OUT parameter named
* parameterName to the JDBC type
* sqlType. All OUT parameters must be registered
* before a stored procedure is executed.
*
* The JDBC type specified by sqlType for an OUT
* parameter determines the Java type that must be used
* in the get method 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, sqlType
* should be java.sql.Types.OTHER. The method
* {@link #getObject} retrieves the value.
*
* @param parameterName the name of the parameter
* @param sqlType the JDBC type code defined by java.sql.Types.
* If the parameter is of JDBC type NUMERIC
* or DECIMAL, the version of
* registerOutParameter that accepts a scale value
* should be used.
* @throws java.sql.SQLException if a database access error occurs
* @see java.sql.Types
* @since 1.4
*/
public void registerOutParameter(String parameterName, int sqlType) throws SQLException {
callableStatement.registerOutParameter(parameterName, sqlType);
}
/**
* Registers the parameter named
* parameterName to be of JDBC type
* sqlType. This method must be called
* before a stored procedure is executed.
*
* The JDBC type specified by sqlType for an OUT
* parameter determines the Java type that must be used
* in the get method to read the value of that parameter.
*
* This version of registerOutParameter should be
* used when the parameter is of JDBC type NUMERIC
* or DECIMAL.
*
* @param parameterName the name of the parameter
* @param sqlType SQL type code defined by java.sql.Types.
* @param 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 a database access error occurs
* @see java.sql.Types
* @since 1.4
*/
public void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException {
callableStatement.registerOutParameter(parameterName, sqlType, scale);
}
/**
* Registers the designated output parameter. This version of
* the method registerOutParameter
* should be used for a user-named or REF output parameter. Examples
* of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and
* named array types.
*
* Before executing a stored procedure call, you must explicitly
* call registerOutParameter to register the type from
* java.sql.Types for each
* OUT parameter. 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 getXXX method whose Java type XXX corresponds to the
* parameter's registered SQL type.
*
* @param parameterName the name of the parameter
* @param sqlType a value from {@link java.sql.Types}
* @param typeName the fully-qualified name of an SQL structured type
* @throws java.sql.SQLException if a database access error occurs
* @see java.sql.Types
* @since 1.4
*/
public void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException {
callableStatement.registerOutParameter(parameterName, sqlType, typeName);
}
/**
* Retrieves the value of the designated JDBC DATALINK parameter as a
* java.net.URL object.
*
* @param parameterIndex the first parameter is 1, the second is 2,...
* @return a java.net.URL object that represents the
* JDBC DATALINK value used as the designated
* parameter
* @throws java.sql.SQLException if a database access error occurs,
* or if the URL being returned is
* not a valid URL on the Java platform
* @see #setURL
* @since 1.4
*/
public URL getURL(int parameterIndex) throws SQLException {
return callableStatement.getURL(parameterIndex);
}
/**
* Sets the designated parameter to the given java.net.URL object.
* The driver converts this to an SQL DATALINK value when
* it sends it to the database.
*
* @param parameterName the name of the parameter
* @param val the parameter value
* @throws java.sql.SQLException if a database access error occurs,
* or if a URL is malformed
* @see #getURL
* @since 1.4
*/
public void setURL(String parameterName, URL val) throws SQLException {
callableStatement.setURL(parameterName, val);
}
/**
* Sets the designated parameter to SQL NULL.
*
* Note: You must specify the parameter's SQL type.
*
* @param parameterName the name of the parameter
* @param sqlType the SQL type code defined in java.sql.Types
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public void setNull(String parameterName, int sqlType) throws SQLException {
callableStatement.setNull(parameterName, sqlType);
}
/**
* Sets the designated parameter to the given Java boolean value.
* The driver converts this
* to an SQL BIT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getBoolean
* @since 1.4
*/
public void setBoolean(String parameterName, boolean x) throws SQLException {
callableStatement.setBoolean(parameterName, x);
}
/**
* Sets the designated parameter to the given Java byte value.
* The driver converts this
* to an SQL TINYINT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getByte
* @since 1.4
*/
public void setByte(String parameterName, byte x) throws SQLException {
callableStatement.setByte(parameterName, x);
}
/**
* Sets the designated parameter to the given Java short value.
* The driver converts this
* to an SQL SMALLINT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getShort
* @since 1.4
*/
public void setShort(String parameterName, short x) throws SQLException {
callableStatement.setShort(parameterName, x);
}
/**
* Sets the designated parameter to the given Java int value.
* The driver converts this
* to an SQL INTEGER value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getInt
* @since 1.4
*/
public void setInt(String parameterName, int x) throws SQLException {
callableStatement.setInt(parameterName, x);
}
/**
* Sets the designated parameter to the given Java long value.
* The driver converts this
* to an SQL BIGINT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getLong
* @since 1.4
*/
public void setLong(String parameterName, long x) throws SQLException {
callableStatement.setLong(parameterName, x);
}
/**
* Sets the designated parameter to the given Java float value.
* The driver converts this
* to an SQL FLOAT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getFloat
* @since 1.4
*/
public void setFloat(String parameterName, float x) throws SQLException {
callableStatement.setFloat(parameterName, x);
}
/**
* Sets the designated parameter to the given Java double value.
* The driver converts this
* to an SQL DOUBLE value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getDouble
* @since 1.4
*/
public void setDouble(String parameterName, double x) throws SQLException {
callableStatement.setDouble(parameterName, x);
}
/**
* Sets the designated parameter to the given
* java.math.BigDecimal value.
* The driver converts this to an SQL NUMERIC value when
* it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getBigDecimal
* @since 1.4
*/
public void setBigDecimal(String parameterName, BigDecimal x) throws SQLException {
callableStatement.setBigDecimal(parameterName, x);
}
/**
* Sets the designated parameter to the given Java String value.
* The driver converts this
* to an SQL VARCHAR or LONGVARCHAR value
* (depending on the argument's
* size relative to the driver's limits on VARCHAR values)
* when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getString
* @since 1.4
*/
public void setString(String parameterName, String x) throws SQLException {
callableStatement.setString(parameterName, x);
}
/**
* Sets the designated parameter to the given Java array of bytes.
* The driver converts this to an SQL VARBINARY or
* LONGVARBINARY (depending on the argument's size relative
* to the driver's limits on VARBINARY values) when it sends
* it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getBytes
* @since 1.4
*/
public void setBytes(String parameterName, byte x[]) throws SQLException {
callableStatement.setBytes(parameterName, x);
}
/**
* Sets the designated parameter to the given java.sql.Date value.
* The driver converts this
* to an SQL DATE value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getDate
* @since 1.4
*/
public void setDate(String parameterName, Date x) throws SQLException {
callableStatement.setDate(parameterName, x);
}
/**
* Sets the designated parameter to the given java.sql.Time value.
* The driver converts this
* to an SQL TIME value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getTime
* @since 1.4
*/
public void setTime(String parameterName, Time x) throws SQLException {
callableStatement.setTime(parameterName, x);
}
/**
* Sets the designated parameter to the given java.sql.Timestamp value.
* The driver
* converts this to an SQL TIMESTAMP value when it sends it to the
* database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #getTimestamp
* @since 1.4
*/
public void setTimestamp(String parameterName, Timestamp x) throws SQLException {
callableStatement.setTimestamp(parameterName, x);
}
/**
* Sets 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 a LONGVARCHAR
* parameter, it may be more practical to send it via a
* java.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.
*
* @param parameterName the name of the parameter
* @param x the Java input stream that contains the ASCII parameter value
* @param length the number of bytes in the stream
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public void setAsciiStream(String parameterName, InputStream x, int length) throws SQLException {
callableStatement.setAsciiStream(parameterName, x, length);
}
/**
* Sets 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 a LONGVARBINARY
* parameter, it may be more practical to send it via a
* java.io.InputStream object. 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.
*
* @param parameterName the name of the parameter
* @param x the java input stream which contains the binary parameter value
* @param length the number of bytes in the stream
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public void setBinaryStream(String parameterName, InputStream x, int length) throws SQLException {
callableStatement.setBinaryStream(parameterName, x, length);
}
/**
* Sets the value of the designated parameter with the given object. The second
* argument must be an object type; for integral values, the
* java.lang equivalent objects should be used.
*
* 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 method SQLData.writeSQL to write it
* to the SQL data stream.
* If, on the other hand, the object is of a class implementing
* Ref, Blob, Clob, Struct,
* or Array, 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 datatabase-
* specific abstract data types.
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type (as defined in java.sql.Types) to be
* sent to the database. The scale argument may further qualify this type.
* @param 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 a database access error occurs
* @see java.sql.Types
* @see #getObject
* @since 1.4
*/
public void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException {
callableStatement.setObject(parameterName, x, targetSqlType, scale);
}
/**
* Sets the value of the designated parameter with the given object.
* This method is like the method setObject
* above, except that it assumes a scale of zero.
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type (as defined in java.sql.Types) to be
* sent to the database
* @throws java.sql.SQLException if a database access error occurs
* @see #getObject
* @since 1.4
*/
public void setObject(String parameterName, Object x, int targetSqlType) throws SQLException {
callableStatement.setObject(parameterName, x, targetSqlType);
}
/**
* Sets the value of the designated parameter with the given object.
* The second parameter must be of type Object; therefore, the
* java.lang equivalent objects should be used for built-in types.
*
* The JDBC specification specifies a standard mapping from
* Java Object types 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 datatabase-
* 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 method SQLData.writeSQL
* to write it to the SQL data stream.
* If, on the other hand, the object is of a class implementing
* Ref, Blob, Clob, Struct,
* or Array, 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.
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @throws java.sql.SQLException if a database access error occurs or if the given
* Object parameter is ambiguous
* @see #getObject
* @since 1.4
*/
public void setObject(String parameterName, Object x) throws SQLException {
callableStatement.setObject(parameterName, x);
}
/**
* Sets the designated parameter to the given Reader
* object, which is the given number of characters long.
* When a very large UNICODE value is input to a LONGVARCHAR
* parameter, it may be more practical to send it via a
* java.io.Reader object. 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.
*
* @param parameterName the name of the parameter
* @param reader the java.io.Reader object that
* contains the UNICODE data used as the designated parameter
* @param length the number of characters in the stream
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public void setCharacterStream(String parameterName, Reader reader, int length) throws SQLException {
callableStatement.setCharacterStream(parameterName, reader, length);
}
/**
* Sets the designated parameter to the given java.sql.Date value,
* using the given Calendar object. The driver uses
* the Calendar object to construct an SQL DATE value,
* which the driver then sends to the database. With a
* a Calendar object, the driver can calculate the date
* taking into account a custom timezone. If no
* Calendar object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @param cal the Calendar object the driver will use
* to construct the date
* @throws java.sql.SQLException if a database access error occurs
* @see #getDate
* @since 1.4
*/
public void setDate(String parameterName, Date x, Calendar cal) throws SQLException {
callableStatement.setDate(parameterName, x, cal);
}
/**
* Sets the designated parameter to the given java.sql.Time value,
* using the given Calendar object. The driver uses
* the Calendar object to construct an SQL TIME value,
* which the driver then sends to the database. With a
* a Calendar object, the driver can calculate the time
* taking into account a custom timezone. If no
* Calendar object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @param cal the Calendar object the driver will use
* to construct the time
* @throws java.sql.SQLException if a database access error occurs
* @see #getTime
* @since 1.4
*/
public void setTime(String parameterName, Time x, Calendar cal) throws SQLException {
callableStatement.setTime(parameterName, x, cal);
}
/**
* Sets the designated parameter to the given java.sql.Timestamp value,
* using the given Calendar object. The driver uses
* the Calendar object to construct an SQL TIMESTAMP value,
* which the driver then sends to the database. With a
* a Calendar object, the driver can calculate the timestamp
* taking into account a custom timezone. If no
* Calendar object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @param cal the Calendar object the driver will use
* to construct the timestamp
* @throws java.sql.SQLException if a database access error occurs
* @see #getTimestamp
* @since 1.4
*/
public void setTimestamp(String parameterName, Timestamp x, Calendar cal) throws SQLException {
callableStatement.setTimestamp(parameterName, x, cal);
}
/**
* Sets the designated parameter to SQL NULL.
* This version of the method setNull should
* 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. If
* a JDBC driver does not need the type code or type name information,
* it may ignore it.
*
* 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.
*
* @param parameterName the name of the parameter
* @param sqlType a value from java.sql.Types
* @param typeName the fully-qualified name of an SQL user-defined type;
* ignored if the parameter is not a user-defined type or
* SQL REF value
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public void setNull(String parameterName, int sqlType, String typeName) throws SQLException {
callableStatement.setNull(parameterName, sqlType, typeName);
}
/**
* Retrieves the value of a JDBC CHAR, VARCHAR,
* or LONGVARCHAR parameter as a String in
* the Java programming language.
*
* For the fixed-length type JDBC CHAR,
* the String object
* returned has exactly the same value the JDBC
* CHAR value had in the
* database, including any padding added by the database.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setString
* @since 1.4
*/
public String getString(String parameterName) throws SQLException {
return callableStatement.getString(parameterName);
}
/**
* Retrieves the value of a JDBC BIT parameter as a
* boolean in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is false.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBoolean
* @since 1.4
*/
public boolean getBoolean(String parameterName) throws SQLException {
return callableStatement.getBoolean(parameterName);
}
/**
* Retrieves the value of a JDBC TINYINT parameter as a byte
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setByte
* @since 1.4
*/
public byte getByte(String parameterName) throws SQLException {
return callableStatement.getByte(parameterName);
}
/**
* Retrieves the value of a JDBC SMALLINT parameter as a short
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setShort
* @since 1.4
*/
public short getShort(String parameterName) throws SQLException {
return callableStatement.getShort(parameterName);
}
/**
* Retrieves the value of a JDBC INTEGER parameter as an int
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL,
* the result is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setInt
* @since 1.4
*/
public int getInt(String parameterName) throws SQLException {
return callableStatement.getInt(parameterName);
}
/**
* Retrieves the value of a JDBC BIGINT parameter as a long
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL,
* the result is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setLong
* @since 1.4
*/
public long getLong(String parameterName) throws SQLException {
return callableStatement.getLong(parameterName);
}
/**
* Retrieves the value of a JDBC FLOAT parameter as a float
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL,
* the result is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setFloat
* @since 1.4
*/
public float getFloat(String parameterName) throws SQLException {
return callableStatement.getFloat(parameterName);
}
/**
* Retrieves the value of a JDBC DOUBLE parameter as a double
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL,
* the result is 0.
* @throws java.sql.SQLException if a database access error occurs
* @see #setDouble
* @since 1.4
*/
public double getDouble(String parameterName) throws SQLException {
return callableStatement.getDouble(parameterName);
}
/**
* Retrieves the value of a JDBC BINARY or VARBINARY
* parameter as an array of byte values in the Java
* programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result is
* null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBytes
* @since 1.4
*/
public byte[] getBytes(String parameterName) throws SQLException {
return callableStatement.getBytes(parameterName);
}
/**
* Retrieves the value of a JDBC DATE parameter as a
* java.sql.Date object.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setDate
* @since 1.4
*/
public Date getDate(String parameterName) throws SQLException {
return callableStatement.getDate(parameterName);
}
/**
* Retrieves the value of a JDBC TIME parameter as a
* java.sql.Time object.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTime
* @since 1.4
*/
public Time getTime(String parameterName) throws SQLException {
return callableStatement.getTime(parameterName);
}
/**
* Retrieves the value of a JDBC TIMESTAMP parameter as a
* java.sql.Timestamp object.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL NULL, the result
* is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTimestamp
* @since 1.4
*/
public Timestamp getTimestamp(String parameterName) throws SQLException {
return callableStatement.getTimestamp(parameterName);
}
/**
* Retrieves the value of a parameter as an Object in the Java
* programming language. If the value is an SQL NULL, the
* driver returns a Java null.
*
* 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 as java.sql.Types.OTHER, this method can be used
* to read database-specific abstract data types.
*
* @param parameterName the name of the parameter
* @return A java.lang.Object holding the OUT parameter value.
* @throws java.sql.SQLException if a database access error occurs
* @see java.sql.Types
* @see #setObject
* @since 1.4
*/
public Object getObject(String parameterName) throws SQLException {
return callableStatement.getObject(parameterName);
}
/**
* Retrieves the value of a JDBC NUMERIC parameter as a
* java.math.BigDecimal object with as many digits to the
* right of the decimal point as the value contains.
*
* @param parameterName the name of the parameter
* @return the parameter value in full precision. If the value is
* SQL NULL, the result is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setBigDecimal
* @since 1.4
*/
public BigDecimal getBigDecimal(String parameterName) throws SQLException {
return callableStatement.getBigDecimal(parameterName);
}
/**
* Retrieves the value of a JDBC REF(<structured-type>)
* parameter as a {@link java.sql.Ref} object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as a Ref object in the
* Java programming language. If the value was SQL NULL,
* the value null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public Ref getRef(String parameterName) throws SQLException {
return callableStatement.getRef(parameterName);
}
/**
* Retrieves the value of a JDBC BLOB parameter as a
* {@link java.sql.Blob} object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as a Blob object in the
* Java programming language. If the value was SQL NULL,
* the value null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public Blob getBlob(String parameterName) throws SQLException {
return callableStatement.getBlob(parameterName);
}
/**
* Retrieves the value of a JDBC CLOB parameter as a
* Clob object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as a Clob object in the
* Java programming language. If the value was SQL NULL,
* the value null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public Clob getClob(String parameterName) throws SQLException {
return callableStatement.getClob(parameterName);
}
/**
* Retrieves the value of a JDBC ARRAY parameter as an
* {@link java.sql.Array} object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as an Array object in
* Java programming language. If the value was SQL NULL,
* the value null is returned.
* @throws java.sql.SQLException if a database access error occurs
* @since 1.4
*/
public Array getArray(String parameterName) throws SQLException {
return callableStatement.getArray(parameterName);
}
/**
* Retrieves the value of a JDBC DATE parameter as a
* java.sql.Date object, using
* the given Calendar object
* to construct the date.
* With a Calendar object, the driver
* can calculate the date taking into account a custom timezone and locale.
* If no Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterName the name of the parameter
* @param cal the Calendar object the driver will use
* to construct the date
* @return the parameter value. If the value is SQL NULL,
* the result is null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setDate
* @since 1.4
*/
public Date getDate(String parameterName, Calendar cal) throws SQLException {
return callableStatement.getDate(parameterName, cal);
}
/**
* Retrieves the value of a JDBC TIME parameter as a
* java.sql.Time object, using
* the given Calendar object
* to construct the time.
* With a Calendar object, the driver
* can calculate the time taking into account a custom timezone and locale.
* If no Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterName the name of the parameter
* @param cal the Calendar object the driver will use
* to construct the time
* @return the parameter value; if the value is SQL NULL, the result is
* null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTime
* @since 1.4
*/
public Time getTime(String parameterName, Calendar cal) throws SQLException {
return callableStatement.getTime(parameterName, cal);
}
/**
* Retrieves the value of a JDBC TIMESTAMP parameter as a
* java.sql.Timestamp object, using
* the given Calendar object to construct
* the Timestamp object.
* With a Calendar object, the driver
* can calculate the timestamp taking into account a custom timezone and locale.
* If no Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterName the name of the parameter
* @param cal the Calendar object the driver will use
* to construct the timestamp
* @return the parameter value. If the value is SQL NULL, the result is
* null.
* @throws java.sql.SQLException if a database access error occurs
* @see #setTimestamp
* @since 1.4
*/
public Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException {
return callableStatement.getTimestamp(parameterName, cal);
}
/**
* Retrieves the value of a JDBC DATALINK parameter as a
* java.net.URL object.
*
* @param parameterName the name of the parameter
* @return the parameter value as a java.net.URL object in the
* Java programming language. If the value was SQL NULL, the
* value null is returned.
* @throws java.sql.SQLException if a database access error occurs,
* or if there is a problem with the URL
* @see #setURL
* @since 1.4
*/
public URL getURL(String parameterName) throws SQLException {
return callableStatement.getURL(parameterName);
}
/**
* Returns an object representing the value of OUT parameter
* i and uses map for 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 as java.sql.Types.OTHER, this method can
* be used to read database-specific abstract data types.
*
* @param i the first parameter is 1, the second is 2, and so on
* @param map the mapping from SQL type names to Java classes
* @return a java.lang.Object holding the OUT parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #setObject
* @since 1.2
*/
public Object getObject(int i, Map> map) throws SQLException {
return callableStatement.getObject(i, map);
}
/**
* Returns an object representing the value of OUT parameter
* i and uses map for 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 as java.sql.Types.OTHER, this method can
* be used to read database-specific abstract data types.
*
* @param parameterName the name of the parameter
* @param map the mapping from SQL type names to Java classes
* @return a java.lang.Object holding the OUT parameter value
* @throws java.sql.SQLException if a database access error occurs
* @see #setObject
* @since 1.4
*/
public Object getObject(String parameterName, Map> map) throws SQLException {
return callableStatement.getObject(parameterName, map);
}
}