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
/* * @(#)SQLInput.java 1.28 06/04/16 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.sql; /** * An input stream that contains a stream of values representing an * instance of an SQL structured type or an SQL distinct type. * This interface, used only for custom mapping, is used by the driver * behind the scenes, and a programmer never directly invokes * <code>SQLInput</code> methods. The <i>reader</i> methods * (<code>readLong</code>, <code>readBytes</code>, and so on) * provide a way for an implementation of the <code>SQLData</code> * interface to read the values in an <code>SQLInput</code> object. * And as described in <code>SQLData</code>, calls to reader methods must * be made in the order that their corresponding attributes appear in the * SQL definition of the type. * The method <code>wasNull</code> is used to determine whether * the last value read was SQL <code>NULL</code>. * <P>When the method <code>getObject</code> is called with an * object of a class implementing the interface <code>SQLData</code>, * the JDBC driver calls the method <code>SQLData.getSQLType</code> * to determine the SQL type of the user-defined type (UDT) * being custom mapped. The driver * creates an instance of <code>SQLInput</code>, populating it with the * attributes of the UDT. The driver then passes the input * stream to the method <code>SQLData.readSQL</code>, which in turn * calls the <code>SQLInput</code> reader methods * in its implementation for reading the * attributes from the input stream. * @since 1.2 */ public interface SQLInput { //================================================================ // Methods for reading attributes from the stream of SQL data. // These methods correspond to the column-accessor methods of // java.sql.ResultSet. //================================================================ /** * Reads the next attribute in the stream and returns it as a <code>String</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ String readString() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>boolean</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>false</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ boolean readBoolean() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>byte</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>0</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ byte readByte() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>short</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>0</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ short readShort() throws SQLException; /** * Reads the next attribute in the stream and returns it as an <code>int</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>0</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ int readInt() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>long</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>0</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ long readLong() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>float</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>0</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ float readFloat() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>double</code> * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>0</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ double readDouble() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>java.math.BigDecimal</code> * object in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.math.BigDecimal readBigDecimal() throws SQLException; /** * Reads the next attribute in the stream and returns it as an array of bytes * in the Java programming language. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ byte[] readBytes() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>java.sql.Date</code> object. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.sql.Date readDate() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>java.sql.Time</code> object. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.sql.Time readTime() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>java.sql.Timestamp</code> object. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.sql.Timestamp readTimestamp() throws SQLException; /** * Reads the next attribute in the stream and returns it as a stream of Unicode characters. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.io.Reader readCharacterStream() throws SQLException; /** * Reads the next attribute in the stream and returns it as a stream of ASCII characters. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.io.InputStream readAsciiStream() throws SQLException; /** * Reads the next attribute in the stream and returns it as a stream of uninterpreted * bytes. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ java.io.InputStream readBinaryStream() throws SQLException; //================================================================ // Methods for reading items of SQL user-defined types from the stream. //================================================================ /** * Reads the datum at the head of the stream and returns it as an * <code>Object</code> in the Java programming language. The * actual type of the object returned is determined by the default type * mapping, and any customizations present in this stream's type map. * * <P>A type map is registered with the stream by the JDBC driver before the * stream is passed to the application. * * <P>When the datum at the head of the stream is an SQL <code>NULL</code>, * the method returns <code>null</code>. If the datum is an SQL structured or distinct * type, it determines the SQL type of the datum at the head of the stream. * If the stream's type map has an entry for that SQL type, the driver * constructs an object of the appropriate class and calls the method * <code>SQLData.readSQL</code> on that object, which reads additional data from the * stream, using the protocol described for that method. * * @return the datum at the head of the stream as an <code>Object</code> in the * Java programming language;<code>null</code> if the datum is SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ Object readObject() throws SQLException; /** * Reads an SQL <code>REF</code> value from the stream and returns it as a * <code>Ref</code> object in the Java programming language. * * @return a <code>Ref</code> object representing the SQL <code>REF</code> value * at the head of the stream; <code>null</code> if the value read is * SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ Ref readRef() throws SQLException; /** * Reads an SQL <code>BLOB</code> value from the stream and returns it as a * <code>Blob</code> object in the Java programming language. * * @return a <code>Blob</code> object representing data of the SQL <code>BLOB</code> value * at the head of the stream; <code>null</code> if the value read is * SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ Blob readBlob() throws SQLException; /** * Reads an SQL <code>CLOB</code> value from the stream and returns it as a * <code>Clob</code> object in the Java programming language. * * @return a <code>Clob</code> object representing data of the SQL <code>CLOB</code> value * at the head of the stream; <code>null</code> if the value read is * SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ Clob readClob() throws SQLException; /** * Reads an SQL <code>ARRAY</code> value from the stream and returns it as an * <code>Array</code> object in the Java programming language. * * @return an <code>Array</code> object representing data of the SQL * <code>ARRAY</code> value at the head of the stream; <code>null</code> * if the value read is SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ Array readArray() throws SQLException; /** * Retrieves whether the last value read was SQL <code>NULL</code>. * * @return <code>true</code> if the most recently read SQL value was SQL * <code>NULL</code>; <code>false</code> otherwise * @exception SQLException if a database access error occurs * * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.2 */ boolean wasNull() throws SQLException; //---------------------------- JDBC 3.0 ------------------------- /** * Reads an SQL <code>DATALINK</code> value from the stream and returns it as a * <code>java.net.URL</code> object in the Java programming language. * * @return a <code>java.net.URL</code> object. * @exception SQLException if a database access error occurs, * or if a URL is malformed * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.4 */ java.net.URL readURL() throws SQLException; //---------------------------- JDBC 4.0 ------------------------- /** * Reads an SQL <code>NCLOB</code> value from the stream and returns it as a * <code>NClob</code> object in the Java programming language. * * @return a <code>NClob</code> object representing data of the SQL <code>NCLOB</code> value * at the head of the stream; <code>null</code> if the value read is * SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ NClob readNClob() throws SQLException; /** * Reads the next attribute in the stream and returns it as a <code>String</code> * in the Java programming language. It is intended for use when * accessing <code>NCHAR</code>,<code>NVARCHAR</code> * and <code>LONGNVARCHAR</code> columns. * * @return the attribute; if the value is SQL <code>NULL</code>, returns <code>null</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ String readNString() throws SQLException; /** * Reads an SQL <code>XML</code> value from the stream and returns it as a * <code>SQLXML</code> object in the Java programming language. * * @return a <code>SQLXML</code> object representing data of the SQL <code>XML</code> value * at the head of the stream; <code>null</code> if the value read is * SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ SQLXML readSQLXML() throws SQLException; /** * Reads an SQL <code>ROWID</code> value from the stream and returns it as a * <code>RowId</code> object in the Java programming language. * * @return a <code>RowId</code> object representing data of the SQL <code>ROWID</code> value * at the head of the stream; <code>null</code> if the value read is * SQL <code>NULL</code> * @exception SQLException if a database access error occurs * @exception SQLFeatureNotSupportedException if the JDBC driver does not support * this method * @since 1.6 */ RowId readRowId() throws SQLException; }