Interface RowSet
- All Superinterfaces:
AutoCloseable, ResultSet, Wrapper
- All Known Subinterfaces:
CachedRowSet, FilteredRowSet, JdbcRowSet, JoinRowSet, SyncResolver, WebRowSet
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.
- Since:
- 1.4
-
Field Summary
Fields declared in interface ResultSet
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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRowSetListener(RowSetListener listener) Registers the given listener so that it will be notified of events that occur on thisRowSetobject.voidClears the parameters set for thisRowSetobject's command.voidexecute()Fills thisRowSetobject with data.Retrieves thisRowSetobject's command property.Retrieves the logical name that identifies the data source for thisRowSetobject.booleanRetrieves whether escape processing is enabled for thisRowSetobject.intRetrieves the maximum number of bytes that may be returned for certain column values.intRetrieves the maximum number of rows that thisRowSetobject can contain.Retrieves the password used to create a database connection.intRetrieves the maximum number of seconds the driver will wait for a statement to execute.intRetrieves the transaction isolation level set for thisRowSetobject.Retrieves theMapobject associated with thisRowSetobject, which specifies the custom mapping of SQL user-defined types, if any.getUrl()Retrieves the url property thisRowSetobject will use to create a connection if it uses theDriverManagerinstead of aDataSourceobject to establish the connection.Retrieves the username used to create a database connection for thisRowSetobject.booleanRetrieves whether thisRowSetobject is read-only.voidremoveRowSetListener(RowSetListener listener) Removes the specified listener from the list of components that will be notified when an event occurs on thisRowSetobject.voidSets the designated parameter in thisRowSetobject's command with the givenArrayvalue.voidsetAsciiStream(int parameterIndex, InputStream x) Sets the designated parameter in thisRowSetobject's command to the given input stream.voidsetAsciiStream(int parameterIndex, InputStream x, int length) Sets the designated parameter in thisRowSetobject's command to the givenjava.io.InputStreamvalue.voidsetAsciiStream(String parameterName, InputStream x) Sets the designated parameter to the given input stream.voidsetAsciiStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBigDecimal(int parameterIndex, BigDecimal x) Sets the designated parameter in thisRowSetobject's command to the givenjava.math.BigDecimalvalue.voidsetBigDecimal(String parameterName, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(int parameterIndex, InputStream x) Sets the designated parameter in thisRowSetobject's command to the given input stream.voidsetBinaryStream(int parameterIndex, InputStream x, int length) Sets the designated parameter in thisRowSetobject's command to the givenjava.io.InputStreamvalue.voidsetBinaryStream(String parameterName, InputStream x) Sets the designated parameter to the given input stream.voidsetBinaryStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBlob(int parameterIndex, InputStream inputStream) Sets the designated parameter to aInputStreamobject.voidsetBlob(int parameterIndex, InputStream inputStream, long length) Sets the designated parameter to aInputStreamobject.voidSets the designated parameter in thisRowSetobject's command with the givenBlobvalue.voidsetBlob(String parameterName, InputStream inputStream) Sets the designated parameter to aInputStreamobject.voidsetBlob(String parameterName, InputStream inputStream, long length) Sets the designated parameter to aInputStreamobject.voidSets the designated parameter to the givenjava.sql.Blobobject.voidsetBoolean(int parameterIndex, boolean x) Sets the designated parameter in thisRowSetobject's command to the given Javabooleanvalue.voidsetBoolean(String parameterName, boolean x) Sets the designated parameter to the given Javabooleanvalue.voidsetByte(int parameterIndex, byte x) Sets the designated parameter in thisRowSetobject's command to the given Javabytevalue.voidSets the designated parameter to the given Javabytevalue.voidsetBytes(int parameterIndex, byte[] x) Sets the designated parameter in thisRowSetobject's command to the given Java array ofbytevalues.voidSets the designated parameter to the given Java array of bytes.voidsetCharacterStream(int parameterIndex, Reader reader) Sets the designated parameter in thisRowSetobject's command to the givenReaderobject.voidsetCharacterStream(int parameterIndex, Reader reader, int length) Sets the designated parameter in thisRowSetobject's command to the givenjava.io.Readervalue.voidsetCharacterStream(String parameterName, Reader reader) Sets the designated parameter to the givenReaderobject.voidsetCharacterStream(String parameterName, Reader reader, int length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter in thisRowSetobject's command with the givenClobvalue.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to the givenjava.sql.Clobobject.voidsetCommand(String cmd) Sets thisRowSetobject's command property to the given SQL query.voidsetConcurrency(int concurrency) Sets the concurrency of thisRowSetobject to the given concurrency level.voidsetDataSourceName(String name) Sets the data source name property for thisRowSetobject to the givenString.voidSets the designated parameter in thisRowSetobject's command to the givenjava.sql.Datevalue.voidSets the designated parameter in thisRowSetobject's command with the givenjava.sql.Datevalue.voidSets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application.voidSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDouble(int parameterIndex, double x) Sets the designated parameter in thisRowSetobject's command to the given Javadoublevalue.voidSets the designated parameter to the given Javadoublevalue.voidsetEscapeProcessing(boolean enable) Sets escape processing for thisRowSetobject on or off.voidsetFloat(int parameterIndex, float x) Sets the designated parameter in thisRowSetobject's command to the given Javafloatvalue.voidSets the designated parameter to the given Javafloatvalue.voidsetInt(int parameterIndex, int x) Sets the designated parameter in thisRowSetobject's command to the given Javaintvalue.voidSets the designated parameter to the given Javaintvalue.voidsetLong(int parameterIndex, long x) Sets the designated parameter in thisRowSetobject's command to the given Javalongvalue.voidSets the designated parameter to the given Javalongvalue.voidsetMaxFieldSize(int max) Sets the maximum number of bytes that can be returned for a column value to the given number of bytes.voidsetMaxRows(int max) Sets the maximum number of rows that thisRowSetobject can contain to the specified number.voidsetNCharacterStream(int parameterIndex, Reader value) Sets the designated parameter in thisRowSetobject's command to aReaderobject.voidsetNCharacterStream(int parameterIndex, Reader value, long length) Sets the designated parameter to aReaderobject.voidsetNCharacterStream(String parameterName, Reader value) Sets the designated parameter to aReaderobject.voidsetNCharacterStream(String parameterName, Reader value, long length) Sets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to ajava.sql.NClobobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to aReaderobject.voidSets the designated parameter to ajava.sql.NClobobject.voidsetNString(int parameterIndex, String value) Sets the designated parameter to the givenStringobject.voidsetNString(String parameterName, String value) Sets the designated parameter to the givenStringobject.voidsetNull(int parameterIndex, int sqlType) Sets the designated parameter in thisRowSetobject's SQL command to SQLNULL.voidSets the designated parameter in thisRowSetobject's SQL command to SQLNULL.voidSets the designated parameter to SQLNULL.voidSets the designated parameter to SQLNULL.voidSets the designated parameter in thisRowSetobject's command with a JavaObject.voidSets the designated parameter in thisRowSetobject's command with a JavaObject.voidSets the designated parameter in thisRowSetobject's command with the given JavaObject.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.voidsetPassword(String password) Sets the database password for thisRowSetobject to the givenString.voidsetQueryTimeout(int seconds) Sets the maximum time the driver will wait for a statement to execute to the given number of seconds.voidsetReadOnly(boolean value) Sets whether thisRowSetobject is read-only to the givenboolean.voidSets the designated parameter in thisRowSetobject's command with the givenRefvalue.voidSets the designated parameter to the givenjava.sql.RowIdobject.voidSets the designated parameter to the givenjava.sql.RowIdobject.voidsetShort(int parameterIndex, short x) Sets the designated parameter in thisRowSetobject's command to the given Javashortvalue.voidSets the designated parameter to the given Javashortvalue.voidSets the designated parameter to the givenjava.sql.SQLXMLobject.voidSets the designated parameter to the givenjava.sql.SQLXMLobject.voidSets the designated parameter in thisRowSetobject's command to the given JavaStringvalue.voidSets the designated parameter to the given JavaStringvalue.voidSets the designated parameter in thisRowSetobject's command to the givenjava.sql.Timevalue.voidSets the designated parameter in thisRowSetobject's command with the givenjava.sql.Timevalue.voidSets the designated parameter to the givenjava.sql.Timevalue.voidSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(int parameterIndex, Timestamp x) Sets the designated parameter in thisRowSetobject's command to the givenjava.sql.Timestampvalue.voidsetTimestamp(int parameterIndex, Timestamp x, Calendar cal) Sets the designated parameter in thisRowSetobject's command with the givenjava.sql.Timestampvalue.voidsetTimestamp(String parameterName, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(String parameterName, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidsetTransactionIsolation(int level) Sets the transaction isolation level for thisRowSetobject.voidsetType(int type) Sets the type of thisRowSetobject to the given type.voidsetTypeMap(Map<String, Class<?>> map) Installs the givenjava.util.Mapobject as the default type map for thisRowSetobject.voidSets the URL thisRowSetobject will use when it uses theDriverManagerto create a connection.voidSets the designated parameter to the givenjava.net.URLvalue.voidsetUsername(String name) Sets the username property for thisRowSetobject to the givenString.Methods declared in interface ResultSet
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, wasNullMethods declared in interface Wrapper
isWrapperFor, unwrap
-
Method Details
-
getUrl
Retrieves the url property thisRowSetobject will use to create a connection if it uses theDriverManagerinstead of aDataSourceobject to establish the connection. The default value isnull.- Returns:
- a string url
- Throws:
SQLException- if a database access error occurs- See Also:
-
setUrl
Sets the URL thisRowSetobject will use when it uses theDriverManagerto 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- a string value; may benull- Throws:
SQLException- if a database access error occurs- See Also:
-
getDataSourceName
String getDataSourceName()Retrieves the logical name that identifies the data source for thisRowSetobject.- Returns:
- a data source name
- See Also:
-
setDataSourceName
Sets the data source name property for thisRowSetobject to the givenString.The value of the data source name property can be used to do a lookup of a
DataSourceobject that has been registered with a naming service. After being retrieved, theDataSourceobject can be used to create a connection to the data source that it represents.- Parameters:
name- the logical name of the data source for thisRowSetobject; may benull- Throws:
SQLException- if a database access error occurs- See Also:
-
getUsername
String getUsername()Retrieves the username used to create a database connection for thisRowSetobject. The username property is set at run time before calling the methodexecute. It is not usually part of the serialized state of aRowSetobject.- Returns:
- the username property
- See Also:
-
setUsername
Sets the username property for thisRowSetobject to the givenString.- Parameters:
name- a user name- Throws:
SQLException- if a database access error occurs- See Also:
-
getPassword
String getPassword()Retrieves the password used to create a database connection. The password property is set at run time before calling the methodexecute. It is not usually part of the serialized state of aRowSetobject.- Returns:
- the password for making a database connection
- See Also:
-
setPassword
Sets the database password for thisRowSetobject to the givenString.- Parameters:
password- the password string- Throws:
SQLException- if a database access error occurs- See Also:
-
getTransactionIsolation
int getTransactionIsolation()Retrieves the transaction isolation level set for thisRowSetobject.- Returns:
- the transaction isolation level; one of
Connection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ, orConnection.TRANSACTION_SERIALIZABLE - See Also:
-
setTransactionIsolation
Sets the transaction isolation level for thisRowSetobject.- Parameters:
level- the transaction isolation level; one ofConnection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ, orConnection.TRANSACTION_SERIALIZABLE- Throws:
SQLException- if a database access error occurs- See Also:
-
getTypeMap
Retrieves theMapobject associated with thisRowSetobject, which specifies the custom mapping of SQL user-defined types, if any. The default is for the type map to be empty.- Returns:
- a
java.util.Mapobject 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:
-
setTypeMap
Installs the givenjava.util.Mapobject as the default type map for thisRowSetobject. This type map will be used unless another type map is supplied as a method parameter.- Parameters:
map- ajava.util.Mapobject 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:
-
getCommand
String getCommand()Retrieves thisRowSetobject'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 isnull.- Returns:
- the command string; may be
null - See Also:
-
setCommand
Sets thisRowSetobject'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- the SQL query that will be used to get the data for thisRowSetobject; may benull- Throws:
SQLException- if a database access error occurs- See Also:
-
isReadOnly
boolean isReadOnly()Retrieves whether thisRowSetobject 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
SQLExceptionbeing thrown.- Returns:
trueif thisRowSetobject is read-only;falseif it is updatable- See Also:
-
setReadOnly
Sets whether thisRowSetobject is read-only to the givenboolean.- Parameters:
value-trueif read-only;falseif updatable- Throws:
SQLException- if a database access error occurs- See Also:
-
getMaxFieldSize
Retrieves the maximum number of bytes that may be returned for certain column values. This limit applies only toBINARY,VARBINARY,LONGVARBINARYBINARY,CHAR,VARCHAR,LONGVARCHAR,NCHARandNVARCHARcolumns. If the limit is exceeded, the excess data is silently discarded.- Returns:
- the current maximum column size limit; zero means that there is no limit
- Throws:
SQLException- if a database access error occurs- See Also:
-
setMaxFieldSize
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. This limit applies only toBINARY,VARBINARY,LONGVARBINARYBINARY,CHAR,VARCHAR,LONGVARCHAR,NCHARandNVARCHARcolumns. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.- Parameters:
max- the new max column size limit in bytes; zero means unlimited- Throws:
SQLException- if a database access error occurs- See Also:
-
getMaxRows
Retrieves the maximum number of rows that thisRowSetobject can contain. If the limit is exceeded, the excess rows are silently dropped.- Returns:
- the current maximum number of rows that this
RowSetobject can contain; zero means unlimited - Throws:
SQLException- if a database access error occurs- See Also:
-
setMaxRows
Sets the maximum number of rows that thisRowSetobject can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped.- Parameters:
max- the new maximum number of rows; zero means unlimited- Throws:
SQLException- if a database access error occurs- See Also:
-
getEscapeProcessing
Retrieves whether escape processing is enabled for thisRowSetobject. If escape scanning is enabled, which is the default, the driver will do escape substitution before sending an SQL statement to the database.- Returns:
trueif escape processing is enabled;falseif it is disabled- Throws:
SQLException- if a database access error occurs- See Also:
-
setEscapeProcessing
Sets escape processing for thisRowSetobject 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-trueto enable escape processing;falseto disable it- Throws:
SQLException- if a database access error occurs- See Also:
-
getQueryTimeout
Retrieves the maximum number of seconds the driver will wait for a statement to execute. If this limit is exceeded, anSQLExceptionis thrown.- Returns:
- the current query timeout limit in seconds; zero means unlimited
- Throws:
SQLException- if a database access error occurs- See Also:
-
setQueryTimeout
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. If this limit is exceeded, anSQLExceptionis thrown.- Parameters:
seconds- the new query timeout limit in seconds; zero means that there is no limit- Throws:
SQLException- if a database access error occurs- See Also:
-
setType
Sets the type of thisRowSetobject 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- one of theResultSetconstants specifying a type:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE- Throws:
SQLException- if a database access error occurs- See Also:
-
setConcurrency
Sets the concurrency of thisRowSetobject to the given concurrency level. This method is used to change the concurrency level of a rowset, which is by defaultResultSet.CONCUR_READ_ONLY- Parameters:
concurrency- one of theResultSetconstants specifying a concurrency level:ResultSet.CONCUR_READ_ONLYorResultSet.CONCUR_UPDATABLE- Throws:
SQLException- if a database access error occurs- See Also:
-
setNull
Sets the designated parameter in thisRowSetobject's SQL command to SQLNULL.Note: You must specify the parameter's SQL type.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...sqlType- a SQL type code defined byjava.sql.Types- Throws:
SQLException- if a database access error occurs
-
setNull
Sets the designated parameter to SQLNULL.Note: You must specify the parameter's SQL type.
- Parameters:
parameterName- the name of the parametersqlType- the SQL type code defined injava.sql.Types- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setNull
Sets the designated parameter in thisRowSetobject's SQL command to SQLNULL. This version of the methodsetNullshould be used for SQL user-defined types (UDTs) andREFtype 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
REFparameter. In the case of a UDT, the name is the type name of the parameter itself. For aREFparameter, 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 andREFparameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined orREFtype, the typeName parameter is ignored.- Parameters:
paramIndex- the first parameter is 1, the second is 2, ...sqlType- a value fromjava.sql.TypestypeName- the fully qualified name of an SQL UDT or the type name of the SQL structured type being referenced by aREFtype; ignored if the parameter is not a UDT orREFtype- Throws:
SQLException- if a database access error occurs
-
setNull
Sets the designated parameter to SQLNULL. This version of the methodsetNullshould be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. 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- the name of the parametersqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREFvalue- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setBoolean
Sets the designated parameter in thisRowSetobject's command to the given Javabooleanvalue. The driver converts this to an SQLBITvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBoolean
Sets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setByte
Sets the designated parameter in thisRowSetobject's command to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setByte
Sets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setShort
Sets the designated parameter in thisRowSetobject's command to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setShort
Sets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setInt
Sets the designated parameter in thisRowSetobject's command to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setInt
Sets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setLong
Sets the designated parameter in thisRowSetobject's command to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setLong
Sets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setFloat
Sets the designated parameter in thisRowSetobject's command to the given Javafloatvalue. The driver converts this to an SQLREALvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setFloat
Sets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setDouble
Sets the designated parameter in thisRowSetobject's command to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setDouble
Sets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setBigDecimal
Sets the designated parameter in thisRowSetobject's command to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBigDecimal
Sets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setString
Sets the designated parameter in thisRowSetobject's command to the given JavaStringvalue. Before sending it to the database, the driver converts this to an SQLVARCHARorLONGVARCHARvalue, depending on the argument's size relative to the driver's limits onVARCHARvalues.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setString
Sets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setBytes
Sets the designated parameter in thisRowSetobject's command to the given Java array ofbytevalues. Before sending it to the database, the driver converts this to an SQLVARBINARYorLONGVARBINARYvalue, depending on the argument's size relative to the driver's limits onVARBINARYvalues.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setBytes
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setDate
Sets the designated parameter in thisRowSetobject's command to the givenjava.sql.Datevalue. The driver converts this to an SQLDATEvalue before sending it to the database, using the defaultjava.util.Calendarto calculate the date.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTime
Sets the designated parameter in thisRowSetobject's command to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue before sending it to the database, using the defaultjava.util.Calendarto calculate it.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTimestamp
Sets the designated parameter in thisRowSetobject's command to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue before sending it to the database, using the defaultjava.util.Calendarto calculate it.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setAsciiStream
Sets the designated parameter in thisRowSetobject's command to the givenjava.io.InputStreamvalue. It may be more practical to send a very large ASCII value via ajava.io.InputStreamrather than as aLONGVARCHARparameter. 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- the first parameter is 1, the second is 2, ...x- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs
-
setAsciiStream
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 aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterName- the name of the parameterx- the Java input stream that contains the ASCII parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setBinaryStream
Sets the designated parameter in thisRowSetobject's command to the givenjava.io.InputStreamvalue. It may be more practical to send a very large binary value via ajava.io.InputStreamrather than as aLONGVARBINARYparameter. 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- the first parameter is 1, the second is 2, ...x- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs
-
setBinaryStream
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 aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterName- the name of the parameterx- the java input stream which contains the binary parameter valuelength- the number of bytes in the stream- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setCharacterStream
Sets the designated parameter in thisRowSetobject's command to the givenjava.io.Readervalue. It may be more practical to send a very large UNICODE value via ajava.io.Readerrather than as aLONGVARCHARparameter. 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- the first parameter is 1, the second is 2, ...reader- theReaderobject that contains the UNICODE data to be setlength- the number of characters in the stream- Throws:
SQLException- if a database access error occurs
-
setCharacterStream
Sets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the UNICODE data used as the designated parameterlength- the number of characters in the stream- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-
setAsciiStream
Sets the designated parameter in thisRowSetobject's command to the given input stream. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStreamwhich takes a length parameter.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- 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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setAsciiStream
Sets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterx- 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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets the designated parameter in thisRowSetobject's command to the given input stream. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStreamwhich takes a length parameter.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- 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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterx- 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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets the designated parameter in thisRowSetobject's command to the givenReaderobject. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStreamwhich takes a length parameter.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...reader- thejava.io.Readerobject that contains the Unicode data- Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets the designated parameter to the givenReaderobject. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject that contains the Unicode data- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter in thisRowSetobject's command to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStreamwhich takes a length parameter.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- 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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setObject
void setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength) throws SQLException Sets the designated parameter in thisRowSetobject's command with the given JavaObject. For integral values, thejava.langequivalent objects should be used (for example, an instance of the classIntegerfor anint). If the second argument is anInputStreamthen the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReaderthen theReadermust contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLExceptionwhen the prepared statement is executed.The given Java object will be converted to the targetSqlType before being sent to the database.
If the object is of a class implementing
SQLData, the rowset should call the methodSQLData.writeSQLto write the object to anSQLOutputdata stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type (as defined injava.sql.Types) to be sent to the database. The scale argument may further qualify this type.scaleOrLength- forjava.sql.Types.DECIMALorjava.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For Java Object typesInputStreamandReader, this is the length of the data in the stream orReader. For all other types, this value will be ignored.- Throws:
SQLException- if a database access error occurs- See Also:
-
setObject
Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.langequivalent 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database- specific abstract data types.
- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scale- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- iftargetSqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- Since:
- 1.4
- See Also:
-
setObject
Sets the designated parameter in thisRowSetobject's command with a JavaObject. For integral values, thejava.langequivalent objects should be used. This method is likesetObjectabove, 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- the first parameter is 1, the second is 2, ...x- the object containing the input parameter valuetargetSqlType- the SQL type (as defined injava.sql.Types) to be sent to the database- Throws:
SQLException- if a database access error occurs
-
setObject
Sets the value of the designated parameter with the given object. This method is like the methodsetObjectabove, except that it assumes a scale of zero.- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter valuetargetSqlType- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- iftargetSqlTypeis aARRAY,BLOB,CLOB,DATALINK,JAVA_OBJECT,NCHAR,NCLOB,NVARCHAR,LONGNVARCHAR,REF,ROWID,SQLXMLorSTRUCTdata type and the JDBC driver does not support this data type- Since:
- 1.4
- See Also:
-
setObject
Sets the value of the designated parameter with the given object. The second parameter must be of typeObject; therefore, thejava.langequivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Objecttypes to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData, the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
- Parameters:
parameterName- the name of the parameterx- the object containing the input parameter value- Throws:
SQLException- if a database access error occurs, this method is called on a closedCallableStatementor if the givenObjectparameter is ambiguousSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setObject
Sets the designated parameter in thisRowSetobject's command with a JavaObject. For integral values, thejava.langequivalent 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 database-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 methodSQLData.writeSQLto write the object to anSQLOutputdata stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.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- The first parameter is 1, the second is 2, ...x- The object containing the input parameter value- Throws:
SQLException- if a database access error occurs
-
setRef
Sets the designated parameter in thisRowSetobject's command with the givenRefvalue. The driver will convert this to the appropriateREF(<structured-type>)value.- Parameters:
i- the first parameter is 1, the second is 2, ...x- an object representing data of an SQLREFtype- Throws:
SQLException- if a database access error occurs
-
setBlob
Sets the designated parameter in thisRowSetobject's command with the givenBlobvalue. The driver will convert this to theBLOBvalue that theBlobobject represents before sending it to the database.- Parameters:
i- the first parameter is 1, the second is 2, ...x- an object representing a BLOB- Throws:
SQLException- if a database access error occurs
-
setBlob
Sets the designated parameter to aInputStreamobject. TheInputStreammust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when thePreparedStatementis executed. This method differs from thesetBinaryStream (int, InputStream, int)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOB- Parameters:
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.- Throws:
SQLException- if a database access error occurs, this method is called on a closedPreparedStatement, 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 theInputStreamdoes not match the specified length.SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStreamobject. This method differs from thesetBinaryStream (int, InputStream)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlobwhich takes a length parameter.- Parameters:
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.- Throws:
SQLException- if a database access error occurs, this method is called on a closedPreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement,SQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStreamobject. TheInputStreammust contain the number of characters specified by length, otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetBinaryStream (int, InputStream, int)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARYor aBLOB- Parameters:
parameterName- the name of the parameter to be set the second is 2, ...inputStream- An object that contains the data to set the parameter value to.length- the number of bytes in the parameter data.- Throws:
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 theInputStreamdoes not match the specified length; if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to the givenjava.sql.Blobobject. The driver converts this to an SQLBLOBvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- aBlobobject that maps an SQLBLOBvalue- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStreamobject. This method differs from thesetBinaryStream (int, InputStream)method because it informs the driver that the parameter value should be sent to the server as aBLOB. When thesetBinaryStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARBINARYor aBLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlobwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterinputStream- 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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter in thisRowSetobject's command with the givenClobvalue. The driver will convert this to theCLOBvalue that theClobobject represents before sending it to the database.- Parameters:
i- the first parameter is 1, the second is 2, ...x- an object representing a CLOB- Throws:
SQLException- if a database access error occurs
-
setClob
Sets the designated parameter to aReaderobject. TheReadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when thePreparedStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHARor aCLOB- Parameters:
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.- Throws:
SQLException- if a database access error occurs, this method is called on a closedPreparedStatement, 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- Since:
- 1.6
-
setClob
Sets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHARor aCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClobwhich takes a length parameter.- Parameters:
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.- Throws:
SQLException- if a database access error occurs, this method is called on a closedPreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReaderobject. TheReadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARCHARor aCLOB- Parameters:
parameterName- the name of the parameter to be setreader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to the givenjava.sql.Clobobject. The driver converts this to an SQLCLOBvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- aClobobject that maps an SQLCLOBvalue- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARCHARor aCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClobwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterreader- 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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setArray
Sets the designated parameter in thisRowSetobject's command with the givenArrayvalue. The driver will convert this to theARRAYvalue that theArrayobject represents before sending it to the database.- Parameters:
i- the first parameter is 1, the second is 2, ...x- an object representing an SQL array- Throws:
SQLException- if a database access error occurs
-
setDate
Sets the designated parameter in thisRowSetobject's command with the givenjava.sql.Datevalue. The driver will convert this to an SQLDATEvalue, using the givenjava.util.Calendarobject to calculate the date.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- thejava.util.Calendarobject to use for calculating the date- Throws:
SQLException- if a database access error occurs
-
setDate
Sets the designated parameter to the givenjava.sql.Datevalue using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATEvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setDate
Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the date- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTime
Sets the designated parameter in thisRowSetobject's command with the givenjava.sql.Timevalue. The driver will convert this to an SQLTIMEvalue, using the givenjava.util.Calendarobject to calculate it, before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- thejava.util.Calendarobject to use for calculating the time- Throws:
SQLException- if a database access error occurs
-
setTime
Sets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTime
Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the time- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
setTimestamp
Sets the designated parameter in thisRowSetobject's command with the givenjava.sql.Timestampvalue. The driver will convert this to an SQLTIMESTAMPvalue, using the givenjava.util.Calendarobject to calculate it, before sending it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter valuecal- thejava.util.Calendarobject to use for calculating the timestamp- Throws:
SQLException- if a database access error occurs
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject the driver will use to construct the timestamp- Throws:
SQLException- if a database access error occurs or this method is called on a closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
-
clearParameters
Clears the parameters set for thisRowSetobject's command.In general, parameter values remain in force for repeated use of a
RowSetobject. 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 methodclearParameters.- Throws:
SQLException- if a database access error occurs
-
execute
Fills thisRowSetobject with data.The
executemethod may use the following properties to create a connection for reading data: url, data source name, user name, password, transaction isolation, and type map. Theexecutemethod 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
RowSetobject does not maintain a continuous connection with its source of data, it may use aReader(aRowSetReaderobject) to fill itself with data. In this case, aReaderwill have been registered with thisRowSetobject, and the methodexecutewill call on theReader'sreadDatamethod 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
-
addRowSetListener
Registers the given listener so that it will be notified of events that occur on thisRowSetobject.- Parameters:
listener- a component that has implemented theRowSetListenerinterface and wants to be notified when events occur on thisRowSetobject- See Also:
-
removeRowSetListener
Removes the specified listener from the list of components that will be notified when an event occurs on thisRowSetobject.- Parameters:
listener- a component that has been registered as a listener for thisRowSetobject- See Also:
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXMLobject. The driver converts this to an SQLXMLvalue when it sends it to the database.- Parameters:
parameterIndex- index of the first parameter is 1, the second is 2, ...xmlObject- aSQLXMLobject that maps an SQLXMLvalue- Throws:
SQLException- if a database access error occurs, this method is called on a closed result set, thejava.xml.transform.Result,WriterorOutputStreamhas not been closed for theSQLXMLobject or if there is an error processing the XML value. ThegetCausemethod of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.- Since:
- 1.6
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXMLobject. The driver converts this to anSQL XMLvalue when it sends it to the database.- Parameters:
parameterName- the name of the parameterxmlObject- aSQLXMLobject that maps anSQL XMLvalue- Throws:
SQLException- if a database access error occurs, this method is called on a closed result set, thejava.xml.transform.Result,WriterorOutputStreamhas not been closed for theSQLXMLobject or if there is an error processing the XML value. ThegetCausemethod of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.- Since:
- 1.6
-
setRowId
Sets the designated parameter to the givenjava.sql.RowIdobject. The driver converts this to a SQLROWIDvalue when it sends it to the database- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- the parameter value- Throws:
SQLException- if a database access error occurs- Since:
- 1.6
-
setRowId
Sets the designated parameter to the givenjava.sql.RowIdobject. The driver converts this to a SQLROWIDwhen it sends it to the database.- Parameters:
parameterName- the name of the parameterx- the parameter value- Throws:
SQLException- if a database access error occurs- Since:
- 1.6
-
setNString
Sets the designated parameter to the givenStringobject. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHARvalue (depending on the argument's size relative to the driver's limits onNVARCHARvalues) when it sends it to the database.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- 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- Since:
- 1.6
-
setNString
Sets the designated parameter to the givenStringobject. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHAR- Parameters:
parameterName- the name of the column to be setvalue- 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- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- the parameter valuelength- 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- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Parameters:
parameterName- the name of the column to be setvalue- the parameter valuelength- 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- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReaderobject. TheReaderreads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStreamwhich takes a length parameter.- Parameters:
parameterName- the name of the parametervalue- 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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to ajava.sql.NClobobject. The object implements thejava.sql.NClobinterface. ThisNClobobject maps to a SQLNCLOB.- Parameters:
parameterName- the name of the column to be setvalue- 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- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReaderobject. TheReadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when theCallableStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGNVARCHARor aNCLOB- Parameters:
parameterName- the name of the parameter to be setreader- An object that contains the data to set the parameter value to.length- the number of characters in the parameter data.- Throws:
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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGNVARCHARor aNCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClobwhich takes a length parameter.- Parameters:
parameterName- the name of the parameterreader- 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 closedCallableStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReaderobject. TheReadermust contain the number of characters specified by length otherwise aSQLExceptionwill be generated when thePreparedStatementis executed. This method differs from thesetCharacterStream (int, Reader, int)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHARor aNCLOB- Parameters:
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.- 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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to ajava.sql.NClobobject. The driver converts this to a SQLNCLOBvalue when it sends it to the database.- Parameters:
parameterIndex- of the first parameter is 1, the second is 2, ...value- 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- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReaderobject. This method differs from thesetCharacterStream (int, Reader)method because it informs the driver that the parameter value should be sent to the server as aNCLOB. When thesetCharacterStreammethod is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHARor aNCLOBNote: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClobwhich takes a length parameter.- Parameters:
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.- 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 closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
-
setURL
Sets the designated parameter to the givenjava.net.URLvalue. The driver converts this to an SQLDATALINKvalue when it sends it to the database.- Parameters:
parameterIndex- the first parameter is 1, the second is 2, ...x- thejava.net.URLobject to be set- Throws:
SQLException- if a database access error occurs or this method is called on a closedPreparedStatementSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.4
-