Direct link to this page
JDK 1.6
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
/* * @(#)WebRowSet.java 1.7 06/04/07 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.sql.rowset; import java.sql.*; import javax.sql.*; import javax.naming.*; import java.io.*; import java.math.*; import org.xml.sax.*; /** * The standard interface that all implementations of a <code>WebRowSet</code> * must implement. * <P> * <h3>1.0 Overview</h3> * The <code>WebRowSetImpl</code> provides the standard * reference implementation, which may be extended if required. * <P> * The standard WebRowSet XML Schema definition is available at the following * URI: * <ul> * <pre> * <a href="http://java.sun.com/xml/ns/jdbc/webrowset.xsd">http://java.sun.com/xml/ns/jdbc/webrowset.xsd</a> * </pre> * </ul> * It describes the standard XML document format required when describing a * <code>RowSet</code> object in XML and must be used be all standard implementations * of the <code>WebRowSet</code> interface to ensure interoperability. In addition, * the <code>WebRowSet</code> schema uses specific SQL/XML Schema annotations, * thus ensuring greater cross * platform inter-operability. This is an effort currently under way at the ISO * organization. The SQL/XML definition is available at the following URI: * <ul> * <pre> * <a href="http://standards.iso.org/iso/9075/2002/12/sqlxml">http://standards.iso.org/iso/9075/2002/12/sqlxml</a> * </pre> * </ul> * The schema definition describes the internal data of a <code>RowSet</code> object * in three distinct areas: * <UL> * <li><b>properties</b></li> * These properties describe the standard synchronization provider properties in * addition to the more general <code>RowSet</code> properties. * <p> * <li><b>metadata</b></li> * This describes the metadata associated with the tabular structure governed by a * <code>WebRowSet</code> object. The metadata described is closely aligned with the * metadata accessible in the underlying <code>java.sql.ResultSet</code> interface. * <p> * <li><b>data</b></li> * This describes the original data (the state of data since the last population * or last synchronization of the <code>WebRowSet</code> object) and the current * data. By keeping track of the delta between the original data and the current data, * a <code>WebRowSet</code> maintains * the ability to synchronize changes in its data back to the originating data source. * </ul> * <P> * <h3>2.0 WebRowSet States</h3> * The following sections demonstrates how a <code>WebRowSet</code> implementation * should use the XML Schema to describe update, insert, and delete operations * and to describe the state of a <code>WebRowSet</code> object in XML. * <p> * <h4>2.1 State 1 - Outputting a <code>WebRowSet</code> Object to XML</h3> * In this example, a <code>WebRowSet</code> object is created and populated with a simple 2 column, * 5 row table from a data source. Having the 5 rows in a <code>WebRowSet</code> object * makes it possible to describe them in XML. The * metadata describing the various standard JavaBeans properties as defined * in the RowSet interface plus the standard properties defined in * the <code>CachedRowSet</code><sup><font size=-2>TM</font></sup> interface * provide key details that describe WebRowSet * properties. Outputting the WebRowSet object to XML using the standard * <code>writeXml</code> methods describes the internal properties as follows: * <PRE> * <<font color=red>properties</font>> * <<font color=red>command</font>>select co1, col2 from test_table<<font color=red>/command</font>> * <<font color=red>concurrency</font>>1<<font color=red>/concurrency</font>> * <<font color=red>datasource/</font>> * <<font color=red>escape-processing</font>>true<<font color=red>/escape-processing</font>> * <<font color=red>fetch-direction</font>>0<<font color=red>/fetch-direction</font>> * <<font color=red>fetch-size</font>>0<<font color=red>/fetch-size</font>> * <<font color=red>isolation-level</font>>1<<font color=red>/isolation-level</font>> * <<font color=red>key-columns/</font>> * <<font color=red>map/</font>> * <<font color=red>max-field-size</font>>0<<font color=red>/max-field-size</font>> * <<font color=red>max-rows</font>>0<<font color=red>/max-rows</font>> * <<font color=red>query-timeout</font>>0<<font color=red>/query-timeout</font>> * <<font color=red>read-only</font>>false<<font color=red>/read-only</font>> * <<font color=red>rowset-type</font>>TRANSACTION_READ_UNCOMMITED<<font color=red>/rowset-type</font>> * <<font color=red>show-deleted</font>>false<<font color=red>/show-deleted</font>> * <<font color=red>table-name/</font>> * <<font color=red>url</font>>jdbc:thin:oracle<<font color=red>/url</font>> * <<font color=red>sync-provider</font>> * <<font color=red>sync-provider-name</font>>.com.rowset.provider.RIOptimisticProvider<<font color=red>/sync-provider-name</font>> * <<font color=red>sync-provider-vendor</font>>Sun Microsystems<<font color=red>/sync-provider-vendor</font>> * <<font color=red>sync-provider-version</font>>1.0<<font color=red>/sync-provider-name</font>> * <<font color=red>sync-provider-grade</font>>LOW<<font color=red>/sync-provider-grade</font>> * <<font color=red>data-source-lock</font>>NONE<<font color=red>/data-source-lock</font>> * <<font color=red>/sync-provider</font>> * <<font color=red>/properties</font>> * </PRE> * The meta-data describing the make up of the WebRowSet is described * in XML as detailed below. Note both columns are described between the * <code>column-definition</code> tags. * <PRE> * <<font color=red>metadata</font>> * <<font color=red>column-count</font>>2<<font color=red>/column-count</font>> * <<font color=red>column-definition</font>> * <<font color=red>column-index</font>>1<<font color=red>/column-index</font>> * <<font color=red>auto-increment</font>>false<<font color=red>/auto-increment</font>> * <<font color=red>case-sensitive</font>>true<<font color=red>/case-sensitive</font>> * <<font color=red>currency</font>>false<<font color=red>/currency</font>> * <<font color=red>nullable</font>>1<<font color=red>/nullable</font>> * <<font color=red>signed</font>>false<<font color=red>/signed</font>> * <<font color=red>searchable</font>>true<<font color=red>/searchable</font>> * <<font color=red>column-display-size</font>>10<<font color=red>/column-display-size</font>> * <<font color=red>column-label</font>>COL1<<font color=red>/column-label</font>> * <<font color=red>column-name</font>>COL1<<font color=red>/column-name</font>> * <<font color=red>schema-name/</font>> * <<font color=red>column-precision</font>>10<<font color=red>/column-precision</font>> * <<font color=red>column-scale</font>>0<<font color=red>/column-scale</font>> * <<font color=red>table-name/</font>> * <<font color=red>catalog-name/</font>> * <<font color=red>column-type</font>>1<<font color=red>/column-type</font>> * <<font color=red>column-type-name</font>>CHAR<<font color=red>/column-type-name</font>> * <<font color=red>/column-definition</font>> * <<font color=red>column-definition</font>> * <<font color=red>column-index</font>>2<<font color=red>/column-index</font>> * <<font color=red>auto-increment</font>>false<<font color=red>/auto-increment</font>> * <<font color=red>case-sensitive</font>>false<<font color=red>/case-sensitive</font>> * <<font color=red>currency</font>>false<<font color=red>/currency</font>> * <<font color=red>nullable</font>>1<<font color=red>/nullable</font>> * <<font color=red>signed</font>>true<<font color=red>/signed</font>> * <<font color=red>searchable</font>>true<<font color=red>/searchable</font>> * <<font color=red>column-display-size</font>>39<<font color=red>/column-display-size</font>> * <<font color=red>column-label</font>>COL2<<font color=red>/column-label</font>> * <<font color=red>column-name</font>>COL2<<font color=red>/column-name</font>> * <<font color=red>schema-name/</font>> * <<font color=red>column-precision</font>>38<<font color=red>/column-precision</font>> * <<font color=red>column-scale</font>>0<<font color=red>/column-scale</font>> * <<font color=red>table-name/</font>> * <<font color=red>catalog-name/</font>> * <<font color=red>column-type</font>>3<<font color=red>/column-type</font>> * <<font color=red>column-type-name</font>>NUMBER<<font color=red>/column-type-name</font>> * <<font color=red>/column-definition</font>> * <<font color=red>/metadata</font>> * </PRE> * Having detailed how the properties and metadata are described, the following details * how the contents of a <code>WebRowSet</code> object is described in XML. Note, that * this describes a <code>WebRowSet</code> object that has not undergone any * modifications since its instantiation. * A <code>currentRow</code> tag is mapped to each row of the table structure that the * <code>WebRowSet</code> object provides. A <code>columnValue</code> tag may contain * either the <code>stringData</code> or <code>binaryData</code> tag, according to * the SQL type that * the XML value is mapping back to. The <code>binaryData</code> tag contains data in the * Base64 encoding and is typically used for <code>BLOB</code> and <code>CLOB</code> type data. * <PRE> * <<font color=red>data</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * firstrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 1 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * secondrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 2 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * thirdrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 3 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * fourthrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 4 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>/data</font>> * </PRE> * <h4>2.2 State 2 - Deleting a Row</h4> * Deleting a row in a <code>WebRowSet</code> object involves simply moving to the row * to be deleted and then calling the method <code>deleteRow</code>, as in any other * <code>RowSet</code> object. The following * two lines of code, in which <i>wrs</i> is a <code>WebRowSet</code> object, delete * the third row. * <PRE> * wrs.absolute(3); * wrs.deleteRow(); * </PRE> * The XML description shows the third row is marked as a <code>deleteRow</code>, * which eliminates the third row in the <code>WebRowSet</code> object. * <PRE> * <<font color=red>data</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * firstrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 1 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * secondrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 2 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>deleteRow</font>> * <<font color=red>columnValue</font>> * thirdrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 3 * <<font color=red>/columnValue</font>> * <<font color=red>/deleteRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * fourthrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 4 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>/data</font>> * </PRE> * <h4>2.3 State 3 - Inserting a Row</h4> * A <code>WebRowSet</code> object can insert a new row by moving to the insert row, * calling the appropriate updater methods for each column in the row, and then * calling the method <code>insertRow</code>. * <PRE> * wrs.moveToInsertRow(); * wrs.updateString(1, "fifththrow"); * wrs.updateString(2, "5"); * wrs.insertRow(); * </PRE> * The following code fragment changes the second column value in the row just inserted. * Note that this code applies when new rows are inserted right after the current row, * which is why the method <code>next</code> moves the cursor to the correct row. * Calling the method <code>acceptChanges</code> writes the change to the data source. * * <PRE> * wrs.moveToCurrentRow(); * wrs.next(); * wrs.updateString(2, "V"); * wrs.acceptChanges(); * : * </PRE> * Describing this in XML demonstrates where the Java code inserts a new row and then * performs an update on the newly inserted row on an individual field. * <PRE> * <<font color=red>data</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * firstrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 1 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * secondrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 2 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * newthirdrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * III * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>insertRow</font>> * <<font color=red>columnValue</font>> * fifthrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 5 * <<font color=red>/columnValue</font>> * <<font color=red>updateValue</font>> * V * <<font color=red>/updateValue</font>> * <<font color=red>/insertRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * fourthrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 4 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>/date</font>> * </PRE> * <h4>2.4 State 4 - Modifying a Row</h4> * Modifying a row produces specific XML that records both the new value and the * value that was replaced. The value that was replaced becomes the original value, * and the new value becomes the current value. The following * code moves the cursor to a specific row, performs some modifications, and updates * the row when complete. * <PRE> * wrs.absolute(5); * wrs.updateString(1, "new4thRow"); * wrs.updateString(2, "IV"); * wrs.updateRow(); * </PRE> * In XML, this is described by the <code>modifyRow</code> tag. Both the original and new * values are contained within the tag for original row tracking purposes. * <PRE> * <<font color=red>data</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * firstrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 1 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * secondrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 2 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * newthirdrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * III * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>currentRow</font>> * <<font color=red>columnValue</font>> * fifthrow * <<font color=red>/columnValue</font>> * <<font color=red>columnValue</font>> * 5 * <<font color=red>/columnValue</font>> * <<font color=red>/currentRow</font>> * <<font color=red>modifyRow</font>> * <<font color=red>columnValue</font>> * fourthrow * <<font color=red>/columnValue</font>> * <<font color=red>updateValue</font>> * new4thRow * <<font color=red>/updateValue</font>> * <<font color=red>columnValue</font>> * 4 * <<font color=red>/columnValue</font>> * <<font color=red>updateValue</font>> * IV * <<font color=red>/updateValue</font>> * <<font color=red>/modifyRow</font>> * <<font color=red>/data</font>> * </PRE> * * @see javax.sql.rowset.JdbcRowSet * @see javax.sql.rowset.CachedRowSet * @see javax.sql.rowset.FilteredRowSet * @see javax.sql.rowset.JoinRowSet */ public interface WebRowSet extends CachedRowSet { /** * Reads a <code>WebRowSet</code> object in its XML format from the given * <code>Reader</code> object. * * @param reader the <code>java.io.Reader</code> stream from which this * <code>WebRowSet</code> object will be populated * @throws SQLException if a database access error occurs */ public void readXml(java.io.Reader reader) throws SQLException; /** * Reads a stream based XML input to populate this <code>WebRowSet</code> * object. * * @param iStream the <code>java.io.InputStream</code> from which this * <code>WebRowSet</code> object will be populated * @throws SQLException if a data source access error occurs * @throws IOException if an IO exception occurs */ public void readXml(java.io.InputStream iStream) throws SQLException, IOException; /** * Populates this <code>WebRowSet</code> object with * the contents of the given <code>ResultSet</code> object and writes its * data, properties, and metadata * to the given <code>Writer</code> object in XML format. * <p> * NOTE: The <code>WebRowSet</code> cursor may be moved to write out the * contents to the XML data source. If implemented in this way, the cursor <b>must</b> * be returned to its position just prior to the <code>writeXml()</code> call. * * @param rs the <code>ResultSet</code> object with which to populate this * <code>WebRowSet</code> object * @param writer the <code>java.io.Writer</code> object to write to. * @throws SQLException if an error occurs writing out the rowset * contents in XML format */ public void writeXml(ResultSet rs, java.io.Writer writer) throws SQLException; /** * Populates this <code>WebRowSet</code> object with * the contents of the given <code>ResultSet</code> object and writes its * data, properties, and metadata * to the given <code>OutputStream</code> object in XML format. * <p> * NOTE: The <code>WebRowSet</code> cursor may be moved to write out the * contents to the XML data source. If implemented in this way, the cursor <b>must</b> * be returned to its position just prior to the <code>writeXml()</code> call. * * @param rs the <code>ResultSet</code> object with which to populate this * <code>WebRowSet</code> object * @param oStream the <code>java.io.OutputStream</code> to write to * @throws SQLException if a data source access error occurs * @throws IOException if a IO exception occurs */ public void writeXml(ResultSet rs, java.io.OutputStream oStream) throws SQLException, IOException; /** * Writes the data, properties, and metadata for this <code>WebRowSet</code> object * to the given <code>Writer</code> object in XML format. * * @param writer the <code>java.io.Writer</code> stream to write to * @throws SQLException if an error occurs writing out the rowset * contents to XML */ public void writeXml(java.io.Writer writer) throws SQLException; /** * Writes the data, properties, and metadata for this <code>WebRowSet</code> object * to the given <code>OutputStream</code> object in XML format. * * @param oStream the <code>java.io.OutputStream</code> stream to write to * @throws SQLException if a data source access error occurs * @throws IOException if a IO exception occurs */ public void writeXml(java.io.OutputStream oStream) throws SQLException, IOException; /** * The public identifier for the XML Schema definition that defines the XML * tags and their valid values for a <code>WebRowSet</code> implementation. */ public static String PUBLIC_XML_SCHEMA = "--//Sun Microsystems, Inc.//XSD Schema//EN"; /** * The URL for the XML Schema definition file that defines the XML tags and * their valid values for a <code>WebRowSet</code> implementation. */ public static String SCHEMA_SYSTEM_ID = "http://java.sun.com/xml/ns/jdbc/webrowset.xsd"; }
