RowSet
public
interface
RowSet
implements
ResultSet
javax.sql.RowSet |
The interface that adds support to the JDBC API for the JavaBeansTM component model. A rowset, which can be used as a JavaBeans component in a visual Bean development environment, can be created and configured at design time and executed at run time.
The RowSet
interface provides a set of JavaBeans properties that allow a RowSet
instance to be configured to connect to a JDBC data source and read
some data from the data source. A group of setter methods (setInt
,
setBytes
, setString
, and so on)
provide a way to pass input parameters to a rowset's command property.
This command is the SQL query the rowset uses when it gets its data from
a relational database, which is generally the case.
The RowSet
interface supports JavaBeans events, allowing other components in an
application to be notified when an event occurs on a rowset,
such as a change in its value.
The RowSet
interface is unique in that it is intended to be
implemented using the rest of the JDBC API. In other words, a
RowSet
implementation is a layer of software that executes "on top"
of a JDBC driver. Implementations of the RowSet
interface can
be provided by anyone, including JDBC driver vendors who want to
provide a RowSet
implementation as part of their JDBC products.
A RowSet
object may make a connection with a data source and
maintain that connection throughout its life cycle, in which case it is
called a connected rowset. A rowset may also make a connection with
a data source, get data from it, and then close the connection. Such a rowset
is called a disconnected rowset. A disconnected rowset may make
changes to its data while it is disconnected and then send the changes back
to the original source of the data, but it must reestablish a connection to do so.
A disconnected rowset may have a reader (a RowSetReader
object)
and a writer (a RowSetWriter
object) associated with it.
The reader may be implemented in many different ways to populate a rowset
with data, including getting data from a non-relational data source. The
writer can also be implemented in many different ways to propagate changes
made to the rowset's data back to the underlying data source.
Rowsets are easy to use. The RowSet
interface extends the standard
java.sql.ResultSet
interface. The RowSetMetaData
interface extends the java.sql.ResultSetMetaData
interface.
Thus, developers familiar
with the JDBC API will have to learn a minimal number of new APIs to
use rowsets. In addition, third-party software tools that work with
JDBC ResultSet
objects will also easily be made to work with rowsets.
Summary
Inherited constants |
---|
Public methods | |
---|---|
abstract
void
|
addRowSetListener(RowSetListener listener)
Registers the given listener so that it will be notified of events
that occur on this |
abstract
void
|
clearParameters()
Clears the parameters set for this |
abstract
void
|
execute()
Fills this |
abstract
String
|
getCommand()
Retrieves this |
abstract
String
|
getDataSourceName()
Retrieves the logical name that identifies the data source for this
|
abstract
boolean
|
getEscapeProcessing()
Retrieves whether escape processing is enabled for this
|
abstract
int
|
getMaxFieldSize()
Retrieves the maximum number of bytes that may be returned for certain column values. |
abstract
int
|
getMaxRows()
Retrieves the maximum number of rows that this |
abstract
String
|
getPassword()
Retrieves the password used to create a database connection. |
abstract
int
|
getQueryTimeout()
Retrieves the maximum number of seconds the driver will wait for a statement to execute. |
abstract
int
|
getTransactionIsolation()
Retrieves the transaction isolation level set for this
|
abstract
Map<String, Class<?>>
|
getTypeMap()
Retrieves the |
abstract
String
|
getUrl()
Retrieves the url property this |
abstract
String
|
getUsername()
Retrieves the username used to create a database connection for this
|
abstract
boolean
|
isReadOnly()
Retrieves whether this |
abstract
void
|
removeRowSetListener(RowSetListener listener)
Removes the specified listener from the list of components that will be
notified when an event occurs on this |
abstract
void
|
setArray(int i, Array x)
Sets the designated parameter in this |
abstract
void
|
setAsciiStream(String parameterName, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract
void
|
setAsciiStream(int parameterIndex, InputStream x)
Sets the designated parameter in this |
abstract
void
|
setAsciiStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter in this |
abstract
void
|
setAsciiStream(String parameterName, InputStream x)
Sets the designated parameter to the given input stream. |
abstract
void
|
setBigDecimal(int parameterIndex, BigDecimal x)
Sets the designated parameter in this |
abstract
void
|
setBigDecimal(String parameterName, BigDecimal x)
Sets the designated parameter to the given
|
abstract
void
|
setBinaryStream(String parameterName, InputStream x)
Sets the designated parameter to the given input stream. |
abstract
void
|
setBinaryStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter in this |
abstract
void
|
setBinaryStream(String parameterName, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. |
abstract
void
|
setBinaryStream(int parameterIndex, InputStream x)
Sets the designated parameter in this |
abstract
void
|
setBlob(int parameterIndex, InputStream inputStream, long length)
Sets the designated parameter to a |
abstract
void
|
setBlob(int parameterIndex, InputStream inputStream)
Sets the designated parameter to a |
abstract
void
|
setBlob(String parameterName, Blob x)
Sets the designated parameter to the given |
abstract
void
|
setBlob(String parameterName, InputStream inputStream, long length)
Sets the designated parameter to a |
abstract
void
|
setBlob(int i, Blob x)
Sets the designated parameter in this |
abstract
void
|
setBlob(String parameterName, InputStream inputStream)
Sets the designated parameter to a |
abstract
void
|
setBoolean(String parameterName, boolean x)
Sets the designated parameter to the given Java |
abstract
void
|
setBoolean(int parameterIndex, boolean x)
Sets the designated parameter in this |
abstract
void
|
setByte(int parameterIndex, byte x)
Sets the designated parameter in this |
abstract
void
|
setByte(String parameterName, byte x)
Sets the designated parameter to the given Java |
abstract
void
|
setBytes(String parameterName, byte[] x)
Sets the designated parameter to the given Java array of bytes. |
abstract
void
|
setBytes(int parameterIndex, byte[] x)
Sets the designated parameter in this |
abstract
void
|
setCharacterStream(int parameterIndex, Reader reader)
Sets the designated parameter in this |
abstract
void
|
setCharacterStream(String parameterName, Reader reader, int length)
Sets the designated parameter to the given |
abstract
void
|
setCharacterStream(String parameterName, Reader reader)
Sets the designated parameter to the given |
abstract
void
|
setCharacterStream(int parameterIndex, Reader reader, int length)
Sets the designated parameter in this |
abstract
void
|
setClob(int i, Clob x)
Sets the designated parameter in this |
abstract
void
|
setClob(int parameterIndex, Reader reader, long length)
Sets the designated parameter to a |
abstract
void
|
setClob(int parameterIndex, Reader reader)
Sets the designated parameter to a |
abstract
void
|
setClob(String parameterName, Clob x)
Sets the designated parameter to the given |
abstract
void
|
setClob(String parameterName, Reader reader, long length)
Sets the designated parameter to a |
abstract
void
|
setClob(String parameterName, Reader reader)
Sets the designated parameter to a |
abstract
void
|
setCommand(String cmd)
Sets this |
abstract
void
|
setConcurrency(int concurrency)
Sets the concurrency of this |
abstract
void
|
setDataSourceName(String name)
Sets the data source name property for this |
abstract
void
|
setDate(String parameterName, Date x, Calendar cal)
Sets the designated parameter to the given |
abstract
void
|
setDate(String parameterName, Date x)
Sets the designated parameter to the given |
abstract
void
|
setDate(int parameterIndex, Date x)
Sets the designated parameter in this |
abstract
void
|
setDate(int parameterIndex, Date x, Calendar cal)
Sets the designated parameter in this |
abstract
void
|
setDouble(int parameterIndex, double x)
Sets the designated parameter in this |
abstract
void
|
setDouble(String parameterName, double x)
Sets the designated parameter to the given Java |
abstract
void
|
setEscapeProcessing(boolean enable)
Sets escape processing for this |
abstract
void
|
setFloat(String parameterName, float x)
Sets the designated parameter to the given Java |
abstract
void
|
setFloat(int parameterIndex, float x)
Sets the designated parameter in this |
abstract
void
|
setInt(int parameterIndex, int x)
Sets the designated parameter in this |
abstract
void
|
setInt(String parameterName, int x)
Sets the designated parameter to the given Java |
abstract
void
|
setLong(int parameterIndex, long x)
Sets the designated parameter in this |
abstract
void
|
setLong(String parameterName, long x)
Sets the designated parameter to the given Java |
abstract
void
|
setMaxFieldSize(int max)
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. |
abstract
void
|
setMaxRows(int max)
Sets the maximum number of rows that this |
abstract
void
|
setNCharacterStream(String parameterName, Reader value, long length)
Sets the designated parameter to a |
abstract
void
|
setNCharacterStream(int parameterIndex, Reader value)
Sets the designated parameter in this |
abstract
void
|
setNCharacterStream(int parameterIndex, Reader value, long length)
Sets the designated parameter to a |
abstract
void
|
setNCharacterStream(String parameterName, Reader value)
Sets the designated parameter to a |
abstract
void
|
setNClob(String parameterName, Reader reader, long length)
Sets the designated parameter to a |
abstract
void
|
setNClob(String parameterName, NClob value)
Sets the designated parameter to a |
abstract
void
|
setNClob(int parameterIndex, Reader reader, long length)
Sets the designated parameter to a |
abstract
void
|
setNClob(String parameterName, Reader reader)
Sets the designated parameter to a |
abstract
void
|
setNClob(int parameterIndex, NClob value)
Sets the designated parameter to a |
abstract
void
|
setNClob(int parameterIndex, Reader reader)
Sets the designated parameter to a |
abstract
void
|
setNString(int parameterIndex, String value)
Sets the designated paramter to the given |
abstract
void
|
setNString(String parameterName, String value)
Sets the designated paramter to the given |
abstract
void
|
setNull(int paramIndex, int sqlType, String typeName)
Sets the designated parameter in this |
abstract
void
|
setNull(int parameterIndex, int sqlType)
Sets the designated parameter in this |
abstract
void
|
setNull(String parameterName, int sqlType)
Sets the designated parameter to SQL |
abstract
void
|
setNull(String parameterName, int sqlType, String typeName)
Sets the designated parameter to SQL |
abstract
void
|
setObject(String parameterName, Object x, int targetSqlType, int scale)
Sets the value of the designated parameter with the given object. |
abstract
void
|
setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength)
Sets the designated parameter in this |
abstract
void
|
setObject(int parameterIndex, Object x)
Sets the designated parameter in this |
abstract
void
|
setObject(String parameterName, Object x, int targetSqlType)
Sets the value of the designated parameter with the given object. |
abstract
void
|
setObject(int parameterIndex, Object x, int targetSqlType)
Sets the designated parameter in this |
abstract
void
|
setObject(String parameterName, Object x)
Sets the value of the designated parameter with the given object. |
abstract
void
|
setPassword(String password)
Sets the database password for this |
abstract
void
|
setQueryTimeout(int seconds)
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. |
abstract
void
|
setReadOnly(boolean value)
Sets whether this |
abstract
void
|
setRef(int i, Ref x)
Sets the designated parameter in this |
abstract
void
|
setRowId(int parameterIndex, RowId x)
Sets the designated parameter to the given |
abstract
void
|
setRowId(String parameterName, RowId x)
Sets the designated parameter to the given |
abstract
void
|
setSQLXML(int parameterIndex, SQLXML xmlObject)
Sets the designated parameter to the given |
abstract
void
|
setSQLXML(String parameterName, SQLXML xmlObject)
Sets the designated parameter to the given |
abstract
void
|
setShort(int parameterIndex, short x)
Sets the designated parameter in this |
abstract
void
|
setShort(String parameterName, short x)
Sets the designated parameter to the given Java |
abstract
void
|
setString(String parameterName, String x)
Sets the designated parameter to the given Java |
abstract
void
|
setString(int parameterIndex, String x)
Sets the designated parameter in this |
abstract
void
|
setTime(String parameterName, Time x, Calendar cal)
Sets the designated parameter to the given |
abstract
void
|
setTime(int parameterIndex, Time x, Calendar cal)
Sets the designated parameter in this |
abstract
void
|
setTime(String parameterName, Time x)
Sets the designated parameter to the given |
abstract
void
|
setTime(int parameterIndex, Time x)
Sets the designated parameter in this |
abstract
void
|
setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
Sets the designated parameter in this |
abstract
void
|
setTimestamp(String parameterName, Timestamp x, Calendar cal)
Sets the designated parameter to the given |
abstract
void
|
setTimestamp(String parameterName, Timestamp x)
Sets the designated parameter to the given |
abstract
void
|
setTimestamp(int parameterIndex, Timestamp x)
Sets the designated parameter in this |
abstract
void
|
setTransactionIsolation(int level)
Sets the transaction isolation level for this |
abstract
void
|
setType(int type)
Sets the type of this |
abstract
void
|
setTypeMap(Map<String, Class<?>> map)
Installs the given |
abstract
void
|
setURL(int parameterIndex, URL x)
Sets the designated parameter to the given |
abstract
void
|
setUrl(String url)
Sets the URL this |
abstract
void
|
setUsername(String name)
Sets the username property for this |
Inherited methods | |
---|---|
Public methods
addRowSetListener
public abstract void addRowSetListener (RowSetListener listener)
Registers the given listener so that it will be notified of events
that occur on this RowSet
object.
Parameters | |
---|---|
listener |
RowSetListener : a component that has implemented the RowSetListener
interface and wants to be notified when events occur on this
RowSet object |
See also:
clearParameters
public abstract void clearParameters ()
Clears the parameters set for this RowSet
object's command.
In general, parameter values remain in force for repeated use of a
RowSet
object. Setting a parameter value automatically clears its
previous value. However, in some cases it is useful to immediately
release the resources used by the current parameter values, which can
be done by calling the method clearParameters
.
Throws | |
---|---|
SQLException |
if a database access error occurs |
execute
public abstract void execute ()
Fills this RowSet
object with data.
The execute
method may use the following properties
to create a connection for reading data: url, data source name,
user name, password, transaction isolation, and type map.
The execute
method may use the following properties
to create a statement to execute a command:
command, read only, maximum field size,
maximum rows, escape processing, and query timeout.
If the required properties have not been set, an exception is thrown. If this method is successful, the current contents of the rowset are discarded and the rowset's metadata is also (re)set. If there are outstanding updates, they are ignored.
If this RowSet
object does not maintain a continuous connection
with its source of data, it may use a reader (a RowSetReader
object) to fill itself with data. In this case, a reader will have been
registered with this RowSet
object, and the method
execute
will call on the reader's readData
method as part of its implementation.
Throws | |
---|---|
SQLException |
if a database access error occurs or any of the properties necessary for making a connection and creating a statement have not been set |
getCommand
public abstract String getCommand ()
Retrieves this RowSet
object's command property.
The command property contains a command string, which must be an SQL
query, that can be executed to fill the rowset with data.
The default value is null
.
Returns | |
---|---|
String |
the command string; may be null |
See also:
getDataSourceName
public abstract String getDataSourceName ()
Retrieves the logical name that identifies the data source for this
RowSet
object.
Returns | |
---|---|
String |
a data source name |
See also:
getEscapeProcessing
public abstract boolean getEscapeProcessing ()
Retrieves whether escape processing is enabled for this
RowSet
object.
If escape scanning is enabled, which is the default, the driver will do
escape substitution before sending an SQL statement to the database.
Returns | |
---|---|
boolean |
true if escape processing is enabled;
false if it is disabled |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
getMaxFieldSize
public abstract int getMaxFieldSize ()
Retrieves the maximum number of bytes that may be returned
for certain column values.
This limit applies only to BINARY
,
VARBINARY
, LONGVARBINARYBINARY
, CHAR
,
VARCHAR
, LONGVARCHAR
, NCHAR
and NVARCHAR
columns.
If the limit is exceeded, the excess data is silently discarded.
Returns | |
---|---|
int |
the current maximum column size limit; zero means that there is no limit |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
getMaxRows
public abstract int getMaxRows ()
Retrieves the maximum number of rows that this RowSet
object can contain.
If the limit is exceeded, the excess rows are silently dropped.
Returns | |
---|---|
int |
the current maximum number of rows that this RowSet
object can contain; zero means unlimited |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
getPassword
public abstract String getPassword ()
Retrieves the password used to create a database connection.
The password property is set at run time before calling the method
execute
. It is not usually part of the serialized state
of a RowSet
object.
Returns | |
---|---|
String |
the password for making a database connection |
See also:
getQueryTimeout
public abstract int getQueryTimeout ()
Retrieves the maximum number of seconds the driver will wait for
a statement to execute.
If this limit is exceeded, an SQLException
is thrown.
Returns | |
---|---|
int |
the current query timeout limit in seconds; zero means unlimited |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
getTransactionIsolation
public abstract int getTransactionIsolation ()
Retrieves the transaction isolation level set for this
RowSet
object.
Returns | |
---|---|
int |
the transaction isolation level; one of
Connection.TRANSACTION_READ_UNCOMMITTED ,
Connection.TRANSACTION_READ_COMMITTED ,
Connection.TRANSACTION_REPEATABLE_READ , or
Connection.TRANSACTION_SERIALIZABLE |
See also:
getTypeMap
public abstract Map<String, Class<?>> getTypeMap ()
Retrieves the Map
object associated with this
RowSet
object, which specifies the custom mapping
of SQL user-defined types, if any. The default is for the
type map to be empty.
Returns | |
---|---|
Map<String, Class<?>> |
a java.util.Map object containing the names of
SQL user-defined types and the Java classes to which they are
to be mapped |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
getUrl
public abstract String getUrl ()
Retrieves the url property this RowSet
object will use to
create a connection if it uses the DriverManager
instead of a DataSource
object to establish the connection.
The default value is null
.
Returns | |
---|---|
String |
a string url |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
getUsername
public abstract String getUsername ()
Retrieves the username used to create a database connection for this
RowSet
object.
The username property is set at run time before calling the method
execute
. It is
not usually part of the serialized state of a RowSet
object.
Returns | |
---|---|
String |
the username property |
See also:
isReadOnly
public abstract boolean isReadOnly ()
Retrieves whether this RowSet
object is read-only.
If updates are possible, the default is for a rowset to be
updatable.
Attempts to update a read-only rowset will result in an
SQLException
being thrown.
Returns | |
---|---|
boolean |
true if this RowSet object is
read-only; false if it is updatable |
See also:
removeRowSetListener
public abstract void removeRowSetListener (RowSetListener listener)
Removes the specified listener from the list of components that will be
notified when an event occurs on this RowSet
object.
Parameters | |
---|---|
listener |
RowSetListener : a component that has been registered as a listener for this
RowSet object |
See also:
setArray
public abstract void setArray (int i, Array x)
Sets the designated parameter in this RowSet
object's command
with the given Array
value. The driver will convert this
to the ARRAY
value that the Array
object
represents before sending it to the database.
Parameters | |
---|---|
i |
int : the first parameter is 1, the second is 2, ... |
x |
Array : an object representing an SQL array |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setAsciiStream
public abstract void setAsciiStream (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
InputStream : the Java input stream that contains the ASCII parameter value |
length |
int : the number of bytes in the stream |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setAsciiStream
public abstract void setAsciiStream (int parameterIndex, InputStream x)
Sets the designated parameter in this RowSet
object's command
to the given input stream.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
InputStream : the Java input stream that contains the ASCII parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setAsciiStream
public abstract void setAsciiStream (int parameterIndex, InputStream x, int length)
Sets the designated parameter in this RowSet
object's command
to the given java.io.InputStream
value.
It may be more practical to send a very large ASCII value via a
java.io.InputStream
rather than as a LONGVARCHAR
parameter. The driver will read the data from the stream
as needed until it reaches end-of-file.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
InputStream : the Java input stream that contains the ASCII parameter value |
length |
int : the number of bytes in the stream |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setAsciiStream
public abstract void setAsciiStream (String parameterName, InputStream x)
Sets the designated parameter to the given input stream.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
InputStream : the Java input stream that contains the ASCII parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBigDecimal
public abstract void setBigDecimal (int parameterIndex, BigDecimal x)
Sets the designated parameter in this RowSet
object's command
to the given java.math.BigDeciaml
value.
The driver converts this to
an SQL NUMERIC
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
BigDecimal : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setBigDecimal
public abstract void setBigDecimal (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
BigDecimal : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setBinaryStream
public abstract void setBinaryStream (String parameterName, InputStream x)
Sets the designated parameter to the given input stream.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
InputStream : the java input stream which contains the binary parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBinaryStream
public abstract void setBinaryStream (int parameterIndex, InputStream x, int length)
Sets the designated parameter in this RowSet
object's command
to the given java.io.InputStream
value.
It may be more practical to send a very large binary value via a
java.io.InputStream
rather than as a LONGVARBINARY
parameter. The driver will read the data from the stream
as needed until it reaches end-of-file.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
InputStream : the java input stream which contains the binary parameter value |
length |
int : the number of bytes in the stream |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setBinaryStream
public abstract void setBinaryStream (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
InputStream : the java input stream which contains the binary parameter value |
length |
int : the number of bytes in the stream |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBinaryStream
public abstract void setBinaryStream (int parameterIndex, InputStream x)
Sets the designated parameter in this RowSet
object's command
to the given input stream.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
InputStream : the java input stream which contains the binary parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
public abstract void setBlob (int parameterIndex, InputStream inputStream, long length)
Sets the designated parameter to a InputStream
object. The inputstream must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the PreparedStatement
is executed.
This method differs from the setBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB
. When the setBinaryStream
method is used,
the driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARBINARY
or a BLOB
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1,
the second is 2, ... |
inputStream |
InputStream : An object that contains the data to set the parameter
value to. |
length |
long : the number of bytes in the parameter data. |
Throws | |
---|---|
SQLException |
if a database access error occurs,
this method is called on a closed PreparedStatement ,
if parameterIndex does not correspond
to a parameter marker in the SQL statement, if the length specified
is less than zero or if the number of bytes in the inputstream does not match
the specfied length. |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
public abstract void setBlob (int parameterIndex, InputStream inputStream)
Sets the designated parameter to a InputStream
object.
This method differs from the setBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB
. When the setBinaryStream
method is used,
the driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARBINARY
or a BLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBlob
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1,
the second is 2, ... |
inputStream |
InputStream : An object that contains the data to set the parameter
value to. |
Throws | |
---|---|
SQLException |
if a database access error occurs,
this method is called on a closed PreparedStatement or
if parameterIndex does not correspond
to a parameter marker in the SQL statement, |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
public abstract void setBlob (String parameterName, Blob x)
Sets the designated parameter to the given java.sql.Blob
object.
The driver converts this to an SQL BLOB
value when it
sends it to the database.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Blob : a Blob object that maps an SQL BLOB value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
public abstract void setBlob (String parameterName, InputStream inputStream, long length)
Sets the designated parameter to a InputStream
object. The inputstream
must contain the number
of characters specified by length, otherwise a SQLException
will be
generated when the CallableStatement
is executed.
This method differs from the setBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB
. When the setBinaryStream
method is used,
the driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARBINARY
or a BLOB
Parameters | |
---|---|
parameterName |
String : the name of the parameter to be set
the second is 2, ... |
inputStream |
InputStream : An object that contains the data to set the parameter
value to. |
length |
long : the number of bytes in the parameter data. |
Throws | |
---|---|
SQLException |
if parameterIndex does not correspond
to a parameter marker in the SQL statement, or if the length specified
is less than zero; if the number of bytes in the inputstream does not match
the specfied length; if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBlob
public abstract void setBlob (int i, Blob x)
Sets the designated parameter in this RowSet
object's command
with the given Blob
value. The driver will convert this
to the BLOB
value that the Blob
object
represents before sending it to the database.
Parameters | |
---|---|
i |
int : the first parameter is 1, the second is 2, ... |
x |
Blob : an object representing a BLOB |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setBlob
public abstract void setBlob (String parameterName, InputStream inputStream)
Sets the designated parameter to a InputStream
object.
This method differs from the setBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB
. When the setBinaryStream
method is used,
the driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARBINARY
or a BLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBlob
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
inputStream |
InputStream : An object that contains the data to set the parameter
value to. |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setBoolean
public abstract void setBoolean (String parameterName, boolean x)
Sets the designated parameter to the given Java boolean
value.
The driver converts this
to an SQL BIT
or BOOLEAN
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
boolean : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setBoolean
public abstract void setBoolean (int parameterIndex, boolean x)
Sets the designated parameter in this RowSet
object's command
to the given Java boolean
value. The driver converts this to
an SQL BIT
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
boolean : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setByte
public abstract void setByte (int parameterIndex, byte x)
Sets the designated parameter in this RowSet
object's command
to the given Java byte
value. The driver converts this to
an SQL TINYINT
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
byte : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setByte
public abstract void setByte (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
byte : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setBytes
public abstract void setBytes (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
byte : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setBytes
public abstract void setBytes (int parameterIndex, byte[] x)
Sets the designated parameter in this RowSet
object's command
to the given Java array of byte
values. Before sending it to the
database, the driver converts this to an SQL VARBINARY
or
LONGVARBINARY
value, depending on the argument's size relative
to the driver's limits on VARBINARY
values.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
byte : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setCharacterStream
public abstract void setCharacterStream (int parameterIndex, Reader reader)
Sets the designated parameter in this RowSet
object's command
to the given Reader
object.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
reader |
Reader : the java.io.Reader object that contains the
Unicode data |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setCharacterStream
public abstract void setCharacterStream (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
reader |
Reader : the java.io.Reader object that
contains the UNICODE data used as the designated parameter |
length |
int : the number of characters in the stream |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setCharacterStream
public abstract void setCharacterStream (String parameterName, Reader reader)
Sets the designated parameter to the given Reader
object.
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.
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
reader |
Reader : the java.io.Reader object that contains the
Unicode data |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setCharacterStream
public abstract void setCharacterStream (int parameterIndex, Reader reader, int length)
Sets the designated parameter in this RowSet
object's command
to the given java.io.Reader
value.
It may be more practical to send a very large UNICODE value via a
java.io.Reader
rather than as a LONGVARCHAR
parameter. The driver will read the data from the stream
as needed until it reaches end-of-file.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
reader |
Reader : the Reader object that contains the UNICODE data
to be set |
length |
int : the number of characters in the stream |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setClob
public abstract void setClob (int i, Clob x)
Sets the designated parameter in this RowSet
object's command
with the given Clob
value. The driver will convert this
to the CLOB
value that the Clob
object
represents before sending it to the database.
Parameters | |
---|---|
i |
int : the first parameter is 1, the second is 2, ... |
x |
Clob : an object representing a CLOB |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setClob
public abstract void setClob (int parameterIndex, Reader reader, long length)
Sets the designated parameter to a Reader
object. The reader must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the PreparedStatement
is executed.
This method differs from the setCharacterStream (int, Reader, int)
method
because it informs the driver that the parameter value should be sent to
the server as a CLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARCHAR
or a CLOB
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1, the second is 2, ... |
reader |
Reader : An object that contains the data to set the parameter value to. |
length |
long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException |
if a database access error occurs, this method is called on
a closed PreparedStatement , if parameterIndex does not correspond to a parameter
marker in the SQL statement, or if the length specified is less than zero. |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
public abstract void setClob (int parameterIndex, Reader reader)
Sets the designated parameter to a Reader
object.
This method differs from the setCharacterStream (int, Reader)
method
because it informs the driver that the parameter value should be sent to
the server as a CLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARCHAR
or a CLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setClob
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1, the second is 2, ... |
reader |
Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException |
if a database access error occurs, this method is called on
a closed PreparedStatement or if parameterIndex does not correspond to a parameter
marker in the SQL statement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
public abstract void setClob (String parameterName, Clob x)
Sets the designated parameter to the given java.sql.Clob
object.
The driver converts this to an SQL CLOB
value when it
sends it to the database.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Clob : a Clob object that maps an SQL CLOB value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
public abstract void setClob (String parameterName, Reader reader, long length)
Sets the designated parameter to a Reader
object. The reader
must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the CallableStatement
is executed.
This method differs from the setCharacterStream (int, Reader, int)
method
because it informs the driver that the parameter value should be sent to
the server as a CLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR
or a CLOB
Parameters | |
---|---|
parameterName |
String : the name of the parameter to be set |
reader |
Reader : An object that contains the data to set the parameter value to. |
length |
long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException |
if parameterIndex does not correspond to a parameter
marker in the SQL statement; if the length specified is less than zero;
a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setClob
public abstract void setClob (String parameterName, Reader reader)
Sets the designated parameter to a Reader
object.
This method differs from the setCharacterStream (int, Reader)
method
because it informs the driver that the parameter value should be sent to
the server as a CLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR
or a CLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setClob
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
reader |
Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException |
if a database access error occurs or this method is called on
a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setCommand
public abstract void setCommand (String cmd)
Sets this RowSet
object's command property to the given
SQL query.
This property is optional
when a rowset gets its data from a data source that does not support
commands, such as a spreadsheet.
Parameters | |
---|---|
cmd |
String : the SQL query that will be used to get the data for this
RowSet object; may be null |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setConcurrency
public abstract void setConcurrency (int concurrency)
Sets the concurrency of this RowSet
object to the given
concurrency level. This method is used to change the concurrency level
of a rowset, which is by default ResultSet.CONCUR_READ_ONLY
Parameters | |
---|---|
concurrency |
int : one of the ResultSet constants specifying a
concurrency level: ResultSet.CONCUR_READ_ONLY or
ResultSet.CONCUR_UPDATABLE |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setDataSourceName
public abstract void setDataSourceName (String name)
Sets the data source name property for this RowSet
object to the
given String
.
The value of the data source name property can be used to do a lookup of
a DataSource
object that has been registered with a naming
service. After being retrieved, the DataSource
object can be
used to create a connection to the data source that it represents.
Parameters | |
---|---|
name |
String : the logical name of the data source for this RowSet
object; may be null |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setDate
public abstract void setDate (String parameterName, Date x, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Date : the parameter value |
cal |
Calendar : the Calendar object the driver will use
to construct the date |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setDate
public abstract void setDate (String parameterName, Date x)
Sets the designated parameter to the given java.sql.Date
value
using the default time zone of the virtual machine that is running
the application.
The driver converts this
to an SQL DATE
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Date : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setDate
public abstract void setDate (int parameterIndex, Date x)
Sets the designated parameter in this RowSet
object's command
to the given java.sql.Date
value. The driver converts this to
an SQL DATE
value before sending it to the database, using the
default java.util.Calendar
to calculate the date.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Date : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setDate
public abstract void setDate (int parameterIndex, Date x, Calendar cal)
Sets the designated parameter in this RowSet
object's command
with the given java.sql.Date
value. The driver will convert this
to an SQL DATE
value, using the given java.util.Calendar
object to calculate the date.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Date : the parameter value |
cal |
Calendar : the java.util.Calendar object to use for calculating the date |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setDouble
public abstract void setDouble (int parameterIndex, double x)
Sets the designated parameter in this RowSet
object's command
to the given Java double
value. The driver converts this to
an SQL DOUBLE
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
double : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setDouble
public abstract void setDouble (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
double : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setEscapeProcessing
public abstract void setEscapeProcessing (boolean enable)
Sets escape processing for this RowSet
object on or
off. If escape scanning is on (the default), the driver will do
escape substitution before sending an SQL statement to the database.
Parameters | |
---|---|
enable |
boolean : true to enable escape processing;
false to disable it |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setFloat
public abstract void setFloat (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
float : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setFloat
public abstract void setFloat (int parameterIndex, float x)
Sets the designated parameter in this RowSet
object's command
to the given Java float
value. The driver converts this to
an SQL REAL
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
float : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setInt
public abstract void setInt (int parameterIndex, int x)
Sets the designated parameter in this RowSet
object's command
to the given Java int
value. The driver converts this to
an SQL INTEGER
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
int : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setInt
public abstract void setInt (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
int : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setLong
public abstract void setLong (int parameterIndex, long x)
Sets the designated parameter in this RowSet
object's command
to the given Java long
value. The driver converts this to
an SQL BIGINT
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
long : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setLong
public abstract void setLong (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
long : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setMaxFieldSize
public abstract void setMaxFieldSize (int max)
Sets the maximum number of bytes that can be returned for a column
value to the given number of bytes.
This limit applies only to BINARY
,
VARBINARY
, LONGVARBINARYBINARY
, CHAR
,
VARCHAR
, LONGVARCHAR
, NCHAR
and NVARCHAR
columns.
If the limit is exceeded, the excess data is silently discarded.
For maximum portability, use values greater than 256.
Parameters | |
---|---|
max |
int : the new max column size limit in bytes; zero means unlimited |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setMaxRows
public abstract void setMaxRows (int max)
Sets the maximum number of rows that this RowSet
object can contain to the specified number.
If the limit is exceeded, the excess rows are silently dropped.
Parameters | |
---|---|
max |
int : the new maximum number of rows; zero means unlimited |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setNCharacterStream
public abstract void setNCharacterStream (String parameterName, Reader value, long length)
Sets the designated parameter to a Reader
object. The
Reader
reads 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.
Parameters | |
---|---|
parameterName |
String : the name of the column to be set |
value |
Reader : the parameter value |
length |
long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException |
if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs |
setNCharacterStream
public abstract void setNCharacterStream (int parameterIndex, Reader value)
Sets the designated parameter in this RowSet
object's command
to a Reader
object. The
Reader
reads 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
setNCharacterStream
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : of the first parameter is 1, the second is 2, ... |
value |
Reader : the parameter value |
Throws | |
---|---|
SQLException |
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 closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNCharacterStream
public abstract void setNCharacterStream (int parameterIndex, Reader value, long length)
Sets the designated parameter to a Reader
object. The
Reader
reads 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.
Parameters | |
---|---|
parameterIndex |
int : of the first parameter is 1, the second is 2, ... |
value |
Reader : the parameter value |
length |
long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException |
if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs |
setNCharacterStream
public abstract void setNCharacterStream (String parameterName, Reader value)
Sets the designated parameter to a Reader
object. The
Reader
reads 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
setNCharacterStream
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
value |
Reader : the parameter value |
Throws | |
---|---|
SQLException |
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 closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
public abstract void setNClob (String parameterName, Reader reader, long length)
Sets the designated parameter to a Reader
object. The reader
must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the CallableStatement
is executed.
This method differs from the setCharacterStream (int, Reader, int)
method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR
or a NCLOB
Parameters | |
---|---|
parameterName |
String : the name of the parameter to be set |
reader |
Reader : An object that contains the data to set the parameter value to. |
length |
long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException |
if parameterIndex does not correspond to a parameter
marker in the SQL statement; 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 closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
public abstract void setNClob (String parameterName, NClob value)
Sets the designated parameter to a java.sql.NClob
object. The object
implements the java.sql.NClob
interface. This NClob
object maps to a SQL NCLOB
.
Parameters | |
---|---|
parameterName |
String : the name of the column to be set |
value |
NClob : the parameter value |
Throws | |
---|---|
SQLException |
if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs |
setNClob
public abstract void setNClob (int parameterIndex, Reader reader, long length)
Sets the designated parameter to a Reader
object. The reader must contain the number
of characters specified by length otherwise a SQLException
will be
generated when the PreparedStatement
is executed.
This method differs from the setCharacterStream (int, Reader, int)
method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGNVARCHAR
or a NCLOB
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1, the second is 2, ... |
reader |
Reader : An object that contains the data to set the parameter value to. |
length |
long : the number of characters in the parameter data. |
Throws | |
---|---|
SQLException |
if parameterIndex does not correspond to a parameter
marker in the SQL statement; 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 closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
public abstract void setNClob (String parameterName, Reader reader)
Sets the designated parameter to a Reader
object.
This method differs from the setCharacterStream (int, Reader)
method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR
or a NCLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNClob
which takes a length parameter.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
reader |
Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException |
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 closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNClob
public abstract void setNClob (int parameterIndex, NClob value)
Sets the designated parameter to a java.sql.NClob
object. The driver converts this to a
SQL NCLOB
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
int : of the first parameter is 1, the second is 2, ... |
value |
NClob : the parameter value |
Throws | |
---|---|
SQLException |
if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs |
setNClob
public abstract void setNClob (int parameterIndex, Reader reader)
Sets the designated parameter to a Reader
object.
This method differs from the setCharacterStream (int, Reader)
method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB
. When the setCharacterStream
method is used, the
driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGNVARCHAR
or a NCLOB
Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNClob
which takes a length parameter.
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1, the second is 2, ... |
reader |
Reader : An object that contains the data to set the parameter value to. |
Throws | |
---|---|
SQLException |
if parameterIndex does not correspond to a parameter
marker in the SQL statement;
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 closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNString
public abstract void setNString (int parameterIndex, String value)
Sets the designated paramter to the given String
object.
The driver converts this to a SQL NCHAR
or
NVARCHAR
or LONGNVARCHAR
value
(depending on the argument's
size relative to the driver's limits on NVARCHAR
values)
when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
int : of the first parameter is 1, the second is 2, ... |
value |
String : the parameter value |
Throws | |
---|---|
SQLException |
if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs |
setNString
public abstract void setNString (String parameterName, String value)
Sets the designated paramter to the given String
object.
The driver converts this to a SQL NCHAR
or
NVARCHAR
or LONGNVARCHAR
Parameters | |
---|---|
parameterName |
String : the name of the column to be set |
value |
String : the parameter value |
Throws | |
---|---|
SQLException |
if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs |
setNull
public abstract void setNull (int paramIndex, int sqlType, String typeName)
Sets the designated parameter in this RowSet
object's SQL
command to SQL NULL
. This version of the method setNull
should be used for SQL user-defined types (UDTs) and REF
type
parameters. Examples of UDTs 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 UDT or REF
parameter. In the case of a UDT,
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 UDT 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 typeName parameter is ignored.
Parameters | |
---|---|
paramIndex |
int : the first parameter is 1, the second is 2, ... |
sqlType |
int : a value from java.sql.Types |
typeName |
String : the fully qualified name of an SQL UDT or the type
name of the SQL structured type being referenced by a REF
type; ignored if the parameter is not a UDT or REF type |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setNull
public abstract void setNull (int parameterIndex, int sqlType)
Sets the designated parameter in this RowSet
object's SQL
command to SQL NULL
.
Note: You must specify the parameter's SQL type.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
sqlType |
int : a SQL type code defined by java.sql.Types |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setNull
public abstract void setNull (String parameterName, int sqlType)
Sets the designated parameter to SQL NULL
.
Note: You must specify the parameter's SQL type.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
sqlType |
int : the SQL type code defined in java.sql.Types |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setNull
public abstract void setNull (String parameterName, int sqlType, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
sqlType |
int : a value from java.sql.Types |
typeName |
String : 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 | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setObject
public abstract void setObject (String parameterName, 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
, NClob
,
Struct
, java.net.URL
,
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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Object : the object containing the input parameter value |
targetSqlType |
int : the SQL type (as defined in java.sql.Types) to be
sent to the database. The scale argument may further qualify this type. |
scale |
int : 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 | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if targetSqlType is
a ARRAY , BLOB , CLOB ,
DATALINK , JAVA_OBJECT , NCHAR ,
NCLOB , NVARCHAR , LONGNVARCHAR ,
REF , ROWID , SQLXML
or STRUCT data type and the JDBC driver does not support
this data type |
See also:
setObject
public abstract void setObject (int parameterIndex, Object x, int targetSqlType, int scaleOrLength)
Sets the designated parameter in this RowSet
object's command
with the given Java Object
. For integral values, the
java.lang
equivalent objects should be used (for example,
an instance of the class Integer
for an int
).
If the second argument is an InputStream
then the stream must contain
the number of bytes specified by scaleOrLength. If the second argument is a
Reader
then the reader must contain the number of characters specified * by scaleOrLength. If these conditions are not true the driver will generate a
SQLException
when the prepared statement is executed.
The given Java object will be converted to the targetSqlType before being sent to the database.
If the object is of a class implementing SQLData
,
the rowset should call the method SQLData.writeSQL
to write the object to an SQLOutput
data stream.
If, on the other hand, the object is of a class implementing
Ref
, Blob
, Clob
, NClob
,
Struct
, java.net.URL
,
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.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Object : the object containing the input parameter value |
targetSqlType |
int : the SQL type (as defined in java.sql.Types )
to be sent to the database. The scale argument may further qualify this
type. |
scaleOrLength |
int : for java.sql.Types.DECIMAL
or java.sql.Types.NUMERIC types ,
this is the number of digits after the decimal point. For
Java Object types InputStream and Reader ,
this is the length
of the data in the stream or reader. For all other types,
this value will be ignored. |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setObject
public abstract void setObject (int parameterIndex, Object x)
Sets the designated parameter in this RowSet
object's command
with a Java Object
. For integral values, the
java.lang
equivalent objects should be used.
The JDBC specification provides a standard mapping from Java Object types to SQL types. The driver will convert the given Java object to its standard SQL mapping before sending it 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 SQLData
,
the rowset should call the method SQLData.writeSQL
to write the object to an SQLOutput
data stream.
If, on the other hand, the object is of a class implementing
Ref
, Blob
, Clob
, NClob
,
Struct
, java.net.URL
,
or Array
, the driver should pass it to the database as a
value of the corresponding SQL type.
An exception is thrown if there is an ambiguity, for example, if the object is of a class implementing more than one of these interfaces.
Parameters | |
---|---|
parameterIndex |
int : The first parameter is 1, the second is 2, ... |
x |
Object : The object containing the input parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setObject
public abstract void setObject (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Object : the object containing the input parameter value |
targetSqlType |
int : the SQL type (as defined in java.sql.Types) to be
sent to the database |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if targetSqlType is
a ARRAY , BLOB , CLOB ,
DATALINK , JAVA_OBJECT , NCHAR ,
NCLOB , NVARCHAR , LONGNVARCHAR ,
REF , ROWID , SQLXML
or STRUCT data type and the JDBC driver does not support
this data type |
See also:
setObject
public abstract void setObject (int parameterIndex, Object x, int targetSqlType)
Sets the designated parameter in this RowSet
object's command
with a Java Object
. For integral values, the
java.lang
equivalent objects should be used.
This method is like setObject
above, but the scale used is the scale
of the second parameter. Scalar values have a scale of zero. Literal
values have the scale present in the literal.
Even though it is supported, it is not recommended that this method be called with floating point input values.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Object : the object containing the input parameter value |
targetSqlType |
int : the SQL type (as defined in java.sql.Types )
to be sent to the database |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setObject
public abstract void setObject (String parameterName, 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
, NClob
,
Struct
, java.net.URL
,
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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Object : the object containing the input parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs,
this method is called on a closed CallableStatement or if the given
Object parameter is ambiguous |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setPassword
public abstract void setPassword (String password)
Sets the database password for this RowSet
object to
the given String
.
Parameters | |
---|---|
password |
String : the password string |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setQueryTimeout
public abstract void setQueryTimeout (int seconds)
Sets the maximum time the driver will wait for
a statement to execute to the given number of seconds.
If this limit is exceeded, an SQLException
is thrown.
Parameters | |
---|---|
seconds |
int : the new query timeout limit in seconds; zero means
that there is no limit |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setReadOnly
public abstract void setReadOnly (boolean value)
Sets whether this RowSet
object is read-only to the
given boolean
.
Parameters | |
---|---|
value |
boolean : true if read-only; false if
updatable |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setRef
public abstract void setRef (int i, Ref x)
Sets the designated parameter in this RowSet
object's command
with the given Ref
value. The driver will convert this
to the appropriate REF(<structured-type>)
value.
Parameters | |
---|---|
i |
int : the first parameter is 1, the second is 2, ... |
x |
Ref : an object representing data of an SQL REF type |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setRowId
public abstract void setRowId (int parameterIndex, RowId x)
Sets the designated parameter to the given java.sql.RowId
object. The
driver converts this to a SQL ROWID
value when it sends it
to the database
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
RowId : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setRowId
public abstract void setRowId (String parameterName, RowId x)
Sets the designated parameter to the given java.sql.RowId
object. The
driver converts this to a SQL ROWID
when it sends it to the
database.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
RowId : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setSQLXML
public abstract void setSQLXML (int parameterIndex, SQLXML xmlObject)
Sets the designated parameter to the given java.sql.SQLXML
object. The driver converts this to an
SQL XML
value when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
int : index of the first parameter is 1, the second is 2, ... |
xmlObject |
SQLXML : a SQLXML object that maps an SQL XML value |
Throws | |
---|---|
SQLException |
if a database access error occurs, this method
is called on a closed result set,
the java.xml.transform.Result ,
Writer or OutputStream has not been closed
for the SQLXML object or
if there is an error processing the XML value. The getCause method
of the exception may provide a more detailed exception, for example, if the
stream does not contain valid XML. |
setSQLXML
public abstract void setSQLXML (String parameterName, SQLXML xmlObject)
Sets the designated parameter to the given java.sql.SQLXML
object. The driver converts this to an
SQL XML
value when it sends it to the database.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
xmlObject |
SQLXML : a SQLXML object that maps an SQL XML value |
Throws | |
---|---|
SQLException |
if a database access error occurs, this method
is called on a closed result set,
the java.xml.transform.Result ,
Writer or OutputStream has not been closed
for the SQLXML object or
if there is an error processing the XML value. The getCause method
of the exception may provide a more detailed exception, for example, if the
stream does not contain valid XML. |
setShort
public abstract void setShort (int parameterIndex, short x)
Sets the designated parameter in this RowSet
object's command
to the given Java short
value. The driver converts this to
an SQL SMALLINT
value before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
short : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setShort
public abstract void setShort (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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
short : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setString
public abstract void setString (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
String : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setString
public abstract void setString (int parameterIndex, String x)
Sets the designated parameter in this RowSet
object's command
to the given Java String
value. Before sending it to the
database, 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.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
String : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setTime
public abstract void setTime (String parameterName, Time x, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Time : the parameter value |
cal |
Calendar : the Calendar object the driver will use
to construct the time |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setTime
public abstract void setTime (int parameterIndex, Time x, Calendar cal)
Sets the designated parameter in this RowSet
object's command
with the given java.sql.Time
value. The driver will convert this
to an SQL TIME
value, using the given java.util.Calendar
object to calculate it, before sending it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Time : the parameter value |
cal |
Calendar : the java.util.Calendar object to use for calculating the time |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setTime
public abstract void setTime (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Time : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setTime
public abstract void setTime (int parameterIndex, Time x)
Sets the designated parameter in this RowSet
object's command
to the given java.sql.Time
value. The driver converts this to
an SQL TIME
value before sending it to the database, using the
default java.util.Calendar
to calculate it.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Time : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setTimestamp
public abstract void setTimestamp (int parameterIndex, Timestamp x, Calendar cal)
Sets the designated parameter in this RowSet
object's command
with the given java.sql.Timestamp
value. The driver will
convert this to an SQL TIMESTAMP
value, using the given
java.util.Calendar
object to calculate it, before sending it to the
database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Timestamp : the parameter value |
cal |
Calendar : the java.util.Calendar object to use for calculating the
timestamp |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setTimestamp
public abstract void setTimestamp (String parameterName, Timestamp x, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Timestamp : the parameter value |
cal |
Calendar : the Calendar object the driver will use
to construct the timestamp |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setTimestamp
public abstract void setTimestamp (String parameterName, 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.
Parameters | |
---|---|
parameterName |
String : the name of the parameter |
x |
Timestamp : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed CallableStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
See also:
setTimestamp
public abstract void setTimestamp (int parameterIndex, Timestamp x)
Sets the designated parameter in this RowSet
object's command
to the given java.sql.Timestamp
value. The driver converts this to
an SQL TIMESTAMP
value before sending it to the database, using the
default java.util.Calendar
to calculate it.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
Timestamp : the parameter value |
Throws | |
---|---|
SQLException |
if a database access error occurs |
setTransactionIsolation
public abstract void setTransactionIsolation (int level)
Sets the transaction isolation level for this RowSet
obejct.
Parameters | |
---|---|
level |
int : the transaction isolation level; one of
Connection.TRANSACTION_READ_UNCOMMITTED ,
Connection.TRANSACTION_READ_COMMITTED ,
Connection.TRANSACTION_REPEATABLE_READ , or
Connection.TRANSACTION_SERIALIZABLE |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setType
public abstract void setType (int type)
Sets the type of this RowSet
object to the given type.
This method is used to change the type of a rowset, which is by
default read-only and non-scrollable.
Parameters | |
---|---|
type |
int : one of the ResultSet constants specifying a type:
ResultSet.TYPE_FORWARD_ONLY ,
ResultSet.TYPE_SCROLL_INSENSITIVE , or
ResultSet.TYPE_SCROLL_SENSITIVE |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setTypeMap
public abstract void setTypeMap (Map<String, Class<?>> map)
Installs the given java.util.Map
object as the default
type map for this RowSet
object. This type map will be
used unless another type map is supplied as a method parameter.
Parameters | |
---|---|
map |
Map : a java.util.Map object containing the names of
SQL user-defined types and the Java classes to which they are
to be mapped |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setURL
public abstract void setURL (int parameterIndex, URL x)
Sets the designated parameter to the given java.net.URL
value.
The driver converts this to an SQL DATALINK
value
when it sends it to the database.
Parameters | |
---|---|
parameterIndex |
int : the first parameter is 1, the second is 2, ... |
x |
URL : the java.net.URL object to be set |
Throws | |
---|---|
SQLException |
if a database access error occurs or
this method is called on a closed PreparedStatement |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
setUrl
public abstract void setUrl (String url)
Sets the URL this RowSet
object will use when it uses the
DriverManager
to create a connection.
Setting this property is optional. If a URL is used, a JDBC driver
that accepts the URL must be loaded before the
rowset is used to connect to a database. The rowset will use the URL
internally to create a database connection when reading or writing
data. Either a URL or a data source name is used to create a
connection, whichever was set to non null value most recently.
Parameters | |
---|---|
url |
String : a string value; may be null |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also:
setUsername
public abstract void setUsername (String name)
Sets the username property for this RowSet
object to the
given String
.
Parameters | |
---|---|
name |
String : a user name |
Throws | |
---|---|
SQLException |
if a database access error occurs |
See also: