RowSet (Java 2 Platform SE 5.0) (original) (raw)

javax.sql

Interface RowSet

All Superinterfaces:

ResultSet

All Known Subinterfaces:

CachedRowSet, FilteredRowSet, JdbcRowSet, JoinRowSet, SyncResolver, WebRowSet

public interface RowSet

extends ResultSet

The interface that adds support to the JDBC API for the JavaBeansTM component model. A rowset, which can be used as a JavaBeans component in a visual Bean development environment, can be created and configured at design time and executed at run time.

The RowSet interface provides a set of JavaBeans properties that allow a RowSet instance to be configured to connect to a JDBC data source and read some data from the data source. A group of setter methods (setInt,setBytes, setString, and so on) provide a way to pass input parameters to a rowset's command property. This command is the SQL query the rowset uses when it gets its data from a relational database, which is generally the case.

The RowSet interface supports JavaBeans events, allowing other components in an application to be notified when an event occurs on a rowset, such as a change in its value.

The RowSet interface is unique in that it is intended to be implemented using the rest of the JDBC API. In other words, aRowSet 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 standardjava.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 inherited from interface java.sql.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
void addRowSetListener(RowSetListener listener) 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 thisRowSet object.
boolean getEscapeProcessing() Retrieves whether escape processing is enabled for thisRowSet 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 thisRowSet object.
Map<String,Class<?>> getTypeMap() Retrieves the Map object associated with thisRowSet 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 thisRowSet object.
boolean isReadOnly() Retrieves whether this RowSet object is read-only.
void removeRowSetListener(RowSetListener listener) Removes the specified listener from the list of components that will be notified when an event occurs on this RowSet object.
void [setArray](../../javax/sql/RowSet.html#setArray%28int, java.sql.Array%29)(int i,Array x) Sets the designated parameter in this RowSet object's command with the given Array value.
void [setAsciiStream](../../javax/sql/RowSet.html#setAsciiStream%28int, java.io.InputStream, int%29)(int parameterIndex,InputStream x, int length) Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value.
void [setBigDecimal](../../javax/sql/RowSet.html#setBigDecimal%28int, java.math.BigDecimal%29)(int parameterIndex,BigDecimal x) Sets the designated parameter in this RowSet object's command to the given java.math.BigDeciaml value.
void [setBinaryStream](../../javax/sql/RowSet.html#setBinaryStream%28int, java.io.InputStream, int%29)(int parameterIndex,InputStream x, int length) Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value.
void [setBlob](../../javax/sql/RowSet.html#setBlob%28int, java.sql.Blob%29)(int i,Blob x) Sets the designated parameter in this RowSet object's command with the given Blob value.
void [setBoolean](../../javax/sql/RowSet.html#setBoolean%28int, boolean%29)(int parameterIndex, boolean x) Sets the designated parameter in this RowSet object's command to the given Java boolean value.
void [setByte](../../javax/sql/RowSet.html#setByte%28int, byte%29)(int parameterIndex, byte x) Sets the designated parameter in this RowSet object's command to the given Java byte value.
void [setBytes](../../javax/sql/RowSet.html#setBytes%28int, byte[]%29)(int parameterIndex, byte[] x) Sets the designated parameter in this RowSet object's command to the given Java array of byte values.
void [setCharacterStream](../../javax/sql/RowSet.html#setCharacterStream%28int, java.io.Reader, int%29)(int parameterIndex,Reader reader, int length) Sets the designated parameter in this RowSet object's command to the given java.io.Reader value.
void [setClob](../../javax/sql/RowSet.html#setClob%28int, java.sql.Clob%29)(int i,Clob x) Sets the designated parameter in this RowSet object's command with the given Clob value.
void setCommand(String cmd) 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 name) Sets the data source name property for this RowSet object to the given String.
void [setDate](../../javax/sql/RowSet.html#setDate%28int, java.sql.Date%29)(int parameterIndex,Date x) Sets the designated parameter in this RowSet object's command to the given java.sql.Date value.
void [setDate](../../javax/sql/RowSet.html#setDate%28int, java.sql.Date, java.util.Calendar%29)(int parameterIndex,Date x,Calendar cal) Sets the designated parameter in this RowSet object's command with the given java.sql.Date value.
void [setDouble](../../javax/sql/RowSet.html#setDouble%28int, double%29)(int parameterIndex, double x) Sets the designated parameter in this RowSet object's command to the given Java double value.
void setEscapeProcessing(boolean enable) Sets escape processing for this RowSet object on or off.
void [setFloat](../../javax/sql/RowSet.html#setFloat%28int, float%29)(int parameterIndex, float x) Sets the designated parameter in this RowSet object's command to the given Java float value.
void [setInt](../../javax/sql/RowSet.html#setInt%28int, int%29)(int parameterIndex, int x) Sets the designated parameter in this RowSet object's command to the given Java int value.
void [setLong](../../javax/sql/RowSet.html#setLong%28int, long%29)(int parameterIndex, long x) Sets the designated parameter in this RowSet object's command 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 [setNull](../../javax/sql/RowSet.html#setNull%28int, int%29)(int parameterIndex, int sqlType) Sets the designated parameter in this RowSet object's SQL command to SQL NULL.
void [setNull](../../javax/sql/RowSet.html#setNull%28int, int, java.lang.String%29)(int paramIndex, int sqlType,String typeName) Sets the designated parameter in this RowSet object's SQL command to SQL NULL.
void [setObject](../../javax/sql/RowSet.html#setObject%28int, java.lang.Object%29)(int parameterIndex,Object x) Sets the designated parameter in this RowSet object's command with a Java Object.
void [setObject](../../javax/sql/RowSet.html#setObject%28int, java.lang.Object, int%29)(int parameterIndex,Object x, int targetSqlType) Sets the designated parameter in this RowSet object's command with a Java Object.
void [setObject](../../javax/sql/RowSet.html#setObject%28int, java.lang.Object, int, int%29)(int parameterIndex,Object x, int targetSqlType, int scale) Sets the designated parameter in this RowSet object's command with the given Java Object.
void setPassword(String password) 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](../../javax/sql/RowSet.html#setRef%28int, java.sql.Ref%29)(int i,Ref x) Sets the designated parameter in this RowSet object's command with the given Ref value.
void [setShort](../../javax/sql/RowSet.html#setShort%28int, short%29)(int parameterIndex, short x) Sets the designated parameter in this RowSet object's command to the given Java short value.
void [setString](../../javax/sql/RowSet.html#setString%28int, java.lang.String%29)(int parameterIndex,String x) Sets the designated parameter in this RowSet object's command to the given Java String value.
void [setTime](../../javax/sql/RowSet.html#setTime%28int, java.sql.Time%29)(int parameterIndex,Time x) Sets the designated parameter in this RowSet object's command to the given java.sql.Time value.
void [setTime](../../javax/sql/RowSet.html#setTime%28int, java.sql.Time, java.util.Calendar%29)(int parameterIndex,Time x,Calendar cal) Sets the designated parameter in this RowSet object's command with the given java.sql.Time value.
void [setTimestamp](../../javax/sql/RowSet.html#setTimestamp%28int, java.sql.Timestamp%29)(int parameterIndex,Timestamp x) Sets the designated parameter in this RowSet object's command to the given java.sql.Timestamp value.
void [setTimestamp](../../javax/sql/RowSet.html#setTimestamp%28int, java.sql.Timestamp, java.util.Calendar%29)(int parameterIndex,Timestamp x,Calendar cal) Sets the designated parameter in this RowSet object's command with the given java.sql.Timestamp value.
void setTransactionIsolation(int level) Sets the transaction isolation level for this RowSet obejct.
void setType(int type) Sets the type of this RowSet object to the given type.
void setTypeMap(Map<String,Class<?>> map) Installs the given java.util.Map object as the default type map for this RowSet object.
void setUrl(String url) Sets the URL this RowSet object will use when it uses theDriverManager to create a connection.
void setUsername(String name) Sets the username property for this RowSet object to the given String.
Methods inherited from interface java.sql.ResultSet
absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, [getBigDecimal](../../java/sql/ResultSet.html#getBigDecimal%28int, int%29), getBigDecimal, [getBigDecimal](../../java/sql/ResultSet.html#getBigDecimal%28java.lang.String, int%29), getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, [getDate](../../java/sql/ResultSet.html#getDate%28int, java.util.Calendar%29), getDate, [getDate](../../java/sql/ResultSet.html#getDate%28java.lang.String, java.util.Calendar%29), getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getInt, getInt, getLong, getLong, getMetaData, getObject, [getObject](../../java/sql/ResultSet.html#getObject%28int, java.util.Map%29), getObject, [getObject](../../java/sql/ResultSet.html#getObject%28java.lang.String, java.util.Map%29), getRef, getRef, getRow, getShort, getShort, getStatement, getString, getString, getTime, [getTime](../../java/sql/ResultSet.html#getTime%28int, java.util.Calendar%29), getTime, [getTime](../../java/sql/ResultSet.html#getTime%28java.lang.String, java.util.Calendar%29), getTimestamp, [getTimestamp](../../java/sql/ResultSet.html#getTimestamp%28int, java.util.Calendar%29), getTimestamp, [getTimestamp](../../java/sql/ResultSet.html#getTimestamp%28java.lang.String, java.util.Calendar%29), getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, [updateArray](../../java/sql/ResultSet.html#updateArray%28int, java.sql.Array%29), [updateArray](../../java/sql/ResultSet.html#updateArray%28java.lang.String, java.sql.Array%29), [updateAsciiStream](../../java/sql/ResultSet.html#updateAsciiStream%28int, java.io.InputStream, int%29), [updateAsciiStream](../../java/sql/ResultSet.html#updateAsciiStream%28java.lang.String, java.io.InputStream, int%29), [updateBigDecimal](../../java/sql/ResultSet.html#updateBigDecimal%28int, java.math.BigDecimal%29), [updateBigDecimal](../../java/sql/ResultSet.html#updateBigDecimal%28java.lang.String, java.math.BigDecimal%29), [updateBinaryStream](../../java/sql/ResultSet.html#updateBinaryStream%28int, java.io.InputStream, int%29), [updateBinaryStream](../../java/sql/ResultSet.html#updateBinaryStream%28java.lang.String, java.io.InputStream, int%29), [updateBlob](../../java/sql/ResultSet.html#updateBlob%28int, java.sql.Blob%29), [updateBlob](../../java/sql/ResultSet.html#updateBlob%28java.lang.String, java.sql.Blob%29), [updateBoolean](../../java/sql/ResultSet.html#updateBoolean%28int, boolean%29), [updateBoolean](../../java/sql/ResultSet.html#updateBoolean%28java.lang.String, boolean%29), [updateByte](../../java/sql/ResultSet.html#updateByte%28int, byte%29), [updateByte](../../java/sql/ResultSet.html#updateByte%28java.lang.String, byte%29), [updateBytes](../../java/sql/ResultSet.html#updateBytes%28int, byte[]%29), [updateBytes](../../java/sql/ResultSet.html#updateBytes%28java.lang.String, byte[]%29), [updateCharacterStream](../../java/sql/ResultSet.html#updateCharacterStream%28int, java.io.Reader, int%29), [updateCharacterStream](../../java/sql/ResultSet.html#updateCharacterStream%28java.lang.String, java.io.Reader, int%29), [updateClob](../../java/sql/ResultSet.html#updateClob%28int, java.sql.Clob%29), [updateClob](../../java/sql/ResultSet.html#updateClob%28java.lang.String, java.sql.Clob%29), [updateDate](../../java/sql/ResultSet.html#updateDate%28int, java.sql.Date%29), [updateDate](../../java/sql/ResultSet.html#updateDate%28java.lang.String, java.sql.Date%29), [updateDouble](../../java/sql/ResultSet.html#updateDouble%28int, double%29), [updateDouble](../../java/sql/ResultSet.html#updateDouble%28java.lang.String, double%29), [updateFloat](../../java/sql/ResultSet.html#updateFloat%28int, float%29), [updateFloat](../../java/sql/ResultSet.html#updateFloat%28java.lang.String, float%29), [updateInt](../../java/sql/ResultSet.html#updateInt%28int, int%29), [updateInt](../../java/sql/ResultSet.html#updateInt%28java.lang.String, int%29), [updateLong](../../java/sql/ResultSet.html#updateLong%28int, long%29), [updateLong](../../java/sql/ResultSet.html#updateLong%28java.lang.String, long%29), updateNull, updateNull, [updateObject](../../java/sql/ResultSet.html#updateObject%28int, java.lang.Object%29), [updateObject](../../java/sql/ResultSet.html#updateObject%28int, java.lang.Object, int%29), [updateObject](../../java/sql/ResultSet.html#updateObject%28java.lang.String, java.lang.Object%29), [updateObject](../../java/sql/ResultSet.html#updateObject%28java.lang.String, java.lang.Object, int%29), [updateRef](../../java/sql/ResultSet.html#updateRef%28int, java.sql.Ref%29), [updateRef](../../java/sql/ResultSet.html#updateRef%28java.lang.String, java.sql.Ref%29), updateRow, [updateShort](../../java/sql/ResultSet.html#updateShort%28int, short%29), [updateShort](../../java/sql/ResultSet.html#updateShort%28java.lang.String, short%29), [updateString](../../java/sql/ResultSet.html#updateString%28int, java.lang.String%29), [updateString](../../java/sql/ResultSet.html#updateString%28java.lang.String, java.lang.String%29), [updateTime](../../java/sql/ResultSet.html#updateTime%28int, java.sql.Time%29), [updateTime](../../java/sql/ResultSet.html#updateTime%28java.lang.String, java.sql.Time%29), [updateTimestamp](../../java/sql/ResultSet.html#updateTimestamp%28int, java.sql.Timestamp%29), [updateTimestamp](../../java/sql/ResultSet.html#updateTimestamp%28java.lang.String, java.sql.Timestamp%29), wasNull
Method Detail

getUrl

String getUrl() throws SQLException

Retrieves the url property this RowSet object will use to create a connection if it uses the DriverManager instead of a DataSource object to establish the connection. The default value is null.

Returns:

a string url

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

setUrl(java.lang.String)

setUrl

void setUrl(String url) throws SQLException

Sets the URL this RowSet object will use when it uses theDriverManager to create a connection. Setting this property is optional. If a URL is used, a JDBC driver that accepts the URL must be loaded by the application 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 specified most recently.

Parameters:

url - a string value; may be null

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getUrl()

getDataSourceName

String getDataSourceName()

Retrieves the logical name that identifies the data source for thisRowSet object. Users should set either the url property or the data source name property. The rowset will use the property that was set more recently to get a connection.

Returns:

a data source name

See Also:

setDataSourceName(java.lang.String), setUrl(java.lang.String)

setDataSourceName

void setDataSourceName(String name) throws SQLException

Sets the data source name property for this RowSet object to the given String.

The value of the data source name property can be used to do a lookup of a DataSource object that has been registered with a naming service. After being retrieved, the DataSource object can be used to create a connection to the data source that it represents.

Parameters:

name - the logical name of the data source for this RowSet object

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getDataSourceName()

getUsername

String getUsername()

Retrieves the username used to create a database connection for thisRowSet object. The username property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object.

Returns:

the username property

See Also:

setUsername(java.lang.String)

setUsername

void setUsername(String name) throws SQLException

Sets the username property for this RowSet object to the given String.

Parameters:

name - a user name

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getUsername()

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 a RowSet object.

Returns:

the password for making a database connection

See Also:

setPassword(java.lang.String)

setPassword

void setPassword(String password) throws SQLException

Sets the database password for this RowSet object to the given String.

Parameters:

password - the password string

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getPassword()

getTransactionIsolation

int getTransactionIsolation()

Retrieves the transaction isolation level set for thisRowSet object.

Returns:

the transaction isolation level; one ofConnection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ, orConnection.TRANSACTION_SERIALIZABLE

See Also:

setTransactionIsolation(int)

setTransactionIsolation

void setTransactionIsolation(int level) throws SQLException

Sets the transaction isolation level for this RowSet obejct.

Parameters:

level - the transaction isolation level; one ofConnection.TRANSACTION_READ_UNCOMMITTED,Connection.TRANSACTION_READ_COMMITTED,Connection.TRANSACTION_REPEATABLE_READ, orConnection.TRANSACTION_SERIALIZABLE

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getTransactionIsolation()

getTypeMap

Map<String,Class<?>> getTypeMap() throws SQLException

Retrieves the Map object associated with thisRowSet object, 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.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

setTypeMap(java.util.Map<java.lang.string, java.lang.class<?="">>)</java.lang.string,>

setTypeMap

void setTypeMap(Map<String,Class<?>> map) throws SQLException

Installs the given java.util.Map object as the default type map for this RowSet object. This type map will be used unless another type map is supplied as a method parameter.

Parameters:

map - a java.util.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getTypeMap()

getCommand

String getCommand()

Retrieves this RowSet object's command property. The command property contains a command string, which must be an SQL query, that can be executed to fill the rowset with data. The default value is null.

Returns:

the command string; may be null

See Also:

setCommand(java.lang.String)

setCommand

void setCommand(String cmd) throws SQLException

Sets this RowSet object's command property to the given SQL query. This property is optional when a rowset gets its data from a data source that does not support commands, such as a spreadsheet.

Parameters:

cmd - the SQL query that will be used to get the data for thisRowSet object; may be null

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getCommand()

isReadOnly

boolean isReadOnly()

Retrieves whether this RowSet object is read-only. If updates are possible, the default is for a rowset to be updatable.

Attempts to update a read-only rowset will result in anSQLException being thrown.

Returns:

true if this RowSet object is read-only; false if it is updatable

See Also:

setReadOnly(boolean)

setReadOnly

void setReadOnly(boolean value) throws SQLException

Sets whether this RowSet object is read-only to the given boolean.

Parameters:

value - true if read-only; false if updatable

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

isReadOnly()

getMaxFieldSize

int getMaxFieldSize() throws SQLException

Retrieves the maximum number of bytes that may be returned for certain column values. This limit applies only to BINARY,VARBINARY, LONGVARBINARYBINARY, CHAR,VARCHAR, and LONGVARCHAR columns. 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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

setMaxFieldSize(int)

setMaxFieldSize

void setMaxFieldSize(int max) throws SQLException

Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. This limit applies only to BINARY,VARBINARY, LONGVARBINARYBINARY, CHAR,VARCHAR, and LONGVARCHAR columns. 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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getMaxFieldSize()

getMaxRows

int getMaxRows() throws SQLException

Retrieves the maximum number of rows that this RowSet object can contain. If the limit is exceeded, the excess rows are silently dropped.

Returns:

the current maximum number of rows that this RowSet object can contain; zero means unlimited

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

setMaxRows(int)

setMaxRows

void setMaxRows(int max) throws SQLException

Sets the maximum number of rows that this RowSet object can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped.

Parameters:

max - the new maximum number of rows; zero means unlimited

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getMaxRows()

getEscapeProcessing

boolean getEscapeProcessing() throws SQLException

Retrieves whether escape processing is enabled for thisRowSet object. If escape scanning is enabled, which is the default, the driver will do escape substitution before sending an SQL statement to the database.

Returns:

true if escape processing is enabled; false if it is disabled

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

setEscapeProcessing(boolean)

setEscapeProcessing

void setEscapeProcessing(boolean enable) throws SQLException

Sets escape processing for this RowSet object on or off. If escape scanning is on (the default), the driver will do escape substitution before sending an SQL statement to the database.

Parameters:

enable - true to enable escape processing;false to disable it

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getEscapeProcessing()

getQueryTimeout

int getQueryTimeout() throws SQLException

Retrieves the maximum number of seconds the driver will wait for a statement to execute. If this limit is exceeded, an SQLException is thrown.

Returns:

the current query timeout limit in seconds; zero means unlimited

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

setQueryTimeout(int)

setQueryTimeout

void setQueryTimeout(int seconds) throws SQLException

Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. If this limit is exceeded, an SQLException is thrown.

Parameters:

seconds - the new query timeout limit in seconds; zero means that there is no limit

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

getQueryTimeout()

setType

void setType(int type) throws SQLException

Sets the type of this RowSet object to the given type. This method is used to change the type of a rowset, which is by default read-only and non-scrollable.

Parameters:

type - one of the ResultSet constants specifying a type:ResultSet.TYPE_FORWARD_ONLY,ResultSet.TYPE_SCROLL_INSENSITIVE, orResultSet.TYPE_SCROLL_SENSITIVE

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

ResultSet.getType()

setConcurrency

void setConcurrency(int concurrency) throws SQLException

Sets the concurrency of this RowSet object to the given concurrency level. This method is used to change the concurrency level of a rowset, which is by default ResultSet.CONCUR_READ_ONLY

Parameters:

concurrency - one of the ResultSet constants specifying a concurrency level: ResultSet.CONCUR_READ_ONLY orResultSet.CONCUR_UPDATABLE

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

ResultSet.getConcurrency()

setNull

void setNull(int parameterIndex, int sqlType) throws SQLException

Sets the designated parameter in this RowSet object's SQL command to SQL NULL.

Note: You must specify the parameter's SQL type.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

sqlType - a SQL type code defined by java.sql.Types

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setNull

void setNull(int paramIndex, int sqlType, String typeName) throws SQLException

Sets the designated parameter in this RowSet object's SQL command to SQL NULL. This version of the method setNull should be used for SQL user-defined types (UDTs) and REF type parameters. Examples of UDTs include: STRUCT, DISTINCT,JAVA_OBJECT, and named array types.

Note: To be portable, applications must give the SQL type code and the fully qualified SQL type name when specifying a NULL UDT or REF parameter. In the case of a UDT, the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for UDT and REF parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.

Parameters:

paramIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setBoolean

void setBoolean(int parameterIndex, boolean x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java boolean value. The driver converts this to an SQL BIT value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setByte

void setByte(int parameterIndex, byte x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java byte value. The driver converts this to an SQL TINYINT value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setShort

void setShort(int parameterIndex, short x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java short value. The driver converts this to an SQL SMALLINT value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setInt

void setInt(int parameterIndex, int x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java int value. The driver converts this to an SQL INTEGER value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setLong

void setLong(int parameterIndex, long x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java long value. The driver converts this to an SQL BIGINT value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setFloat

void setFloat(int parameterIndex, float x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java float value. The driver converts this to an SQL REAL value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setDouble

void setDouble(int parameterIndex, double x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java double value. The driver converts this to an SQL DOUBLE value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setBigDecimal

void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.math.BigDeciaml value. The driver converts this to an SQL NUMERIC value before sending it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setString

void setString(int parameterIndex, String x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java String value. Before sending it to the database, the driver converts this to an SQL VARCHAR orLONGVARCHAR value, depending on the argument's size relative to the driver's limits on VARCHAR values.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setBytes

void setBytes(int parameterIndex, byte[] x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given Java array of byte values. Before sending it to the database, the driver converts this to an SQL VARBINARY orLONGVARBINARY value, depending on the argument's size relative to the driver's limits on VARBINARY values.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setDate

void setDate(int parameterIndex, Date x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.sql.Date value. The driver converts this to an SQL DATE value before sending it to the database, using the default java.util.Calendar to calculate the date.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setTime

void setTime(int parameterIndex, Time x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.sql.Time value. The driver converts this to an SQL TIME value before sending it to the database, using the default java.util.Calendar to calculate it.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setTimestamp

void setTimestamp(int parameterIndex, Timestamp x) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value before sending it to the database, using the default java.util.Calendar to calculate it.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setAsciiStream

void setAsciiStream(int parameterIndex, InputStream x, int length) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large ASCII value via ajava.io.InputStream rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setBinaryStream

void setBinaryStream(int parameterIndex, InputStream x, int length) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large binary value via ajava.io.InputStream rather than as a LONGVARBINARY parameter. The driver will read the data from the stream as needed until it reaches end-of-file.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setCharacterStream

void setCharacterStream(int parameterIndex, Reader reader, int length) throws SQLException

Sets the designated parameter in this RowSet object's command to the given java.io.Reader value. It may be more practical to send a very large UNICODE value via ajava.io.Reader rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters:

parameterIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setObject

void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLException

Sets the designated parameter in this RowSet object's command with the given Java Object. For integral values, the java.lang equivalent objects should be used (for example, an instance of the class Integer for an int).

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 the object is an instance of a class implementing the Ref,Struct, Array, Blob, or Clob interfaces, the driver uses the default mapping to the corresponding SQL type.

Note that this method may be used to pass datatabase-specific abstract data types.

Parameters:

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.

scale - for java.sql.Types.DECIMAL orjava.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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

Types

setObject

void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException

Sets the designated parameter in this RowSet object's command with a Java Object. For integral values, the java.lang equivalent objects should be used. This method is like setObject above, but the scale used is the scale of the second parameter. Scalar values have a scale of zero. Literal values have the scale present in the literal.

Even though it is supported, it is not recommended that this method be called with floating point input values.

Parameters:

parameterIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setObject

void setObject(int parameterIndex, Object x) throws SQLException

Sets the designated parameter in this RowSet object's command with a Java Object. For integral values, the java.lang equivalent objects should be used.

The JDBC specification provides a standard mapping from Java Object types to SQL types. The driver will convert the given Java object to its standard SQL mapping before sending it to the database.

Note that this method may be used to pass datatabase-specific abstract data types by using a driver-specific Java type. If the object is of a class implementing SQLData, the rowset should call the method SQLData.writeSQL to write the object to an SQLOutput data stream. If the object is an instance of a class implementing the Ref,Struct, Array, Blob, or Clob interfaces, the driver uses the default mapping to 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](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setRef

void setRef(int i, Ref x) throws SQLException

Sets the designated parameter in this RowSet object's command with the given Ref value. The driver will convert this to the appropriate REF(<structured-type>) value.

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing data of an SQL REF type

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setBlob

void setBlob(int i, Blob x) throws SQLException

Sets the designated parameter in this RowSet object's command with the given Blob value. The driver will convert this to the BLOB value that the Blob object represents before sending it to the database.

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing a BLOB

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setClob

void setClob(int i, Clob x) throws SQLException

Sets the designated parameter in this RowSet object's command with the given Clob value. The driver will convert this to the CLOB value that the Clob object represents before sending it to the database.

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing a CLOB

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setArray

void setArray(int i, Array x) throws SQLException

Sets the designated parameter in this RowSet object's command with the given Array value. The driver will convert this to the ARRAY value that the Array object represents before sending it to the database.

Parameters:

i - the first parameter is 1, the second is 2, ...

x - an object representing an SQL array

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setDate

void setDate(int parameterIndex, Date x, Calendar cal) throws SQLException

Sets the designated parameter in this RowSet object's command with the given java.sql.Date value. The driver will convert this to an SQL DATE value, using the given java.util.Calendar object to calculate the date.

Parameters:

parameterIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setTime

void setTime(int parameterIndex, Time x, Calendar cal) throws SQLException

Sets the designated parameter in this RowSet object's command with the given java.sql.Time value. The driver will convert this to an SQL TIME value, using the given java.util.Calendar object to calculate it, before sending it to the database.

Parameters:

parameterIndex - 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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

setTimestamp

void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLException

Sets the designated parameter in this RowSet object's command with the given java.sql.Timestamp value. The driver will convert this to an SQL TIMESTAMP value, using the givenjava.util.Calendar object to calculate it, before sending it to the database.

Parameters:

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

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

clearParameters

void clearParameters() throws SQLException

Clears the parameters set for this RowSet object's command.

In general, parameter values remain in force for repeated use of aRowSet object. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values, which can be done by calling the method clearParameters.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

execute

void execute() throws SQLException

Fills this RowSet object with data.

The execute method may use the following properties to create a connection for reading data: url, data source name, user name, password, transaction isolation, and type map. The execute method may use the following properties to create a statement to execute a command: command, read only, maximum field size, maximum rows, escape processing, and query timeout.

If the required properties have not been set, an exception is thrown. If this method is successful, the current contents of the rowset are discarded and the rowset's metadata is also (re)set. If there are outstanding updates, they are ignored.

If this RowSet object does not maintain a continuous connection with its source of data, it may use a reader (a RowSetReader object) to fill itself with data. In this case, a reader will have been registered with this RowSet object, and the method execute will call on the reader's readData method as part of its implementation.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - 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

void addRowSetListener(RowSetListener listener)

Registers the given listener so that it will be notified of events that occur on this RowSet object.

Parameters:

listener - a component that has implemented the RowSetListener interface and wants to be notified when events occur on thisRowSet object

See Also:

removeRowSetListener(javax.sql.RowSetListener)

removeRowSetListener

void removeRowSetListener(RowSetListener listener)

Removes the specified listener from the list of components that will be notified when an event occurs on this RowSet object.

Parameters:

listener - a component that has been registered as a listener for thisRowSet object

See Also:

addRowSetListener(javax.sql.RowSetListener)

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.