File	Doc	Category	Size	Date	Package
RowSet.java	API Doc	Java SE 5 API	40716	Fri Aug 26 14:57:50 BST 2005	javax.sql

RowSet

Fields Summary

Constructors Summary

Methods Summary
public void	addRowSetListener(javax.sql.RowSetListener listener) Registers the given listener so that it will be notified of events that occur on this RowSet object. param listener a component that has implemented the RowSetListener interface and wants to be notified when events occur on this RowSet object see #removeRowSetListener
public void	clearParameters() Clears the parameters set for this RowSet object's command. In general, parameter values remain in force for repeated use of a RowSet object. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values, which can be done by calling the method clearParameters. exception SQLException if a database access error occurs
public void	execute() Fills this RowSet object with data. The execute method may use the following properties to create a connection for reading data: url, data source name, user name, password, transaction isolation, and type map. The execute method may use the following properties to create a statement to execute a command: command, read only, maximum field size, maximum rows, escape processing, and query timeout. If the required properties have not been set, an exception is thrown. If this method is successful, the current contents of the rowset are discarded and the rowset's metadata is also (re)set. If there are outstanding updates, they are ignored. If this RowSet object does not maintain a continuous connection with its source of data, it may use a reader (a RowSetReader object) to fill itself with data. In this case, a reader will have been registered with this RowSet object, and the method execute will call on the reader's readData method as part of its implementation. exception 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
public java.lang.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. return the command string; may be null see #setCommand
public java.lang.String	getDataSourceName() Retrieves the logical name that identifies the data source for this RowSet 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. return a data source name see #setDataSourceName see #setUrl
public boolean	getEscapeProcessing() Retrieves whether escape processing is enabled for this RowSet object. If escape scanning is enabled, which is the default, the driver will do escape substitution before sending an SQL statement to the database. return true if escape processing is enabled; false if it is disabled exception SQLException if a database access error occurs see #setEscapeProcessing
public int	getMaxFieldSize() Retrieves the maximum number of bytes that may be returned for certain column values. This limit applies only to BINARY, VARBINARY, LONGVARBINARYBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. return the current maximum column size limit; zero means that there is no limit exception SQLException if a database access error occurs see #setMaxFieldSize
public int	getMaxRows() Retrieves the maximum number of rows that this RowSet object can contain. If the limit is exceeded, the excess rows are silently dropped. return the current maximum number of rows that this RowSet object can contain; zero means unlimited exception SQLException if a database access error occurs see #setMaxRows
public java.lang.String	getPassword() Retrieves the password used to create a database connection. The password property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object. return the password for making a database connection see #setPassword
public int	getQueryTimeout() Retrieves the maximum number of seconds the driver will wait for a statement to execute. If this limit is exceeded, an SQLException is thrown. return the current query timeout limit in seconds; zero means unlimited exception SQLException if a database access error occurs see #setQueryTimeout
public int	getTransactionIsolation() Retrieves the transaction isolation level set for this RowSet object. return the transaction isolation level; one of Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE see #setTransactionIsolation
public java.util.Map	getTypeMap() Retrieves the Map object associated with this RowSet object, which specifies the custom mapping of SQL user-defined types, if any. The default is for the type map to be empty. return a java.util.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped exception SQLException if a database access error occurs see #setTypeMap
public java.lang.String	getUrl() Retrieves the url property this RowSet object will use to create a connection if it uses the DriverManager instead of a DataSource object to establish the connection. The default value is null. return a string url exception SQLException if a database access error occurs see #setUrl
public java.lang.String	getUsername() Retrieves the username used to create a database connection for this RowSet object. The username property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object. return the username property see #setUsername
public boolean	isReadOnly() Retrieves whether this RowSet object is read-only. If updates are possible, the default is for a rowset to be updatable. Attempts to update a read-only rowset will result in an SQLException being thrown. return true if this RowSet object is read-only; false if it is updatable see #setReadOnly
public void	removeRowSetListener(javax.sql.RowSetListener listener) Removes the specified listener from the list of components that will be notified when an event occurs on this RowSet object. param listener a component that has been registered as a listener for this RowSet object see #addRowSetListener
public void	setArray(int i, java.sql.Array x) Sets the designated parameter in this RowSet object's command with the given Array value. The driver will convert this to the ARRAY value that the Array object represents before sending it to the database. param i the first parameter is 1, the second is 2, ... param x an object representing an SQL array exception SQLException if a database access error occurs
public void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large ASCII value via a java.io.InputStream rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. param parameterIndex the first parameter is 1, the second is 2, ... param x the Java input stream that contains the ASCII parameter value param length the number of bytes in the stream exception SQLException if a database access error occurs
public void	setBigDecimal(int parameterIndex, java.math.BigDecimal x) Sets the designated parameter in this RowSet object's command to the given java.math.BigDeciaml value. The driver converts this to an SQL NUMERIC value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large binary value via a java.io.InputStream rather than as a LONGVARBINARY parameter. The driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. param parameterIndex the first parameter is 1, the second is 2, ... param x the java input stream which contains the binary parameter value param length the number of bytes in the stream exception SQLException if a database access error occurs
public void	setBlob(int i, java.sql.Blob x) Sets the designated parameter in this RowSet object's command with the given Blob value. The driver will convert this to the BLOB value that the Blob object represents before sending it to the database. param i the first parameter is 1, the second is 2, ... param x an object representing a BLOB exception SQLException if a database access error occurs
public void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter in this RowSet object's command to the given Java boolean value. The driver converts this to an SQL BIT value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setByte(int parameterIndex, byte x) Sets the designated parameter in this RowSet object's command to the given Java byte value. The driver converts this to an SQL TINYINT value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter in this RowSet object's command to the given Java array of byte values. Before sending it to the database, the driver converts this to an SQL VARBINARY or LONGVARBINARY value, depending on the argument's size relative to the driver's limits on VARBINARY values. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length) Sets the designated parameter in this RowSet object's command to the given java.io.Reader value. It may be more practical to send a very large UNICODE value via a java.io.Reader rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. param parameterIndex the first parameter is 1, the second is 2, ... param reader the Reader object that contains the UNICODE data to be set param length the number of characters in the stream exception SQLException if a database access error occurs
public void	setClob(int i, java.sql.Clob x) Sets the designated parameter in this RowSet object's command with the given Clob value. The driver will convert this to the CLOB value that the Clob object represents before sending it to the database. param i the first parameter is 1, the second is 2, ... param x an object representing a CLOB exception SQLException if a database access error occurs
public void	setCommand(java.lang.String cmd) Sets this RowSet object's command property to the given SQL query. This property is optional when a rowset gets its data from a data source that does not support commands, such as a spreadsheet. param cmd the SQL query that will be used to get the data for this RowSet object; may be null exception SQLException if a database access error occurs see #getCommand
public void	setConcurrency(int concurrency) Sets the concurrency of this RowSet object to the given concurrency level. This method is used to change the concurrency level of a rowset, which is by default ResultSet.CONCUR_READ_ONLY param concurrency one of the ResultSet constants specifying a concurrency level: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE exception SQLException if a database access error occurs see ResultSet#getConcurrency
public void	setDataSourceName(java.lang.String name) Sets the data source name property for this RowSet object to the given String. The value of the data source name property can be used to do a lookup of a DataSource object that has been registered with a naming service. After being retrieved, the DataSource object can be used to create a connection to the data source that it represents. param name the logical name of the data source for this RowSet object exception SQLException if a database access error occurs see #getDataSourceName
public void	setDate(int parameterIndex, java.sql.Date x) Sets the designated parameter in this RowSet object's command to the given java.sql.Date value. The driver converts this to an SQL DATE value before sending it to the database, using the default java.util.Calendar to calculate the date. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) Sets the designated parameter in this RowSet object's command with the given java.sql.Date value. The driver will convert this to an SQL DATE value, using the given java.util.Calendar object to calculate the date. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value param cal the java.util.Calendar object to use for calculating the date exception SQLException if a database access error occurs
public void	setDouble(int parameterIndex, double x) Sets the designated parameter in this RowSet object's command to the given Java double value. The driver converts this to an SQL DOUBLE value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setEscapeProcessing(boolean enable) Sets escape processing for this RowSet object on or off. If escape scanning is on (the default), the driver will do escape substitution before sending an SQL statement to the database. param enable true to enable escape processing; false to disable it exception SQLException if a database access error occurs see #getEscapeProcessing
public void	setFloat(int parameterIndex, float x) Sets the designated parameter in this RowSet object's command to the given Java float value. The driver converts this to an SQL REAL value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setInt(int parameterIndex, int x) Sets the designated parameter in this RowSet object's command to the given Java int value. The driver converts this to an SQL INTEGER value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setLong(int parameterIndex, long x) Sets the designated parameter in this RowSet object's command to the given Java long value. The driver converts this to an SQL BIGINT value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setMaxFieldSize(int max) Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. This limit applies only to BINARY, VARBINARY, LONGVARBINARYBINARY, CHAR, VARCHAR, and LONGVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256. param max the new max column size limit in bytes; zero means unlimited exception SQLException if a database access error occurs see #getMaxFieldSize
public void	setMaxRows(int max) Sets the maximum number of rows that this RowSet object can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped. param max the new maximum number of rows; zero means unlimited exception SQLException if a database access error occurs see #getMaxRows
public void	setNull(int parameterIndex, int sqlType) Sets the designated parameter in this RowSet object's SQL command to SQL NULL. Note: You must specify the parameter's SQL type. param parameterIndex the first parameter is 1, the second is 2, ... param sqlType a SQL type code defined by java.sql.Types exception SQLException if a database access error occurs
public void	setNull(int paramIndex, int sqlType, java.lang.String typeName) Sets the designated parameter in this RowSet object's SQL command to SQL NULL. This version of the method setNull should be used for SQL user-defined types (UDTs) and REF type parameters. Examples of UDTs include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types. Note: To be portable, applications must give the SQL type code and the fully qualified SQL type name when specifying a NULL UDT or REF parameter. In the case of a UDT, the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for UDT and REF parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored. param paramIndex the first parameter is 1, the second is 2, ... param sqlType a value from java.sql.Types param 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 exception SQLException if a database access error occurs
public void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) 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. param parameterIndex the first parameter is 1, the second is 2, ... param x the object containing the input parameter value param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. param 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. exception SQLException if a database access error occurs see java.sql.Types
public void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType) Sets the designated parameter in this RowSet object's command with a Java Object. For integral values, the java.lang equivalent objects should be used. This method is like setObject above, but the scale used is the scale of the second parameter. Scalar values have a scale of zero. Literal values have the scale present in the literal. Even though it is supported, it is not recommended that this method be called with floating point input values. param parameterIndex the first parameter is 1, the second is 2, ... param x the object containing the input parameter value param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database exception SQLException if a database access error occurs
public void	setObject(int parameterIndex, java.lang.Object x) Sets the designated parameter in this RowSet object's command with a Java Object. For integral values, the java.lang equivalent objects should be used. The JDBC specification provides a standard mapping from Java Object types to SQL types. The driver will convert the given Java object to its standard SQL mapping before sending it to the database. Note that this method may be used to pass datatabase-specific abstract data types by using a driver-specific Java type. If the object is of a class implementing SQLData, the rowset should call the method SQLData.writeSQL to write the object to an SQLOutput data stream. If 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. param parameterIndex The first parameter is 1, the second is 2, ... param x The object containing the input parameter value exception SQLException if a database access error occurs
public void	setPassword(java.lang.String password) Sets the database password for this RowSet object to the given String. param password the password string exception SQLException if a database access error occurs see #getPassword
public void	setQueryTimeout(int seconds) Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. If this limit is exceeded, an SQLException is thrown. param seconds the new query timeout limit in seconds; zero means that there is no limit exception SQLException if a database access error occurs see #getQueryTimeout
public void	setReadOnly(boolean value) Sets whether this RowSet object is read-only to the given boolean. param value true if read-only; false if updatable exception SQLException if a database access error occurs see #isReadOnly
public void	setRef(int i, java.sql.Ref x) Sets the designated parameter in this RowSet object's command with the given Ref value. The driver will convert this to the appropriate REF(<structured-type>) value. param i the first parameter is 1, the second is 2, ... param x an object representing data of an SQL REF type exception SQLException if a database access error occurs
public void	setShort(int parameterIndex, short x) Sets the designated parameter in this RowSet object's command to the given Java short value. The driver converts this to an SQL SMALLINT value before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setString(int parameterIndex, java.lang.String x) Sets the designated parameter in this RowSet object's command to the given Java String value. Before sending it to the database, the driver converts this to an SQL VARCHAR or LONGVARCHAR value, depending on the argument's size relative to the driver's limits on VARCHAR values. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setTime(int parameterIndex, java.sql.Time x) Sets the designated parameter in this RowSet object's command to the given java.sql.Time value. The driver converts this to an SQL TIME value before sending it to the database, using the default java.util.Calendar to calculate it. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) Sets the designated parameter in this RowSet object's command with the given java.sql.Time value. The driver will convert this to an SQL TIME value, using the given java.util.Calendar object to calculate it, before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value param cal the java.util.Calendar object to use for calculating the time exception SQLException if a database access error occurs
public void	setTimestamp(int parameterIndex, java.sql.Timestamp x) Sets the designated parameter in this RowSet object's command to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value before sending it to the database, using the default java.util.Calendar to calculate it. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value exception SQLException if a database access error occurs
public void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) Sets the designated parameter in this RowSet object's command with the given java.sql.Timestamp value. The driver will convert this to an SQL TIMESTAMP value, using the given java.util.Calendar object to calculate it, before sending it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value param cal the java.util.Calendar object to use for calculating the timestamp exception SQLException if a database access error occurs
public void	setTransactionIsolation(int level) Sets the transaction isolation level for this RowSet obejct. param level the transaction isolation level; one of Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE exception SQLException if a database access error occurs see #getTransactionIsolation
public void	setType(int type) Sets the type of this RowSet object to the given type. This method is used to change the type of a rowset, which is by default read-only and non-scrollable. param type one of the ResultSet constants specifying a type: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE exception SQLException if a database access error occurs see java.sql.ResultSet#getType
public void	setTypeMap(java.util.Map map) Installs the given java.util.Map object as the default type map for this RowSet object. This type map will be used unless another type map is supplied as a method parameter. param 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 exception SQLException if a database access error occurs see #getTypeMap
public void	setUrl(java.lang.String url) Sets the URL this RowSet object will use when it uses the DriverManager to create a connection. Setting this property is optional. If a URL is used, a JDBC driver that accepts the URL must be loaded 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. param url a string value; may be null exception SQLException if a database access error occurs see #getUrl
public void	setUsername(java.lang.String name) Sets the username property for this RowSet object to the given String. param name a user name exception SQLException if a database access error occurs see #getUsername