Java Doc for CachedRowSetImpl.java in  » 6.0-JDK-Modules-com.sun » rowset » com » sun » rowset » Java Source Code / Java DocumentationJava Source Code and Java Documentation

If the number is positive, the cursor moves to an absolute row with respect to the beginning of the rowset.

NoteIn the reference implementation an optimistic concurrency implementation is provided as a sample implementation of a the SyncProvider abstract class.

This method fails if any of the updates cannot be propagated back to the data source.

This method marks the current row as deleted, but it does not delete the row from the underlying data source.

A column value can be retrieved as a stream of uninterpreted bytes and then read in chunks from the stream.

A column value can be retrieved as a stream of uninterpreted bytes and then read in chunks from the stream.

Note: All the data in the returned stream must be read prior to getting the value of any other column.

Note: All the data in the returned stream must be read prior to getting the value of any other column.

In SQL, a result table is retrieved through a cursor that is named.

The type of the Object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC 3.0 specification.

This method may also be used to read datatabase-specific abstract data types.

This implementation of the method getObject extends its behavior so that it gets the attributes of an SQL structured type as an array of Object values.

The type of the Object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC 3.0 specification.

This method may also be used to read datatabase-specific abstract data types.

This implementation of the method getObject extends its behavior so that it gets the attributes of an SQL structured type as an array of Object values.

Note: calling the method previous() is not the same as calling the method relative(-1).

If the number is positive, the cursor moves the specified number of rows toward the end of the rowset, starting at the current row. For example, the following command, in which crs is a CachedRowSetImpl object with 100 rows, moves the cursor forward four rows from the current row.

The command property may not be needed if the rowset is produced by a data source, such as a spreadsheet, that does not support commands.

The JDBC specification specifies a standard mapping from Java Object types to SQL types.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset; however, another method must be called to complete the update process.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

This method cannot be called when the cursor is on the insert row, and it should be called before the cursor moves to another row.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in the current row or the insert row of this rowset, but it does not update the database. If the cursor is on a row in the rowset, the method CachedRowSetImpl.updateRow must be called to update the database. If the cursor is on the insert row, the method CachedRowSetImpl.insertRow must be called, which will insert the new row into both this rowset and the database.

This method updates a column value in either the current row or the insert row of this rowset, but it does not update the database.

 onInsertRow = false
 insertRow = null
 cursorPos = 0
 numRows = 0
 showDeleted = false
 queryTimeout = 0
 maxRows = 0
 maxFieldSize = 0
 rowSetType = ResultSet.TYPE_SCROLL_INSENSITIVE
 concurrency = ResultSet.CONCUR_UPDATABLE
 readOnly = false
 isolation = Connection.TRANSACTION_READ_COMMITTED
 escapeProcessing = true
 onInsertRow = false
 insertRow = null
 cursorPos = 0
 absolutePos = 0
 numRows = 0
 

throws:
  SQLException - if an error occurs

 onInsertRow = false
 insertRow = null
 cursorPos = 0
 numRows = 0
 showDeleted = false
 queryTimeout = 0
 maxRows = 0
 maxFieldSize = 0
 rowSetType = ResultSet.TYPE_SCROLL_INSENSITIVE
 concurrency = ResultSet.CONCUR_UPDATABLE
 readOnly = false
 isolation = Connection.TRANSACTION_READ_COMMITTED
 escapeProcessing = true
 onInsertRow = false
 insertRow = null
 cursorPos = 0
 absolutePos = 0
 numRows = 0
 

For example, creating a CachedRowSetImpl object as follows ensures that a it is established with the com.foo.provider.Impl synchronization implementation providing the synchronization mechanism for this disconnected RowSet object.

 Hashtable env = new Hashtable();
 env.put(javax.sql.rowset.spi.SyncFactory.ROWSET_PROVIDER_NAME,
 "com.foo.provider.Impl");
 CachedRowSetImpl crs = new CachedRowSet(env);
 

Calling this constructor with a null parameter will cause the SyncFactory to provide the reference optimistic provider com.sun.rowset.providers.RIOptimisticProvider.

In addition, the following properties can be associated with the provider to assist in determining the choice of the synchronizaton provider such as:

• ROWSET_SYNC_PROVIDER - the property specifying the the SyncProvider class name to be instantiated by the SyncFacttory
• ROWSET_SYNC_VENDOR - the property specifying the software vendor associated with a SyncProvider implementation.
• ROWSET_SYNC_PROVIDER_VER - the property specifying the version of the SyncProvider implementation provided by the software vendor.

Parameters:
  env - a Hashtable object with a list of desiredsynchronization providers
throws:
  SQLException - if the requested provider cannot be found by thesynchonization factory
See Also:   SyncProvider

If the number is positive, the cursor moves to an absolute row with respect to the beginning of the rowset. The first row is row 1, the second is row 2, and so on. For example, the following command, in which crs is a CachedRowSetImpl object, moves the cursor to the fourth row, starting from the beginning of the rowset.

 crs.absolute(4);
  

If the number is negative, the cursor moves to an absolute row position with respect to the end of the rowset. For example, calling absolute(-1) positions the cursor on the last row, absolute(-2) moves it on the next-to-last row, and so on. If the CachedRowSetImpl object crs has five rows, the following command moves the cursor to the fourth-to-last row, which in the case of a rowset with five rows, is also the second row, counting from the beginning.

 crs.absolute(-4);
  

Note: Calling absolute(1) is the same as calling the method first(). Calling absolute(-1) is the same as calling last().
Parameters:
  row - a positive number to indicate the row, starting row numbering fromthe first row, which is 1; a negative number to indicatethe row, starting row numbering from the last row, which is-1; it must not be 0 true if the cursor is on the rowset; falseotherwise
throws:
  SQLException - if the given cursor position is 0 or thetype of this rowset is ResultSet.TYPE_FORWARD_ONLY

NoteIn the reference implementation an optimistic concurrency implementation is provided as a sample implementation of a the SyncProvider abstract class.

This method fails if any of the updates cannot be propagated back to the data source. When it fails, the caller can assume that none of the updates are reflected in the data source. When an exception is thrown, the current row is set to the first "updated" row that resulted in an exception unless the row that caused the exception is a "deleted" row. In that case, when deleted rows are not shown, which is usually true, the current row is not affected.

If no SyncProvider is configured, the reference implementation leverages the RIOptimisticProvider available which provides the default and reference synchronization capabilities for disconnected RowSets.
throws:
  SQLException - if the cursor is on the insert row or the underlyingreference synchronization provider fails to commit the updatesto the datasource
throws:
  SyncProviderException - if an internal error occurs within theSyncProvider instance during either during theprocess or at any time when the SyncProviderinstance touches the data source.
See Also:   CachedRowSetImpl.acceptChanges(java.sql.Connection)
See Also:   javax.sql.RowSetWriter
See Also:   javax.sql.rowset.spi.SyncProvider

The reference implementation RIOptimisticProvider modifies its synchronization to a write back function given the updated connection The reference implementation modifies its synchronization behaviour via the SyncProvider to ensure the synchronization occurs according to the updated JDBC Connection properties.
Parameters:
  con - a standard JDBC Connection object
throws:
  SQLException - if the cursor is on the insert row or the underlyingsynchronization provider fails to commit the updatesback to the data source
See Also:   CachedRowSetImpl.acceptChanges
See Also:   javax.sql.RowSetWriter
See Also:   javax.sql.rowset.spi.SyncFactory
See Also:   javax.sql.rowset.spi.SyncProvider

Making a copy saves the cost of creating an identical rowset from first principles, which can be quite expensive. For example, it can eliminate the need to query a remote database server. a new CachedRowSet object that is a deep copyof this CachedRowSet object and iscompletely independent from this CachedRowSetImplobject.
throws:
  SQLException - if an error occurs in generating the copy of thisof the CachedRowSetImpl
See Also:   CachedRowSetImpl.createShared
See Also:   javax.sql.RowSetEvent
See Also:   javax.sql.RowSetListener

This helps in getting the underlying XML schema which can be used as the basis for populating a WebRowSet. a new CachedRowSet object that is a copyof this CachedRowSetImpl object's schema andretains all the constraints on the original rowset but containsno data
throws:
  SQLException - if an error occurs in generating the copyof the CachedRowSet object
See Also:   CachedRowSetImpl.createShared
See Also:   CachedRowSetImpl.createCopy
See Also:   CachedRowSetImpl.createCopyNoConstraints
See Also:   javax.sql.RowSetEvent
See Also:   javax.sql.RowSetListener

This method marks the current row as deleted, but it does not delete the row from the underlying data source. The method acceptChanges must be called to delete the row in the data source.
throws:
  SQLException - if (1) this method is called when the cursoris on the insert row, before the first row, or after thelast row or (2) this rowset isResultSet.CONCUR_READ_ONLY

Another form of this method uses an existing JDBC Connection object instead of creating a new one; therefore, it ignores the properties used for establishing a new connection.

The query specified by the command property is executed to create a ResultSet object from which to retrieve data. The current contents of the rowset are discarded, and the rowset's metadata is also (re)set. If there are outstanding updates, they are also ignored.

The method execute closes any database connections that it creates.
throws:
  SQLException - if an error occurs or thenecessary properties have not been set

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. . Also, a stream may return 0 for CachedRowSetImpl.available() whether there is data available or not.
Parameters:
  columnIndex - the first column is 1, the secondis 2, and so on; must be 1 or largerand equal to or less than the number of columns in this rowset a Java input stream that delivers the database column valueas a stream of one-byte ASCII characters. If the value is SQLNULL, the result is null.
throws:
  SQLException - if (1) the given column index is out of bounds,(2) the cursor is not on one of this rowset's rows or itsinsert row, or (3) the designated column does not store anSQL CHAR, VARCHAR, LONGVARCHARBINARY, VARBINARY or LONGVARBINARY value. Thebold SQL type designates the recommended return types that this method isused to retrieve.
See Also:   CachedRowSetImpl.getAsciiStream(String)

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getXXX method implicitly closes the stream.
Parameters:
  columnName - a String object giving the SQL name ofa column in this CachedRowSetImpl object a Java input stream that delivers the database column valueas a stream of one-byte ASCII characters. If the value is SQLNULL, the result is null.
throws:
  SQLException - if (1) the given column name is not the name ofa column in this rowset(2) the cursor is not on one of this rowset's rows or itsinsert row, or (3) the designated column does not store anSQL CHAR, VARCHAR, LONGVARCHARBINARY, VARBINARY or LONGVARBINARY value. Thebold SQL type designates the recommended return types that this method isused to retrieve.
See Also:   CachedRowSetImpl.getAsciiStream(int)

This method is deprecated; use the version of getBigDecimal that does not take a scale parameter and returns a value with full precision.
Parameters:
  columnIndex - the first column is 1, the secondis 2, and so on; must be 1 or largerand equal to or less than the number of columns in the rowset
Parameters:
  scale - the number of digits to the right of the decimal point in thevalue returned the column value with the specified number of digits to the rightof the decimal point; if the value is SQL NULL, theresult is null
throws:
  SQLException - if the given column index is out of bounds,the cursor is not on a valid row, or this method fails

A column value can be retrieved as a stream of uninterpreted bytes and then read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 for CachedRowSetImpl.available() whether there is data available or not.
Parameters:
  columnIndex - the first column is 1, the secondis 2, and so on; must be 1 or largerand equal to or less than the number of columns in the rowset a Java input stream that delivers the database column valueas a stream of uninterpreted bytes. If the value is SQL NULLthen the result is null.
throws:
  SQLException - if (1) the given column index is out of bounds,(2) the cursor is not on one of this rowset's rows or itsinsert row, or (3) the designated column does not store anSQL BINARY, VARBINARY or LONGVARBINARYThe bold type indicates the SQL type that this method is recommenedto retrieve.
See Also:   CachedRowSetImpl.getBinaryStream(String)

A column value can be retrieved as a stream of uninterpreted bytes and then read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 for CachedRowSetImpl.available() whether there is data available or not.
Parameters:
  columnName - a String object giving the SQL name ofa column in this CachedRowSetImpl object a Java input stream that delivers the database column valueas a stream of uninterpreted bytes. If the value is SQLNULL, the result is null.
throws:
  SQLException - if (1) the given column name is unknown,(2) the cursor is not on one of this rowset's rows or itsinsert row, or (3) the designated column does not store anSQL BINARY, VARBINARY or LONGVARBINARYThe bold type indicates the SQL type that this method is recommenedto retrieve.
See Also:   CachedRowSetImpl.getBinaryStream(int)

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getXXX method implicitly closes the stream.
Parameters:
  columnIndex - the first column is 1, the secondis 2, and so on; must be 1 or largerand equal to or less than the number of columns in the rowset a Java character stream that delivers the database column valueas a stream of two-byte unicode characters in ajava.io.Reader object. If the value isSQL NULL, the result is null.
throws:
  SQLException - if (1) the given column index is out of bounds,(2) the cursor is not on one of this rowset's rows or itsinsert row, or (3) the designated column does not store anSQL CHAR, VARCHAR, LONGVARCHAR, BINARY, VARBINARY orLONGVARBINARY value.The bold SQL type designates the recommended return type.
See Also:   CachedRowSetImpl.getCharacterStream(String)

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getXXX method implicitly closes the stream.
Parameters:
  columnName - a String object giving the SQL name ofa column in this CachedRowSetImpl object a Java input stream that delivers the database column valueas a stream of two-byte Unicode characters. If the value isSQL NULL, the result is null.
throws:
  SQLException - if (1) the given column name is not the name ofa column in this rowset, (2) the cursor is not on one ofthis rowset's rows or its insert row, or (3) the designatedcolumn does not store an SQL CHAR, VARCHAR, LONGVARCHAR,BINARY, VARYBINARY or LONGVARBINARY value.The bold SQL type designates the recommended return type.

In SQL, a result table is retrieved through a cursor that is named. The current row of a ResultSet can be updated or deleted using a positioned update/delete statement that references the cursor name. To ensure that the cursor has the proper isolation level to support an update operation, the cursor's SELECT statement should be of the form select for update. If the for update clause is omitted, positioned updates may fail.

JDBC supports this SQL feature by providing the name of the SQL cursor used by a ResultSet object. The current row of a result set is also the current row of this SQL cursor.

Note: If positioned updates are not supported, an SQLException is thrown. the SQL cursor name for this CachedRowSetImpl object'scursor
throws:
  SQLException - if an error occurs

For example:

 CachedRowSet crs = new CachedRowSetImpl();
 RowSetMetaDataImpl metaData =
 (RowSetMetaDataImpl)crs.getMetaData();
 // Set the number of columns in the RowSet object for
 // which this RowSetMetaDataImpl object was created to the
 // given number.
 metaData.setColumnCount(3);
 crs.setMetaData(metaData);
 

The type of the Object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC 3.0 specification.

This method may also be used to read datatabase-specific abstract data types.

This implementation of the method getObject extends its behavior so that it gets the attributes of an SQL structured type as an array of Object values. This method also custom maps SQL user-defined types to classes in the Java programming language. When the specified column contains a structured or distinct value, the behavior of this method is as if it were a call to the method getObject(columnIndex, this.getStatement().getConnection().getTypeMap()).
Parameters:
  columnIndex - the first column is 1, the secondis 2, and so on; must be 1 or largerand equal to or less than the number of columns in the rowset a java.lang.Object holding the column value;if the value is SQL NULL, the result is null
throws:
  SQLException - if the given column index is out of bounds,the cursor is not on a valid row, or there is a problem gettingthe Class object for a custom mapping
See Also:   CachedRowSetImpl.getObject(String)

The type of the Object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC 3.0 specification.

This method may also be used to read datatabase-specific abstract data types.

This implementation of the method getObject extends its behavior so that it gets the attributes of an SQL structured type as an array of Object values. This method also custom maps SQL user-defined types to classes in the Java programming language. When the specified column contains a structured or distinct value, the behavior of this method is as if it were a call to the method getObject(columnIndex, this.getStatement().getConnection().getTypeMap()).
Parameters:
  columnName - a String object that must match theSQL name of a column in this rowset, ignoring case a java.lang.Object holding the column value;if the value is SQL NULL, the result is null
throws:
  SQLException - if (1) the given column name does not match one ofthis rowset's column names, (2) the cursor is noton a valid row, or (3) there is a problem gettingthe Class object for a custom mapping
See Also:   CachedRowSetImpl.getObject(int)

The cursor is positioned before the first row in the result set. Only rows contained in the result set returned by getOriginal() are said to have an original value. the original result set of the rowset
throws:
  SQLException - if an error occurs produce theResultSet object

The warning chain is automatically cleared each time a new row is read.

Note: This warning chain only covers warnings caused by CachedRowSet (and their child interface) methods. All SQLWarnings can be obtained using the getWarnings method which tracks warnings generated by the underlying JDBC driver. the first SQLWarning or null