javax.sql.rowset.serial.SQLInputImpl — clojure-interop/javax.sql 1.0.0

An input stream used for custom mapping user-defined types (UDTs). An SQLInputImpl object is an input stream that contains a stream of values that are the attributes of a UDT.

This class is used by the driver behind the scenes when the method getObject is called on an SQL structured or distinct type that has a custom mapping; a programmer never invokes SQLInputImpl methods directly. They are provided here as a convenience for those who write RowSet implementations.

The SQLInputImpl class provides a set of reader methods analogous to the ResultSet getter methods. These methods make it possible to read the values in an SQLInputImpl object.

The method wasNull is used to determine whether the the last value read was SQL NULL. When the method getObject is called with an object of a class implementing the interface SQLData, the JDBC driver calls the method SQLData.getSQLType to determine the SQL type of the UDT being custom mapped. The driver creates an instance of SQLInputImpl, populating it with the attributes of the UDT. The driver then passes the input stream to the method SQLData.readSQL, which in turn calls the SQLInputImpl reader methods to read the attributes from the input stream.

->sql-input-impl clj

(->sql-input-impl attributes map)

Constructor.

Creates an SQLInputImpl object initialized with the given array of attributes and the given type map. If any of the attributes is a UDT whose name is in an entry in the type map, the attribute will be mapped according to the corresponding SQLData implementation.

attributes - an array of Object instances in which each element is an attribute of a UDT. The order of the attributes in the array is the same order in which the attributes were defined in the UDT definition. - java.lang.Object[] map - a java.util.Map object containing zero or more entries, with each entry consisting of 1) a String giving the fully qualified name of the UDT and 2) the Class object for the SQLData implementation that defines how the UDT is to be mapped - java.util.Map<java.lang.String,java.lang.Class<?>>

throws: java.sql.SQLException - if the attributes or the map is a null value

read-array clj

(read-array this)

Reads an SQL ARRAY value from the stream and returns it as an Array object in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: an Array object representing the SQL ARRAY value at the head of the stream; * if the value is SQL NULL, return null - java.sql.Array

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-ascii-stream clj

(read-ascii-stream this)

Returns the next attribute in this SQLInputImpl object as a stream of ASCII characters.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: the attribute; if the value is SQL NULL, return null - java.io.InputStream

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-big-decimal clj

(read-big-decimal this)

Retrieves the next attribute in this SQLInputImpl object as a java.math.BigDecimal.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - java.math.BigDecimal

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-binary-stream clj

(read-binary-stream this)

Returns the next attribute in this SQLInputImpl object as a stream of uninterpreted bytes.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: the attribute; if the value is SQL NULL, return null - java.io.InputStream

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-blob clj

(read-blob this)

Retrieves the BLOB value at the head of this SQLInputImpl object as a Blob object in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: a Blob object representing the SQL BLOB value at the head of this stream; if the value is SQL NULL, return null - java.sql.Blob

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-boolean clj

(read-boolean this)

Retrieves the next attribute in this SQLInputImpl object as a boolean in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - boolean

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no further values in the stream.

read-byte clj

(read-byte this)

Retrieves the next attribute in this SQLInputImpl object as a byte in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - byte

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no further values in the stream

read-bytes clj

(read-bytes this)

Retrieves the next attribute in this SQLInputImpl object as an array of bytes.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - byte[]

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-character-stream clj

(read-character-stream this)

Retrieves the next attribute in this SQLInputImpl object as a stream of Unicode characters.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: the attribute; if the value is SQL NULL, return null - java.io.Reader

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-clob clj

(read-clob this)

Retrieves the CLOB value at the head of this SQLInputImpl object as a Clob object in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: a Clob object representing the SQL CLOB value at the head of the stream; if the value is SQL NULL, return null - java.sql.Clob

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-date clj

(read-date this)

Retrieves the next attribute in this SQLInputImpl as a java.sql.Date object.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - java.sql.Date

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-double clj

(read-double this)

Retrieves the next attribute in this SQLInputImpl object as a double in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - double

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-float clj

(read-float this)

Retrieves the next attribute in this SQLInputImpl object as a float in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - float

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-int clj

(read-int this)

Retrieves the next attribute in this SQLInputImpl object as an int in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - int

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-long clj

(read-long this)

Retrieves the next attribute in this SQLInputImpl object as a long in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - long

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-n-clob clj

(read-n-clob this)

Reads an SQL NCLOB value from the stream and returns it as a Clob object in the Java programming language.

returns: a NClob object representing data of the SQL NCLOB value at the head of the stream; null if the value read is SQL NULL - java.sql.NClob

throws: java.sql.SQLException - if a database access error occurs

read-n-string clj

(read-n-string this)

Reads the next attribute in the stream and returns it as a String in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR columns.

returns: the attribute; if the value is SQL NULL, returns null - java.lang.String

throws: java.sql.SQLException - if a database access error occurs

read-object clj

(read-object this)

Retrieves the value at the head of this SQLInputImpl object as an Object in the Java programming language. The actual type of the object returned is determined by the default mapping of SQL types to types in the Java programming language unless there is a custom mapping, in which case the type of the object returned is determined by this stream's type map.

The JDBC technology-enabled driver registers a type map with the stream before passing the stream to the application.

When the datum at the head of the stream is an SQL NULL, this method returns null. If the datum is an SQL structured or distinct type with a custom mapping, this method determines the SQL type of the datum at the head of the stream, constructs an object of the appropriate class, and calls the method SQLData.readSQL on that object. The readSQL method then calls the appropriate SQLInputImpl.readXXX methods to retrieve the attribute values from the stream.

returns: the value at the head of the stream as an Object in the Java programming language; null if the value is SQL NULL - java.lang.Object

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-ref clj

(read-ref this)

Retrieves the value at the head of this SQLInputImpl object as a Ref object in the Java programming language.

returns: a Ref object representing the SQL REF value at the head of the stream; if the value is SQL NULL return null - java.sql.Ref

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-row-id clj

(read-row-id this)

Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.

returns: a RowId object representing data of the SQL ROWID value at the head of the stream; null if the value read is SQL NULL - java.sql.RowId

throws: java.sql.SQLException - if a database access error occurs

read-short clj

(read-short this)

Retrieves the next attribute in this SQLInputImpl object as a short in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - short

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

read-sqlxml clj

(read-sqlxml this)

Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.

returns: a SQLXML object representing data of the SQL XML value at the head of the stream; null if the value read is SQL NULL - java.sql.SQLXML

throws: java.sql.SQLException - if a database access error occurs

read-string clj

(read-string this)

Retrieves the next attribute in this SQLInputImpl object as a String in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type; this responsibility is delegated to the UDT mapping as defined by a SQLData implementation.

returns: the next attribute in this SQLInputImpl object; if the value is SQL NULL, return null - java.lang.String

throws: java.sql.SQLException - if the read position is located at an invalid position or if there are no further values in the stream.

read-time clj

(read-time this)

Retrieves the next attribute in this SQLInputImpl object as a java.sql.Time object.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: the attribute; if the value is SQL NULL, return null - java.sql.Time

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-timestamp clj

(read-timestamp this)

Retrieves the next attribute in this SQLInputImpl object as a java.sql.Timestamp object.

returns: the attribute; if the value is SQL NULL, return null - java.sql.Timestamp

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

read-url clj

(read-url this)

Reads an SQL DATALINK value from the stream and returns it as an URL object in the Java programming language.

This method does not perform type-safe checking to determine if the returned type is the expected type as this responsibility is delegated to the UDT mapping as implemented by a SQLData implementation.

returns: an URL object representing the SQL DATALINK value at the head of the stream; * if the value is SQL NULL, return null - java.net.URL

throws: java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

was-null clj

(was-null this)

Ascertains whether the last value read from this SQLInputImpl object was null.

returns: true if the SQL value read most recently was null; otherwise, false; by default it will return false - boolean

throws: java.sql.SQLException - if an error occurs determining the last value read was a null value or not;