The RowSet interface adds support to the JDBC API for the JavaBeans(TM) component model. A rowset can be used as a JavaBean in a visual Bean development environment. A RowSet can be created and configured at design time and executed at runtime. 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 setXXX() methods provide a way to pass input parameters to a rowset. The RowSet interface supports JavaBeans events, allowing other components in an application to be notified when an important event on a rowset occurs, 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(TM) 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.
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 ResultSets will also easily be made to work with rowsets.
Fields inherited from interface java.sql.ResultSet |
CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE |
addRowSetListener(RowSetListener listener) RowSet listener registration. | |
clearParameters() In general, parameter values remain in force for repeated use of a RowSet. | |
execute() Fills the rowset with data. | |
getCommand() Get the rowset's command property. | |
getDataSourceName() The JNDI name that identifies a JDBC data source. | |
getEscapeProcessing() If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database. | |
getMaxFieldSize() The maxFieldSize limit (in bytes) is the maximum amount of data returned for any column value; it only applies to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. | |
getMaxRows() The maxRows limit is the maximum number of rows that a RowSet can contain. | |
getPassword() The password used to create a database connection. | |
getQueryTimeout() The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute. | |
getTransactionIsolation() The transaction isolation property contains the JDBC transaction isolation level used. | |
getTypeMap() Get the type-map object associated with this rowset. | |
getUrl() Get the url used to create a JDBC connection. | |
getUsername() The username used to create a database connection. | |
isReadOnly() A rowset may be read-only. | |
removeRowSetListener(RowSetListener listener) RowSet listener deregistration. | |
setArray(int i, java.sql.Array x) Set an Array parameter. | |
setAsciiStream(int parameterIndex, java.io.InputStream x, int length) When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. | |
setBigDecimal(int parameterIndex, java.math.BigDecimal x) Set a parameter to a java.lang.BigDecimal value. | |
setBinaryStream(int parameterIndex, java.io.InputStream x, int length) When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream. | |
setBlob(int i, java.sql.Blob x) Set a BLOB parameter. | |
setBoolean(int parameterIndex, boolean x) Set a parameter to a Java boolean value. | |
setByte(int parameterIndex, byte x) Set a parameter to a Java byte value. | |
setBytes(int parameterIndex, byte[] x) Set a parameter to a Java array of bytes. | |
setCharacterStream(int parameterIndex, java.io.Reader reader, int length) When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader. | |
setClob(int i, java.sql.Clob x) Set a CLOB parameter. | |
setCommand(java.lang.String cmd) Set the rowset's command property. | |
setConcurrency(int concurrency) Set the rowset concurrency. | |
setDataSourceName(java.lang.String name) Set the data source name. | |
setDate(int parameterIndex, java.sql.Date x) Set a parameter to a java.sql.Date value. | |
setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) Set a parameter to a java.sql.Date value. | |
setDouble(int parameterIndex, double x) Set a parameter to a Java double value. | |
setEscapeProcessing(boolean enable) If escape scanning is on (the default), the driver will do escape substitution before sending the SQL to the database. | |
setFloat(int parameterIndex, float x) Set a parameter to a Java float value. | |
setInt(int parameterIndex, int x) Set a parameter to a Java int value. | |
setLong(int parameterIndex, long x) Set a parameter to a Java long value. | |
setMaxFieldSize(int max) The maxFieldSize limit (in bytes) is set to limit the size of data that can be returned for any column value; it only applies to BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR fields. | |
setMaxRows(int max) The maxRows limit is set to limit the number of rows that any RowSet can contain. | |
setNull(int parameterIndex, int sqlType) Set a parameter to SQL NULL. | |
setNull(int paramIndex, int sqlType, java.lang.String typeName) JDBC 2.0 Set a parameter to SQL NULL. | |
setObject(int parameterIndex, java.lang.Object x) Set the value of a parameter using an object; use the java.lang equivalent objects for integral values. | |
setObject(int parameterIndex, java.lang.Object x, int targetSqlType) This method is like setObject above, but the scale used is the scale of the second parameter. | |
setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) Set the value of a parameter using an object; use the java.lang equivalent objects for integral values. | |
setPassword(java.lang.String password) Set the password. | |
setQueryTimeout(int seconds) The queryTimeout limit is the number of seconds the driver will wait for a Statement to execute. | |
setReadOnly(boolean value) Set the read-onlyness of the rowset | |
setRef(int i, java.sql.Ref x) Set a REF(<structured-type>) parameter. | |
setShort(int parameterIndex, short x) Set a parameter to a Java short value. | |
setString(int parameterIndex, java.lang.String x) Set a parameter to a Java String value. | |
setTime(int parameterIndex, java.sql.Time x) Set a parameter to a java.sql.Time value. | |
setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) Set a parameter to a java.sql.Time value. | |
setTimestamp(int parameterIndex, java.sql.Timestamp x) Set a parameter to a java.sql.Timestamp value. | |
setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) Set a parameter to a java.sql.Timestamp value. | |
setTransactionIsolation(int level) Set the transaction isolation. | |
setType(int type) Set the rowset type. | |
setTypeMap(java.util.Map map) Install a type-map object as the default type-map for this rowset. | |
setUrl(java.lang.String url) Set the url used to create a connection. | |
setUsername(java.lang.String name) Set the user name. |
Methods inherited from interface java.sql.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, getInt, getInt, getLong, getLong, getMetaData, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getShort, getShort, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getWarnings, insertRow, isAfterLast, isBeforeFirst, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRow, updateShort, updateShort, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull |
public java.lang.StringgetUrl() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetUrl(java.lang.String url) throws java.sql.SQLException
url
- a string value, may be nulljava.sql.SQLException
- if a database-access error occurs.public java.lang.StringgetDataSourceName()
public voidsetDataSourceName(java.lang.String name) throws java.sql.SQLException
name
- a data source namejava.sql.SQLException
- if a database-access error occurs.public java.lang.StringgetUsername()
public voidsetUsername(java.lang.String name) throws java.sql.SQLException
name
- a user namejava.sql.SQLException
- if a database-access error occurs.public java.lang.StringgetPassword()
public voidsetPassword(java.lang.String password) throws java.sql.SQLException
password
- the password stringjava.sql.SQLException
- if a database-access error occurs.public intgetTransactionIsolation()
public voidsetTransactionIsolation(int level) throws java.sql.SQLException
level
- the transaction isolation leveljava.sql.SQLException
- if a database-access error occurs.public java.util.MapgetTypeMap() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetTypeMap(java.util.Map map) throws java.sql.SQLException
map
- a map objectjava.sql.SQLException
- if a database-access error occurs.public java.lang.StringgetCommand()
public voidsetCommand(java.lang.String cmd) throws java.sql.SQLException
cmd
- a command string, may be nulljava.sql.SQLException
- if a database-access error occurs.public booleanisReadOnly()
public voidsetReadOnly(boolean value) throws java.sql.SQLException
value
- true if read-only, false otherwisejava.sql.SQLException
- if a database-access error occurs.public intgetMaxFieldSize() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetMaxFieldSize(int max) throws java.sql.SQLException
max
- the new max column size limit; zero means unlimitedjava.sql.SQLException
- if a database-access error occurs.public intgetMaxRows() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetMaxRows(int max) throws java.sql.SQLException
max
- the new max rows limit; zero means unlimitedjava.sql.SQLException
- if a database-access error occurs.public booleangetEscapeProcessing() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetEscapeProcessing(boolean enable) throws java.sql.SQLException
enable
- true to enable; false to disablejava.sql.SQLException
- if a database-access error occurs.public intgetQueryTimeout() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetQueryTimeout(int seconds) throws java.sql.SQLException
seconds
- the new query timeout limit in seconds; zero means unlimitedjava.sql.SQLException
- if a database-access error occurs.public voidsetType(int type) throws java.sql.SQLException
type
- a value from ResultSet.TYPE_XXXjava.sql.SQLException
- if a database-access error occurs.public voidsetConcurrency(int concurrency) throws java.sql.SQLException
concurrency
- a value from ResultSet.CONCUR_XXXjava.sql.SQLException
- if a database-access error occurs.public voidsetNull(int parameterIndex, int sqlType) throws java.sql.SQLException
Note: You must specify the parameter's SQL type.
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- SQL type code defined by java.sql.Typesjava.sql.SQLException
- if a database-access error occurs.public voidsetNull(int paramIndex, int sqlType, java.lang.String typeName) throws java.sql.SQLException
Note: To be portable, applications must give the SQL type code and the fully qualified SQL type name when specifying a NULL user-named or REF parameter. In the case of a user-named 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-named 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-named or REF type then the typeName is ignored.
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value from java.sql.TypestypeName
- the fully qualified name of a SQL user-named type, ignored if the parameter is not a user-named type or REFjava.sql.SQLException
- if a database-access error occurs.public voidsetBoolean(int parameterIndex, boolean x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetByte(int parameterIndex, byte x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetShort(int parameterIndex, short x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetInt(int parameterIndex, int x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetLong(int parameterIndex, long x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetFloat(int parameterIndex, float x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetDouble(int parameterIndex, double x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetBigDecimal(int parameterIndex, java.math.BigDecimal x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetString(int parameterIndex, java.lang.String x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetBytes(int parameterIndex, byte[] x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetDate(int parameterIndex, java.sql.Date x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetTime(int parameterIndex, java.sql.Time x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetTimestamp(int parameterIndex, java.sql.Timestamp x) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetAsciiStream(int parameterIndex, java.io.InputStream x, int length) throws java.sql.SQLException
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the ASCII parameter valuelength
- the number of bytes in the streamjava.sql.SQLException
- if a database-access error occurs.public voidsetBinaryStream(int parameterIndex, java.io.InputStream x, int length) throws java.sql.SQLException
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the streamjava.sql.SQLException
- if a database-access error occurs.public voidsetCharacterStream(int parameterIndex, java.io.Reader reader, int length) throws java.sql.SQLException
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java reader which contains the UNICODE datalength
- the number of characters in the streamjava.sql.SQLException
- if a database-access error occurs.public voidsetObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) throws java.sql.SQLException
Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.
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 its method writeSQL() to write it to the SQL data stream. else If the object is of a class implementing Ref, Blob, Clob, Struct, or Array then pass it to the database as a value of the corresponding SQL type.
Note that this method may be used to pass datatabase- specific abstract data types.
parameterIndex
- The first parameter is 1, the second is 2, ...x
- The object containing the input parameter 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. For all other types this value will be ignored,java.sql.SQLException
- if a database-access error occurs.Types
public voidsetObject(int parameterIndex, java.lang.Object x, int targetSqlType) throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidsetObject(int parameterIndex, java.lang.Object x) throws java.sql.SQLException
Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.
The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument java object will be converted to the corresponding SQL type before being sent to the database.
Note that this method may be used to pass datatabase specific abstract data types, by using a Driver specific Java type. If the object is of a class implementing SQLData, the rowset should call its method writeSQL() to write it to the SQL data stream. else If the object is of a class implementing Ref, Blob, Clob, Struct, or Array then pass it to the database as a value of the corresponding SQL type. Raise an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of those interfaces.
parameterIndex
- The first parameter is 1, the second is 2, ...x
- The object containing the input parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetRef(int i, java.sql.Ref x) throws java.sql.SQLException
i
- the first parameter is 1, the second is 2, ...x
- an object representing data of an SQL REF Typepublic voidsetBlob(int i, java.sql.Blob x) throws java.sql.SQLException
i
- the first parameter is 1, the second is 2, ...x
- an object representing a BLOBpublic voidsetClob(int i, java.sql.Clob x) throws java.sql.SQLException
i
- the first parameter is 1, the second is 2, ...x
- an object representing a CLOBpublic voidsetArray(int i, java.sql.Array x) throws java.sql.SQLException
i
- the first parameter is 1, the second is 2, ...x
- an object representing an SQL arraypublic voidsetDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidsetTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) throws java.sql.SQLException
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuejava.sql.SQLException
- if a database-access error occurs.public voidclearParameters() throws java.sql.SQLException
In general, parameter values remain in force for repeated use of a RowSet. 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; this can be done by calling clearParameters.
java.sql.SQLException
- if a database-access error occurs.public voidexecute() throws java.sql.SQLException
java.sql.SQLException
- if a database-access error occurs.public voidaddRowSetListener(RowSetListener listener)
listener
- an event listenerpublic voidremoveRowSetListener(RowSetListener listener)
listener
- an event listener