public interface RowSet extends ResultSet
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.
CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE| Modifier and Type | Method and Description |
|---|---|
void |
addRowSetListener(RowSetListener
Registers the given listener so that it will be notified of events that occur on this
RowSet object.
|
void |
clearParameters()
Clears the parameters set for this
RowSet object's command.
|
void |
execute()
Fills this
RowSet object with data.
|
String |
getCommand()
Retrieves this
RowSet object's command property.
|
String |
getDataSourceName()
Retrieves the logical name that identifies the data source for this
RowSet object.
|
boolean |
getEscapeProcessing()
Retrieves whether escape processing is enabled for this
RowSet object.
|
int |
getMaxFieldSize()
Retrieves the maximum number of bytes that may be returned for certain column values.
|
int |
getMaxRows()
Retrieves the maximum number of rows that this
RowSet object can contain.
|
String |
getPassword()
Retrieves the password used to create a database connection.
|
int |
getQueryTimeout()
Retrieves the maximum number of seconds the driver will wait for a statement to execute.
|
int |
getTransactionIsolation()
Retrieves the transaction isolation level set for this
RowSet object.
|
Map |
getTypeMap()
Retrieves the
Map object associated with this
RowSet object, which specifies the custom mapping of SQL user-defined types, if any.
|
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.
|
String |
getUsername()
Retrieves the username used to create a database connection for this
RowSet object.
|
boolean |
isReadOnly()
Retrieves whether this
RowSet object is read-only.
|
void |
removeRowSetListener(RowSetListener
Removes the specified listener from the list of components that will be notified when an event occurs on this
RowSet object.
|
void |
setArray(int i, Array
Sets the designated parameter in this
RowSet object's command with the given
Array value.
|
void |
setAsciiStream(int parameterIndex, InputStream
Sets the designated parameter in this
RowSet object's command to the given input stream.
|
void |
setAsciiStream(int parameterIndex, InputStream
Sets the designated parameter in this
RowSet object's command to the given
java.io.InputStream value.
|
void |
setAsciiStream(String
Sets the designated parameter to the given input stream.
|
void |
setAsciiStream(String
Sets the designated parameter to the given input stream, which will have the specified number of bytes.
|
void |
setBigDecimal(int parameterIndex, BigDecimal
Sets the designated parameter in this
RowSet object's command to the given
java.math.BigDeciaml value.
|
void |
setBigDecimal(String
Sets the designated parameter to the given
java.math.BigDecimal value.
|
void |
setBinaryStream(int parameterIndex, InputStream
Sets the designated parameter in this
RowSet object's command to the given input stream.
|
void |
setBinaryStream(int parameterIndex, InputStream
Sets the designated parameter in this
RowSet object's command to the given
java.io.InputStream value.
|
void |
setBinaryStream(String
Sets the designated parameter to the given input stream.
|
void |
setBinaryStream(String
Sets the designated parameter to the given input stream, which will have the specified number of bytes.
|
void |
setBlob(int i, Blob
Sets the designated parameter in this
RowSet object's command with the given
Blob value.
|
void |
setBlob(int parameterIndex, InputStream
Sets the designated parameter to a
InputStream object.
|
void |
setBlob(int parameterIndex, InputStream
Sets the designated parameter to a
InputStream object.
|
void |
setBlob(String
Sets the designated parameter to the given
java.sql.Blob object.
|
void |
setBlob(String
Sets the designated parameter to a
InputStream object.
|
void |
setBlob(String
Sets the designated parameter to a
InputStream object.
|
void |
setBoolean(int parameterIndex, boolean x)
Sets the designated parameter in this
RowSet object's command to the given Java
boolean value.
|
void |
setBoolean(String
Sets the designated parameter to the given Java
boolean value.
|
void |
setByte(int parameterIndex, byte x)
Sets the designated parameter in this
RowSet object's command to the given Java
byte value.
|
void |
setByte(String
Sets the designated parameter to the given Java
byte value.
|
void |
setBytes(int parameterIndex, byte[] x)
Sets the designated parameter in this
RowSet object's command to the given Java array of
byte values.
|
void |
setBytes(String
Sets the designated parameter to the given Java array of bytes.
|
void |
setCharacterStream(int parameterIndex, Reader
Sets the designated parameter in this
RowSet object's command to the given
Reader object.
|
void |
setCharacterStream(int parameterIndex, Reader
Sets the designated parameter in this
RowSet object's command to the given
java.io.Reader value.
|
void |
setCharacterStream(String
Sets the designated parameter to the given
Reader object.
|
void |
setCharacterStream(String
Sets the designated parameter to the given
Reader object, which is the given number of characters long.
|
void |
setClob(int i, Clob
Sets the designated parameter in this
RowSet object's command with the given
Clob value.
|
void |
setClob(int parameterIndex, Reader
Sets the designated parameter to a
Reader object.
|
void |
setClob(int parameterIndex, Reader
Sets the designated parameter to a
Reader object.
|
void |
setClob(String
Sets the designated parameter to the given
java.sql.Clob object.
|
void |
setClob(String
Sets the designated parameter to a
Reader object.
|
void |
setClob(String
Sets the designated parameter to a
Reader object.
|
void |
setCommand(String
Sets this
RowSet object's command property to the given SQL query.
|
void |
setConcurrency(int concurrency)
Sets the concurrency of this
RowSet object to the given concurrency level.
|
void |
setDataSourceName(String
Sets the data source name property for this
RowSet object to the given
String.
|
void |
setDate(int parameterIndex, Date
Sets the designated parameter in this
RowSet object's command to the given
java.sql.Date value.
|
void |
setDate(int parameterIndex, Date
Sets the designated parameter in this
RowSet object's command with the given
java.sql.Date value.
|
void |
setDate(String
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.
|
void |
setDate(String
Sets the designated parameter to the given
java.sql.Date value, using the given
Calendar object.
|
void |
setDouble(int parameterIndex, double x)
Sets the designated parameter in this
RowSet object's command to the given Java
double value.
|
void |
setDouble(String
Sets the designated parameter to the given Java
double value.
|
void |
setEscapeProcessing(boolean enable)
Sets escape processing for this
RowSet object on or off.
|
void |
setFloat(int parameterIndex, float x)
Sets the designated parameter in this
RowSet object's command to the given Java
float value.
|
void |
setFloat(String
Sets the designated parameter to the given Java
float value.
|
void |
setInt(int parameterIndex, int x)
Sets the designated parameter in this
RowSet object's command to the given Java
int value.
|
void |
setInt(String
Sets the designated parameter to the given Java
int value.
|
void |
setLong(int parameterIndex, long x)
Sets the designated parameter in this
RowSet object's command to the given Java
long value.
|
void |
setLong(String
Sets the designated parameter to the given Java
long value.
|
void |
setMaxFieldSize(int max)
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes.
|
void |
setMaxRows(int max)
Sets the maximum number of rows that this
RowSet object can contain to the specified number.
|
void |
setNCharacterStream(int parameterIndex, Reader
Sets the designated parameter in this
RowSet object's command to a
Reader object.
|
void |
setNCharacterStream(int parameterIndex, Reader
Sets the designated parameter to a
Reader object.
|
void |
setNCharacterStream(String
Sets the designated parameter to a
Reader object.
|
void |
setNCharacterStream(String
Sets the designated parameter to a
Reader object.
|
void |
setNClob(int parameterIndex, NClob
Sets the designated parameter to a
java.sql.NClob object.
|
void |
setNClob(int parameterIndex, Reader
Sets the designated parameter to a
Reader object.
|
void |
setNClob(int parameterIndex, Reader
Sets the designated parameter to a
Reader object.
|
void |
setNClob(String
Sets the designated parameter to a
java.sql.NClob object.
|
void |
setNClob(String
Sets the designated parameter to a
Reader object.
|
void |
setNClob(String
Sets the designated parameter to a
Reader object.
|
void |
setNString(int parameterIndex, String
Sets the designated parameter to the given
String object.
|
void |
setNString(String
Sets the designated parameter to the given
String object.
|
void |
setNull(int parameterIndex, int sqlType)
Sets the designated parameter in this
RowSet object's SQL command to SQL
NULL.
|
void |
setNull(int paramIndex, int sqlType, String
Sets the designated parameter in this
RowSet object's SQL command to SQL
NULL.
|
void |
setNull(String
Sets the designated parameter to SQL
NULL.
|
void |
setNull(String
Sets the designated parameter to SQL
NULL.
|
void |
setObject(int parameterIndex, Object
Sets the designated parameter in this
RowSet object's command with a Java
Object.
|
void |
setObject(int parameterIndex, Object
Sets the designated parameter in this
RowSet object's command with a Java
Object.
|
void |
setObject(int parameterIndex, Object
Sets the designated parameter in this
RowSet object's command with the given Java
Object.
|
void |
setObject(String
Sets the value of the designated parameter with the given object.
|
void |
setObject(String
Sets the value of the designated parameter with the given object.
|
void |
setObject(String
Sets the value of the designated parameter with the given object.
|
void |
setPassword(String
Sets the database password for this
RowSet object to the given
String.
|
void |
setQueryTimeout(int seconds)
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds.
|
void |
setReadOnly(boolean value)
Sets whether this
RowSet object is read-only to the given
boolean.
|
void |
setRef(int i, Ref
Sets the designated parameter in this
RowSet object's command with the given
Ref value.
|
void |
setRowId(int parameterIndex, RowId
Sets the designated parameter to the given
java.sql.RowId object.
|
void |
setRowId(String
Sets the designated parameter to the given
java.sql.RowId object.
|
void |
setShort(int parameterIndex, short x)
Sets the designated parameter in this
RowSet object's command to the given Java
short value.
|
void |
setShort(String
Sets the designated parameter to the given Java
short value.
|
void |
setSQLXML(int parameterIndex, SQLXML
Sets the designated parameter to the given
java.sql.SQLXML object.
|
void |
setSQLXML(String
Sets the designated parameter to the given
java.sql.SQLXML object.
|
void |
setString(int parameterIndex, String
Sets the designated parameter in this
RowSet object's command to the given Java
String value.
|
void |
setString(String
Sets the designated parameter to the given Java
String value.
|
void |
setTime(int parameterIndex, Time
Sets the designated parameter in this
RowSet object's command to the given
java.sql.Time value.
|
void |
setTime(int parameterIndex, Time
Sets the designated parameter in this
RowSet object's command with the given
java.sql.Time value.
|
void |
setTime(String
Sets the designated parameter to the given
java.sql.Time value.
|
void |
setTime(String
Sets the designated parameter to the given
java.sql.Time value, using the given
Calendar object.
|
void |
setTimestamp(int parameterIndex, Timestamp
Sets the designated parameter in this
RowSet object's command to the given
java.sql.Timestamp value.
|
void |
setTimestamp(int parameterIndex, Timestamp
Sets the designated parameter in this
RowSet object's command with the given
java.sql.Timestamp value.
|
void |
setTimestamp(String
Sets the designated parameter to the given
java.sql.Timestamp value.
|
void |
setTimestamp(String
Sets the designated parameter to the given
java.sql.Timestamp value, using the given
Calendar object.
|
void |
setTransactionIsolation(int level)
Sets the transaction isolation level for this
RowSet object.
|
void |
setType(int type)
Sets the type of this
RowSet object to the given type.
|
void |
setTypeMap(Map
Installs the given
java.util.Map object as the default type map for this
RowSet object.
|
void |
setURL(int parameterIndex, URL
Sets the designated parameter to the given
java.net.URL value.
|
void |
setUrl(String
Sets the URL this
RowSet object will use when it uses the
DriverManager to create a connection.
|
void |
setUsername(String
Sets the username property for this
RowSet object to the given
String.
|
absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getHoldability, getInt, getInt, getLong, getLong, getMetaData, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateRowId, updateRowId, updateShort, updateShort, updateSQLXML, updateSQLXML, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNullisWrapperFor, unwrapStringgetUrl() throws SQLException
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.
SQLException - if a database access error occurs
setUrl(java.lang.String)
void setUrl(Stringurl) throws SQLException
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.
url - a string value; may be
null
SQLException - if a database access error occurs
getUrl()
StringgetDataSourceName()
RowSet object.
setDataSourceName(java.lang.String),
setUrl(java.lang.String)
void setDataSourceName(Stringname) throws SQLException
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.
name - the logical name of the data source for this
RowSet object; may be
null
SQLException - if a database access error occurs
getDataSourceName()
StringgetUsername()
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.
setUsername(java.lang.String)
void setUsername(Stringname) throws SQLException
RowSet object to the given
String.
name - a user name
SQLException - if a database access error occurs
getUsername()
StringgetPassword()
execute. It is not usually part of the serialized state of a
RowSet object.
setPassword(java.lang.String)
void setPassword(Stringpassword) throws SQLException
RowSet object to the given
String.
password - the password string
SQLException - if a database access error occurs
getPassword()
int getTransactionIsolation()
RowSet object.
Connection.TRANSACTION_READ_UNCOMMITTED,
Connection.TRANSACTION_READ_COMMITTED,
Connection.TRANSACTION_REPEATABLE_READ, or
Connection.TRANSACTION_SERIALIZABLE
setTransactionIsolation(int)
void setTransactionIsolation(int level)
throws SQLException
RowSet object.
level - the transaction isolation level; one of
Connection.TRANSACTION_READ_UNCOMMITTED,
Connection.TRANSACTION_READ_COMMITTED,
Connection.TRANSACTION_REPEATABLE_READ, or
Connection.TRANSACTION_SERIALIZABLE
SQLException - if a database access error occurs
getTransactionIsolation()
Map<String ,Class <?>> getTypeMap() throws SQLException
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.
java.util.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped
SQLException - if a database access error occurs
setTypeMap(java.util.Map<java.lang.String, java.lang.Class<?>>)
void setTypeMap(Map<String ,Class <?>> map) throws SQLException
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.
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
SQLException - if a database access error occurs
getTypeMap()
StringgetCommand()
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.
null
setCommand(java.lang.String)
void setCommand(Stringcmd) throws SQLException
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.
cmd - the SQL query that will be used to get the data for this
RowSet object; may be
null
SQLException - if a database access error occurs
getCommand()
boolean isReadOnly()
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.
true if this
RowSet object is read-only;
false if it is updatable
setReadOnly(boolean)
void setReadOnly(boolean value)
throws SQLException
RowSet object is read-only to the given
boolean.
value -
true if read-only;
false if updatable
SQLException - if a database access error occurs
isReadOnly()
int getMaxFieldSize()
throws SQLException
BINARY,
VARBINARY,
LONGVARBINARYBINARY,
CHAR,
VARCHAR,
LONGVARCHAR,
NCHAR and
NVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.
SQLException - if a database access error occurs
setMaxFieldSize(int)
void setMaxFieldSize(int max)
throws SQLException
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.
max - the new max column size limit in bytes; zero means unlimited
SQLException - if a database access error occurs
getMaxFieldSize()
int getMaxRows()
throws SQLException
RowSet object can contain. If the limit is exceeded, the excess rows are silently dropped.
RowSet object can contain; zero means unlimited
SQLException - if a database access error occurs
setMaxRows(int)
void setMaxRows(int max)
throws SQLException
RowSet object can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped.
max - the new maximum number of rows; zero means unlimited
SQLException - if a database access error occurs
getMaxRows()
boolean getEscapeProcessing()
throws SQLException
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.
true if escape processing is enabled;
false if it is disabled
SQLException - if a database access error occurs
setEscapeProcessing(boolean)
void setEscapeProcessing(boolean enable)
throws SQLException
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.
enable -
true to enable escape processing;
false to disable it
SQLException - if a database access error occurs
getEscapeProcessing()
int getQueryTimeout()
throws SQLException
SQLException is thrown.
SQLException - if a database access error occurs
setQueryTimeout(int)
void setQueryTimeout(int seconds)
throws SQLException
SQLException is thrown.
seconds - the new query timeout limit in seconds; zero means that there is no limit
SQLException - if a database access error occurs
getQueryTimeout()
void setType(int type)
throws SQLException
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.
type - one of the
ResultSet constants specifying a type:
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.TYPE_SCROLL_INSENSITIVE, or
ResultSet.TYPE_SCROLL_SENSITIVE
SQLException - if a database access error occurs
ResultSet.getType()
void setConcurrency(int concurrency)
throws SQLException
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
concurrency - one of the
ResultSet constants specifying a concurrency level:
ResultSet.CONCUR_READ_ONLY or
ResultSet.CONCUR_UPDATABLE
SQLException - if a database access error occurs
ResultSet.getConcurrency()
void setNull(int parameterIndex,
int sqlType)
throws SQLException
RowSet object's SQL command to SQL
NULL.
Note: You must specify the parameter's SQL type.
parameterIndex - the first parameter is 1, the second is 2, ...
sqlType - a SQL type code defined by
java.sql.Types
SQLException - if a database access error occurs
void setNull(StringparameterName, int sqlType) throws SQLException
NULL.
Note: You must specify the parameter's SQL type.
parameterName - the name of the parameter
sqlType - the SQL type code defined in
java.sql.Types
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
void setNull(int paramIndex,
int sqlType,
String typeName)
throws SQLException
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.
paramIndex - the first parameter is 1, the second is 2, ...
sqlType - a value from
java.sql.Types
typeName - 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
SQLException - if a database access error occurs
void setNull(StringparameterName, int sqlType, String typeName) throws SQLException
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.
parameterName - the name of the parameter
sqlType - a value from
java.sql.Types
typeName - the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL
REF value
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
void setBoolean(int parameterIndex,
boolean x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setBoolean(StringparameterName, boolean x) throws SQLException
boolean value. The driver converts this to an SQL
BIT or
BOOLEAN value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getBoolean(int)
void setByte(int parameterIndex,
byte x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setByte(StringparameterName, byte x) throws SQLException
byte value. The driver converts this to an SQL
TINYINT value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getByte(int)
void setShort(int parameterIndex,
short x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setShort(StringparameterName, short x) throws SQLException
short value. The driver converts this to an SQL
SMALLINT value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getShort(int)
void setInt(int parameterIndex,
int x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setInt(StringparameterName, int x) throws SQLException
int value. The driver converts this to an SQL
INTEGER value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getInt(int)
void setLong(int parameterIndex,
long x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setLong(StringparameterName, long x) throws SQLException
long value. The driver converts this to an SQL
BIGINT value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getLong(int)
void setFloat(int parameterIndex,
float x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setFloat(StringparameterName, float x) throws SQLException
float value. The driver converts this to an SQL
FLOAT value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getFloat(int)
void setDouble(int parameterIndex,
double x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setDouble(StringparameterName, double x) throws SQLException
double value. The driver converts this to an SQL
DOUBLE value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getDouble(int)
void setBigDecimal(int parameterIndex,
BigDecimal x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setBigDecimal(StringparameterName, BigDecimal x) throws SQLException
java.math.BigDecimal value. The driver converts this to an SQL
NUMERIC value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getBigDecimal(int, int)
void setString(int parameterIndex,
String x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setString(StringparameterName, String x) throws SQLException
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.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getString(int)
void setBytes(int parameterIndex,
byte[] x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setBytes(StringparameterName, byte[] x) throws SQLException
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.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getBytes(int)
void setDate(int parameterIndex,
Date x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setTime(int parameterIndex,
Time x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setTimestamp(int parameterIndex,
Timestamp x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setTimestamp(StringparameterName, Timestamp x) throws SQLException
java.sql.Timestamp value. The driver converts this to an SQL
TIMESTAMP value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getTimestamp(int)
void setAsciiStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the Java input stream that contains the ASCII parameter value
length - the number of bytes in the stream
SQLException - if a database access error occurs
void setAsciiStream(StringparameterName, InputStream x, int length) throws SQLException
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.
parameterName - the name of the parameter
x - the Java input stream that contains the ASCII parameter value
length - the number of bytes in the stream
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
void setBinaryStream(int parameterIndex,
InputStream x,
int length)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the java input stream which contains the binary parameter value
length - the number of bytes in the stream
SQLException - if a database access error occurs
void setBinaryStream(StringparameterName, InputStream x, int length) throws SQLException
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.
parameterName - the name of the parameter
x - the java input stream which contains the binary parameter value
length - the number of bytes in the stream
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
void setCharacterStream(int parameterIndex,
Reader reader,
int length)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
reader - the
Reader object that contains the UNICODE data to be set
length - the number of characters in the stream
SQLException - if a database access error occurs
void setCharacterStream(StringparameterName, Reader reader, int length) throws SQLException
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.
parameterName - the name of the parameter
reader - the
java.io.Reader object that contains the UNICODE data used as the designated parameter
length - the number of characters in the stream
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
void setAsciiStream(int parameterIndex,
InputStream x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the Java input stream that contains the ASCII parameter value
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
void setAsciiStream(StringparameterName, InputStream x) throws SQLException
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.
parameterName - the name of the parameter
x - the Java input stream that contains the ASCII parameter value
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
void setBinaryStream(int parameterIndex,
InputStream x)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the java input stream which contains the binary parameter value
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
void setBinaryStream(StringparameterName, InputStream x) throws SQLException
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.
parameterName - the name of the parameter
x - the java input stream which contains the binary parameter value
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
void setCharacterStream(int parameterIndex,
Reader reader)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
reader - the
java.io.Reader object that contains the Unicode data
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
void setCharacterStream(StringparameterName, Reader reader) throws SQLException
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.
parameterName - the name of the parameter
reader - the
java.io.Reader object that contains the Unicode data
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
void setNCharacterStream(int parameterIndex,
Reader value)
throws SQLException
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.
parameterIndex - of the first parameter is 1, the second is 2, ...
value - the parameter value
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
void setObject(int parameterIndex,
Object x,
int targetSqlType,
int scaleOrLength)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the object containing the input parameter value
targetSqlType - the SQL type (as defined in
java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
scaleOrLength - 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.
SQLException - if a database access error occurs
Types
void setObject(StringparameterName, Object x, int targetSqlType, int scale) throws SQLException
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.
parameterName - the name of the parameter
x - the object containing the input parameter value
targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
scale - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.
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
Types,
ResultSet.getObject(int)
void setObject(int parameterIndex,
Object x,
int targetSqlType)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the object containing the input parameter value
targetSqlType - the SQL type (as defined in
java.sql.Types) to be sent to the database
SQLException - if a database access error occurs
void setObject(StringparameterName, Object x, int targetSqlType) throws SQLException
setObject above, except that it assumes a scale of zero.
parameterName - the name of the parameter
x - the object containing the input parameter value
targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database
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
ResultSet.getObject(int)
void setObject(StringparameterName, Object x) throws SQLException
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.
parameterName - the name of the parameter
x - the object containing the input parameter value
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
ResultSet.getObject(int)
void setObject(int parameterIndex,
Object x)
throws SQLException
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.
parameterIndex - The first parameter is 1, the second is 2, ...
x - The object containing the input parameter value
SQLException - if a database access error occurs
void setRef(int i,
Ref x)
throws SQLException
RowSet object's command with the given
Ref value. The driver will convert this to the appropriate
REF(<structured-type>) value.
i - the first parameter is 1, the second is 2, ...
x - an object representing data of an SQL
REF type
SQLException - if a database access error occurs
void setBlob(int i,
Blob x)
throws SQLException
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.
i - the first parameter is 1, the second is 2, ...
x - an object representing a BLOB
SQLException - if a database access error occurs
void setBlob(int parameterIndex,
InputStream inputStream,
long length)
throws SQLException
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
parameterIndex - index of the first parameter is 1, the second is 2, ...
inputStream - An object that contains the data to set the parameter value to.
length - the number of bytes in the parameter data.
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 specified length.
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
void setBlob(int parameterIndex,
InputStream inputStream)
throws SQLException
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.
parameterIndex - index of the first parameter is 1, the second is 2, ...
inputStream - An object that contains the data to set the parameter value to.
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
void setBlob(StringparameterName, InputStream inputStream, long length) throws SQLException
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
parameterName - the name of the parameter to be set the second is 2, ...
inputStream - An object that contains the data to set the parameter value to.
length - the number of bytes in the parameter data.
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 specified 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
void setBlob(StringparameterName, Blob x) throws SQLException
java.sql.Blob object. The driver converts this to an SQL
BLOB value when it sends it to the database.
parameterName - the name of the parameter
x - a
Blob object that maps an SQL
BLOB value
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
void setBlob(StringparameterName, InputStream inputStream) throws SQLException
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.
parameterName - the name of the parameter
inputStream - An object that contains the data to set the parameter value to.
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
void setClob(int i,
Clob x)
throws SQLException
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.
i - the first parameter is 1, the second is 2, ...
x - an object representing a CLOB
SQLException - if a database access error occurs
void setClob(int parameterIndex,
Reader reader,
long length)
throws SQLException
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
parameterIndex - index of the first parameter is 1, the second is 2, ...
reader - An object that contains the data to set the parameter value to.
length - the number of characters in the parameter data.
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
void setClob(int parameterIndex,
Reader reader)
throws SQLException
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.
parameterIndex - index of the first parameter is 1, the second is 2, ...
reader - An object that contains the data to set the parameter value to.
SQLException - if a database access error occurs, this method is called on a closed
PreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement
SQLFeatureNotSupportedException - if the JDBC driver does not support this method
void setClob(StringparameterName, Reader reader, long length) throws SQLException
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
parameterName - the name of the parameter to be set
reader - An object that contains the data to set the parameter value to.
length - the number of characters in the parameter data.
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
void setClob(StringparameterName, Clob x) throws SQLException
java.sql.Clob object. The driver converts this to an SQL
CLOB value when it sends it to the database.
parameterName - the name of the parameter
x - a
Clob object that maps an SQL
CLOB value
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
void setClob(StringparameterName, Reader reader) throws SQLException
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.
parameterName - the name of the parameter
reader - An object that contains the data to set the parameter value to.
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
void setArray(int i,
Array x)
throws SQLException
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.
i - the first parameter is 1, the second is 2, ...
x - an object representing an SQL array
SQLException - if a database access error occurs
void setDate(int parameterIndex,
Date x,
Calendar cal)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
cal - the
java.util.Calendar object to use for calculating the date
SQLException - if a database access error occurs
void setDate(StringparameterName, Date x) throws SQLException
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.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getDate(int)
void setDate(StringparameterName, Date x, Calendar cal) throws SQLException
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.
parameterName - the name of the parameter
x - the parameter value
cal - the
Calendar object the driver will use to construct the date
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
ResultSet.getDate(int)
void setTime(int parameterIndex,
Time x,
Calendar cal)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
cal - the
java.util.Calendar object to use for calculating the time
SQLException - if a database access error occurs
void setTime(StringparameterName, Time x) throws SQLException
java.sql.Time value. The driver converts this to an SQL
TIME value when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
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
ResultSet.getTime(int)
void setTime(StringparameterName, Time x, Calendar cal) throws SQLException
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.
parameterName - the name of the parameter
x - the parameter value
cal - the
Calendar object the driver will use to construct the time
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
ResultSet.getTime(int)
void setTimestamp(int parameterIndex,
Timestamp x,
Calendar cal)
throws SQLException
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.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
cal - the
java.util.Calendar object to use for calculating the timestamp
SQLException - if a database access error occurs
void setTimestamp(StringparameterName, Timestamp x, Calendar cal) throws SQLException
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.
parameterName - the name of the parameter
x - the parameter value
cal - the
Calendar object the driver will use to construct the timestamp
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
ResultSet.getTimestamp(int)
void clearParameters()
throws SQLException
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.
SQLException - if a database access error occurs
void execute()
throws SQLException
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.
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
void addRowSetListener(RowSetListenerlistener)
RowSet object.
listener - a component that has implemented the
RowSetListener interface and wants to be notified when events occur on this
RowSet object
removeRowSetListener(javax.sql.RowSetListener)
void removeRowSetListener(RowSetListenerlistener)
RowSet object.
listener - a component that has been registered as a listener for this
RowSet object
addRowSetListener(javax.sql.RowSetListener)
void setSQLXML(int parameterIndex,
SQLXML xmlObject)
throws SQLException
java.sql.SQLXML object. The driver converts this to an SQL
XML value when it sends it to the database.
parameterIndex - index of the first parameter is 1, the second is 2, ...
xmlObject - a
SQLXML object that maps an SQL
XML value
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.
void setSQLXML(StringparameterName, SQLXML xmlObject) throws SQLException
java.sql.SQLXML object. The driver converts this to an
SQL XML value when it sends it to the database.
parameterName - the name of the parameter
xmlObject - a
SQLXML object that maps an
SQL XML value
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.
void setRowId(int parameterIndex,
RowId x)
throws SQLException
java.sql.RowId object. The driver converts this to a SQL
ROWID value when it sends it to the database
parameterIndex - the first parameter is 1, the second is 2, ...
x - the parameter value
SQLException - if a database access error occurs
void setRowId(StringparameterName, RowId x) throws SQLException
java.sql.RowId object. The driver converts this to a SQL
ROWID when it sends it to the database.
parameterName - the name of the parameter
x - the parameter value
SQLException - if a database access error occurs
void setNString(int parameterIndex,
String value)
throws SQLException
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.
parameterIndex - of the first parameter is 1, the second is 2, ...
value - the parameter value
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
void setNString(StringparameterName, String value) throws SQLException
String object. The driver converts this to a SQL
NCHAR or
NVARCHAR or
LONGNVARCHAR
parameterName - the name of the column to be set
value - the parameter value
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
void setNCharacterStream(int parameterIndex,
Reader value,
long length)
throws SQLException
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.
parameterIndex - of the first parameter is 1, the second is 2, ...
value - the parameter value
length - the number of characters in the parameter data.
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
void setNCharacterStream(StringparameterName, Reader value, long length) throws SQLException
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.
parameterName - the name of the column to be set
value - the parameter value
length - the number of characters in the parameter data.
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
void setNCharacterStream(StringparameterName, Reader value) throws SQLException
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.
parameterName - the name of the parameter
value - the parameter value
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
void setNClob(StringparameterName, NClob value) throws SQLException
java.sql.NClob object. The object implements the
java.sql.NClob interface. This
NClob object maps to a SQL
NCLOB.
parameterName - the name of the column to be set
value - the parameter value
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
void setNClob(StringparameterName, Reader reader, long length) throws SQLException
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
parameterName - the name of the parameter to be set
reader - An object that contains the data to set the parameter value to.
length - the number of characters in the parameter data.
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
void setNClob(StringparameterName, Reader reader) throws SQLException
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.
parameterName - the name of the parameter
reader - An object that contains the data to set the parameter value to.
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
void setNClob(int parameterIndex,
Reader reader,
long length)
throws SQLException
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
parameterIndex - index of the first parameter is 1, the second is 2, ...
reader - An object that contains the data to set the parameter value to.
length - the number of characters in the parameter data.
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
void setNClob(int parameterIndex,
NClob value)
throws SQLException
java.sql.NClob object. The driver converts this to a SQL
NCLOB value when it sends it to the database.
parameterIndex - of the first parameter is 1, the second is 2, ...
value - the parameter value
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
void setNClob(int parameterIndex,
Reader reader)
throws SQLException
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.
parameterIndex - index of the first parameter is 1, the second is 2, ...
reader - An object that contains the data to set the parameter value to.
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
void setURL(int parameterIndex,
URL x)
throws SQLException
java.net.URL value. The driver converts this to an SQL
DATALINK value when it sends it to the database.
parameterIndex - the first parameter is 1, the second is 2, ...
x - the
java.net.URL object to be set
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