Methods Summary |
---|
public java.sql.Array | getArray(int i)Retrieves the value of the designated JDBC ARRAY parameter as an
{@link Array} object in the Java programming language.
|
public java.sql.Array | getArray(java.lang.String parameterName)Retrieves the value of a JDBC ARRAY parameter as an
{@link Array} object in the Java programming language.
|
public java.math.BigDecimal | getBigDecimal(int parameterIndex, int scale)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.
|
public java.math.BigDecimal | getBigDecimal(int 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.
|
public java.math.BigDecimal | getBigDecimal(java.lang.String 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.
|
public java.sql.Blob | getBlob(int i)Retrieves the value of the designated JDBC BLOB parameter as a
{@link Blob} object in the Java programming language.
|
public java.sql.Blob | getBlob(java.lang.String parameterName)Retrieves the value of a JDBC BLOB parameter as a
{@link Blob} object in the Java programming language.
|
public boolean | getBoolean(int parameterIndex)Retrieves the value of the designated JDBC BIT parameter as a
boolean in the Java programming language.
|
public boolean | getBoolean(java.lang.String parameterName)Retrieves the value of a JDBC BIT parameter as a
boolean in the Java programming language.
|
public byte | getByte(java.lang.String parameterName)Retrieves the value of a JDBC TINYINT parameter as a byte
in the Java programming language.
|
public byte | getByte(int parameterIndex)Retrieves the value of the designated JDBC TINYINT parameter
as a byte in the Java programming language.
|
public byte[] | getBytes(int parameterIndex)Retrieves the value of the designated JDBC BINARY or
VARBINARY parameter as an array of byte
values in the Java programming language.
|
public byte[] | getBytes(java.lang.String parameterName)Retrieves the value of a JDBC BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language.
|
public java.sql.Clob | getClob(int i)Retrieves the value of the designated JDBC CLOB parameter as a
Clob object in the Java programming language.
|
public java.sql.Clob | getClob(java.lang.String parameterName)Retrieves the value of a JDBC CLOB parameter as a
Clob object in the Java programming language.
|
public java.sql.Date | getDate(int parameterIndex)Retrieves the value of the designated JDBC DATE parameter as a
java.sql.Date object.
|
public java.sql.Date | getDate(int parameterIndex, java.util.Calendar cal)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.
|
public java.sql.Date | getDate(java.lang.String parameterName)Retrieves the value of a JDBC DATE parameter as a
java.sql.Date object.
|
public java.sql.Date | getDate(java.lang.String parameterName, java.util.Calendar cal)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.
|
public double | getDouble(int parameterIndex)Retrieves the value of the designated JDBC DOUBLE parameter as a double
in the Java programming language.
|
public double | getDouble(java.lang.String parameterName)Retrieves the value of a JDBC DOUBLE parameter as a double
in the Java programming language.
|
public float | getFloat(int parameterIndex)Retrieves the value of the designated JDBC FLOAT parameter
as a float in the Java programming language.
|
public float | getFloat(java.lang.String parameterName)Retrieves the value of a JDBC FLOAT parameter as a float
in the Java programming language.
|
public int | getInt(java.lang.String parameterName)Retrieves the value of a JDBC INTEGER parameter as an int
in the Java programming language.
|
public int | getInt(int parameterIndex)Retrieves the value of the designated JDBC INTEGER parameter
as an int in the Java programming language.
|
public long | getLong(java.lang.String parameterName)Retrieves the value of a JDBC BIGINT parameter as a long
in the Java programming language.
|
public long | getLong(int parameterIndex)Retrieves the value of the designated JDBC BIGINT parameter
as a long in the Java programming language.
|
public java.lang.Object | getObject(int 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.
|
public java.lang.Object | getObject(int i, java.util.Map 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.
|
public java.lang.Object | getObject(java.lang.String 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.
|
public java.lang.Object | getObject(java.lang.String parameterName, java.util.Map 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.
|
public java.sql.Ref | getRef(int i)Retrieves the value of the designated JDBC REF(<structured-type>)
parameter as a {@link Ref} object in the Java programming language.
|
public java.sql.Ref | getRef(java.lang.String parameterName)Retrieves the value of a JDBC REF(<structured-type>)
parameter as a {@link Ref} object in the Java programming language.
|
public short | getShort(java.lang.String parameterName)Retrieves the value of a JDBC SMALLINT parameter as a short
in the Java programming language.
|
public short | getShort(int parameterIndex)Retrieves the value of the designated JDBC SMALLINT parameter
as a short in the Java programming language.
|
public java.lang.String | getString(int parameterIndex)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.
|
public java.lang.String | getString(java.lang.String parameterName)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.
|
public java.sql.Time | getTime(int parameterIndex)Retrieves the value of the designated JDBC TIME parameter as a
java.sql.Time object.
|
public java.sql.Time | getTime(int parameterIndex, java.util.Calendar 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.
|
public java.sql.Time | getTime(java.lang.String parameterName)Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object.
|
public java.sql.Time | getTime(java.lang.String parameterName, java.util.Calendar 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.
|
public java.sql.Timestamp | getTimestamp(int parameterIndex)Retrieves the value of the designated JDBC TIMESTAMP parameter as a
java.sql.Timestamp object.
|
public java.sql.Timestamp | getTimestamp(int parameterIndex, java.util.Calendar 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.
|
public java.sql.Timestamp | getTimestamp(java.lang.String parameterName)Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object.
|
public java.sql.Timestamp | getTimestamp(java.lang.String parameterName, java.util.Calendar 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.
|
public java.net.URL | getURL(int parameterIndex)Retrieves the value of the designated JDBC DATALINK parameter as a
java.net.URL object.
|
public java.net.URL | getURL(java.lang.String parameterName)Retrieves the value of a JDBC DATALINK parameter as a
java.net.URL object.
|
public void | registerOutParameter(int parameterIndex, int sqlType)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.
|
public void | registerOutParameter(int parameterIndex, int sqlType, int scale)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 .
|
public void | registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName)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.
|
public void | registerOutParameter(java.lang.String parameterName, int sqlType)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.
|
public void | registerOutParameter(java.lang.String parameterName, int sqlType, int scale)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 .
|
public void | registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName)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.
|
public void | setAsciiStream(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.
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.
|
public void | setBigDecimal(java.lang.String parameterName, java.math.BigDecimal 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.
|
public void | setBinaryStream(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.
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.
|
public void | setBoolean(java.lang.String parameterName, boolean x)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.
|
public void | setByte(java.lang.String parameterName, byte 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.
|
public void | setBytes(java.lang.String parameterName, byte[] 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.
|
public void | setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length)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.
|
public void | setDate(java.lang.String parameterName, java.sql.Date 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.
|
public void | setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)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.
|
public void | setDouble(java.lang.String parameterName, double 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.
|
public void | setFloat(java.lang.String parameterName, float 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.
|
public void | setInt(java.lang.String parameterName, int 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.
|
public void | setLong(java.lang.String parameterName, long 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.
|
public void | setNull(java.lang.String parameterName, int sqlType)Sets the designated parameter to SQL NULL .
Note: You must specify the parameter's SQL type.
|
public void | setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)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.
|
public void | setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)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.
|
public void | setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType)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.
|
public void | setObject(java.lang.String parameterName, java.lang.Object x)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.
|
public void | setShort(java.lang.String parameterName, short 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.
|
public void | setString(java.lang.String parameterName, java.lang.String 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.
|
public void | setTime(java.lang.String parameterName, java.sql.Time 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.
|
public void | setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar 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.
|
public void | setTimestamp(java.lang.String parameterName, java.sql.Timestamp 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.
|
public void | setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar 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.
|
public void | setURL(java.lang.String parameterName, java.net.URL val)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.
|
public boolean | wasNull()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.
|