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
/* * @(#)SQLOutput.java 1.24 06/04/16 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.sql; /** * The output stream for writing the attributes of a user-defined * type back to the database. This interface, used * only for custom mapping, is used by the driver, and its * methods are never directly invoked by a programmer. * <p>When an object of a class implementing the interface * <code>SQLData</code> is passed as an argument to an SQL statement, the * JDBC driver calls the method <code>SQLData.getSQLType</code> to * determine the kind of SQL * datum being passed to the database. * The driver then creates an instance of <code>SQLOutput</code> and * passes it to the method <code>SQLData.writeSQL</code>. * The method <code>writeSQL</code> in turn calls the * appropriate <code>SQLOutput</code> <i>writer</i> methods * <code>writeBoolean</code>, <code>writeCharacterStream</code>, and so on) * to write data from the <code>SQLData</code> object to * the <code>SQLOutput</code> output stream as the * representation of an SQL user-defined type. * @since 1.2 */ public interface SQLOutput { //================================================================ // Methods for writing attributes to the stream of SQL data. // These methods correspond to the column-accessor methods of // java.sql.ResultSet. //================================================================ /** * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeString(String x) throws SQLException; /** * Writes the next attribute to the stream as a Java boolean. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeBoolean(boolean x) throws SQLException; /** * Writes the next attribute to the stream as a Java byte. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeByte(byte x) throws SQLException; /** * Writes the next attribute to the stream as a Java short. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeShort(short x) throws SQLException; /** * Writes the next attribute to the stream as a Java int. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeInt(int x) throws SQLException; /** * Writes the next attribute to the stream as a Java long. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeLong(long x) throws SQLException; /** * Writes the next attribute to the stream as a Java float. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeFloat(float x) throws SQLException; /** * Writes the next attribute to the stream as a Java double. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeDouble(double x) throws SQLException; /** * Writes the next attribute to the stream as a java.math.BigDecimal object. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeBigDecimal(java.math.BigDecimal x) throws SQLException; /** * Writes the next attribute to the stream as an array of bytes. * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeBytes(byte[] x) throws SQLException; /** * Writes the next attribute to the stream as a java.sql.Date object. * Writes the next attribute to the stream as a <code>java.sql.Date</code> object * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeDate(java.sql.Date x) throws SQLException; /** * Writes the next attribute to the stream as a java.sql.Time object. * Writes the next attribute to the stream as a <code>java.sql.Date</code> object * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeTime(java.sql.Time x) throws SQLException; /** * Writes the next attribute to the stream as a java.sql.Timestamp object. * Writes the next attribute to the stream as a <code>java.sql.Date</code> object * in the Java programming language. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeTimestamp(java.sql.Timestamp x) throws SQLException; /** * Writes the next attribute to the stream as a stream of Unicode characters. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeCharacterStream(java.io.Reader x) throws SQLException; /** * Writes the next attribute to the stream as a stream of ASCII characters. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeAsciiStream(java.io.InputStream x) throws SQLException; /** * Writes the next attribute to the stream as a stream of uninterpreted * bytes. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeBinaryStream(java.io.InputStream x) throws SQLException; //================================================================ // Methods for writing items of SQL user-defined types to the stream. // These methods pass objects to the database as values of SQL // Structured Types, Distinct Types, Constructed Types, and Locator // Types. They decompose the Java object(s) and write leaf data // items using the methods above. //================================================================ /** * Writes to the stream the data contained in the given * <code>SQLData</code> object. * When the <code>SQLData</code> object is <code>null</code>, this * method writes an SQL <code>NULL</code> to the stream. * Otherwise, it calls the <code>SQLData.writeSQL</code> * method of the given object, which * writes the object's attributes to the stream. * The implementation of the method <code>SQLData.writeSQ</code> * calls the appropriate <code>SQLOutput</code> writer method(s) * for writing each of the object's attributes in order. * The attributes must be read from an <code>SQLInput</code> * input stream and written to an <code>SQLOutput</code> * output stream in the same order in which they were * listed in the SQL definition of the user-defined type. * * @param x the object representing data of an SQL structured or * distinct type * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeObject(SQLData x) throws SQLException; /** * Writes an SQL <code>REF</code> value to the stream. * * @param x a <code>Ref</code> object representing data of an SQL * <code>REF</code> value * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeRef(Ref x) throws SQLException; /** * Writes an SQL <code>BLOB</code> value to the stream. * * @param x a <code>Blob</code> object representing data of an SQL * <code>BLOB</code> value * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeBlob(Blob x) throws SQLException; /** * Writes an SQL <code>CLOB</code> value to the stream. * * @param x a <code>Clob</code> object representing data of an SQL * <code>CLOB</code> value * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeClob(Clob x) throws SQLException; /** * Writes an SQL structured type value to the stream. * * @param x a <code>Struct</code> object representing data of an SQL * structured type * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeStruct(Struct x) throws SQLException; /** * Writes an SQL <code>ARRAY</code> value to the stream. * * @param x an <code>Array</code> object representing data of an SQL * <code>ARRAY</code> type * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ void writeArray(Array x) throws SQLException; //--------------------------- JDBC 3.0 ------------------------ /** * Writes a SQL <code>DATALINK</code> value to the stream. * * @param x a <code>java.net.URL</code> object representing the data * of SQL DATALINK type * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.4 */ void writeURL(java.net.URL x) throws SQLException; //--------------------------- JDBC 4.0 ------------------------ /** * Writes the next attribute to the stream as a <code>String</code> * in the Java programming language. The driver converts this to a * SQL <code>NCHAR</code> or * <code>NVARCHAR</code> or <code>LONGNVARCHAR</code> value * (depending on the argument's * size relative to the driver's limits on <code>NVARCHAR</code> values) * when it sends it to the stream. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ void writeNString(String x) throws SQLException; /** * Writes an SQL <code>NCLOB</code> value to the stream. * * @param x a <code>NClob</code> object representing data of an SQL * <code>NCLOB</code> value * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ void writeNClob(NClob x) throws SQLException; /** * Writes an SQL <code>ROWID</code> value to the stream. * * @param x a <code>RowId</code> object representing data of an SQL * <code>ROWID</code> value * * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ void writeRowId(RowId x) throws SQLException; /** * Writes an SQL <code>XML</code> value to the stream. * * @param x a <code>SQLXML</code> object representing data of an SQL * <code>XML</code> value * * @throws SQLException if a database access error occurs, * the <code>java.xml.transform.Result</code>, * <code>Writer</code> or <code>OutputStream</code> has not been closed for the <code>SQLXML</code> object or * if there is an error processing the XML value. The <code>getCause</code> method * of the exception may provide a more detailed exception, for example, if the * stream does not contain valid XML. * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ void writeSQLXML(SQLXML x) throws SQLException; }