Package Summary  Overview Summary

class:SQLInputImpl [CHANGED]

  • All Implemented Interfaces:
    java.sql.SQLInput


    public class SQLInputImpl
    extends java.lang.Object
    implements java.sql.SQLInput
    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.

    Since:
    1.5
    See Also:
    <code>SQLData</code>
  • All Implemented Interfaces:
    java.sql.SQLInput


    public class SQLInputImpl
    extends java.lang.Object
    implements java.sql.SQLInput
    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.

    See Also:
    <code>SQLData</code>
  • All Implemented Interfaces:
    java.sql.SQLInput


    public class SQLInputImpl
    extends java.lang.Object
    implements java.sql.SQLInput
    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.

    Since:
    1.5
    See Also:
    <code>SQLData</code>

constructor:SQLInputImpl(java.lang.Object[], java.util.Map) [NONE]

  • SQLInputImpl

    public SQLInputImpl(java.lang.Object[] attributes,
                        java.util.Map<java.lang.String,java.lang.Class<?>> map)
                 throws java.sql.SQLException
    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.
    Parameters:
    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.
    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
    Throws:
    java.sql.SQLException - if the attributes or the map is a null value

method:readString() [NONE]

  • readString

    public java.lang.String readString()
                                throws java.sql.SQLException
    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.

    Specified by:
    readString in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no further values in the stream.

method:readBoolean() [NONE]

  • readBoolean

    public boolean readBoolean()
                        throws java.sql.SQLException
    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.

    Specified by:
    readBoolean in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no further values in the stream.

method:readByte() [NONE]

  • readByte

    public byte readByte()
                  throws java.sql.SQLException
    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.

    Specified by:
    readByte in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no further values in the stream

method:readShort() [NONE]

  • readShort

    public short readShort()
                    throws java.sql.SQLException
    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.

    Specified by:
    readShort in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readInt() [NONE]

  • readInt

    public int readInt()
                throws java.sql.SQLException
    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.

    Specified by:
    readInt in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readLong() [NONE]

  • readLong

    public long readLong()
                  throws java.sql.SQLException
    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.

    Specified by:
    readLong in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readFloat() [NONE]

  • readFloat

    public float readFloat()
                    throws java.sql.SQLException
    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.

    Specified by:
    readFloat in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readDouble() [NONE]

  • readDouble

    public double readDouble()
                      throws java.sql.SQLException
    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.

    Specified by:
    readDouble in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readBigDecimal() [NONE]

  • readBigDecimal

    public java.math.BigDecimal readBigDecimal()
                                        throws java.sql.SQLException
    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.

    Specified by:
    readBigDecimal in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readBytes() [NONE]

  • readBytes

    public byte[] readBytes()
                     throws java.sql.SQLException
    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.

    Specified by:
    readBytes in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readDate() [NONE]

  • readDate

    public java.sql.Date readDate()
                           throws java.sql.SQLException
    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.

    Specified by:
    readDate in interface java.sql.SQLInput
    Returns:
    the next attribute in this SQLInputImpl object; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position or if there are no more values in the stream

method:readTime() [NONE]

  • readTime

    public java.sql.Time readTime()
                           throws java.sql.SQLException
    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.

    Specified by:
    readTime in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readTimestamp() [NONE]

  • readTimestamp

    public java.sql.Timestamp readTimestamp()
                                     throws java.sql.SQLException
    Retrieves the next attribute in this SQLInputImpl object as a java.sql.Timestamp object.
    Specified by:
    readTimestamp in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readCharacterStream() [NONE]

  • readCharacterStream

    public java.io.Reader readCharacterStream()
                                       throws java.sql.SQLException
    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.

    Specified by:
    readCharacterStream in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readAsciiStream() [NONE]

  • readAsciiStream

    public java.io.InputStream readAsciiStream()
                                        throws java.sql.SQLException
    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.

    Specified by:
    readAsciiStream in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readBinaryStream() [NONE]

  • readBinaryStream

    public java.io.InputStream readBinaryStream()
                                         throws java.sql.SQLException
    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.

    Specified by:
    readBinaryStream in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readObject() [NONE]

  • readObject

    public java.lang.Object readObject()
                                throws java.sql.SQLException
    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.

    Specified by:
    readObject in interface java.sql.SQLInput
    Returns:
    the value at the head of the stream as an Object in the Java programming language; null if the value is SQL NULL
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readRef() [NONE]

  • readRef

    public java.sql.Ref readRef()
                         throws java.sql.SQLException
    Retrieves the value at the head of this SQLInputImpl object as a Ref object in the Java programming language.
    Specified by:
    readRef in interface java.sql.SQLInput
    Returns:
    a Ref object representing the SQL REF value at the head of the stream; if the value is SQL NULL return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readBlob() [NONE]

  • readBlob

    public java.sql.Blob readBlob()
                           throws java.sql.SQLException
    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.

    Specified by:
    readBlob in interface java.sql.SQLInput
    Returns:
    a Blob object representing the SQL BLOB value at the head of this stream; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readClob() [NONE]

  • readClob

    public java.sql.Clob readClob()
                           throws java.sql.SQLException
    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.

    Specified by:
    readClob in interface java.sql.SQLInput
    Returns:
    a Clob object representing the SQL CLOB value at the head of the stream; if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readArray() [NONE]

  • readArray

    public java.sql.Array readArray()
                             throws java.sql.SQLException
    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.

    Specified by:
    readArray in interface java.sql.SQLInput
    Returns:
    an Array object representing the SQL ARRAY value at the head of the stream; * if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:wasNull() [NONE]

  • wasNull

    public boolean wasNull()
                    throws java.sql.SQLException
    Ascertains whether the last value read from this SQLInputImpl object was null.
    Specified by:
    wasNull in interface java.sql.SQLInput
    Returns:
    true if the SQL value read most recently was null; otherwise, false; by default it will return false
    Throws:
    java.sql.SQLException - if an error occurs determining the last value read was a null value or not;

method:readURL() [NONE]

  • readURL

    public java.net.URL readURL()
                         throws java.sql.SQLException
    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.

    Specified by:
    readURL in interface java.sql.SQLInput
    Returns:
    an URL object representing the SQL DATALINK value at the head of the stream; * if the value is SQL NULL , return null
    Throws:
    java.sql.SQLException - if the read position is located at an invalid position; or if there are no further values in the stream.

method:readNClob() [CHANGED]

  • readNClob

    public java.sql.NClob readNClob()
                             throws java.sql.SQLException
    Reads an SQL NCLOB value from the stream and returns it as a Clob object in the Java programming language.
    Specified by:
    readNClob in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6
  • readNClob

    public java.sql.NClob readNClob()
                             throws java.sql.SQLException
    Reads an SQL NCLOB value from the stream and returns it as a Clob object in the Java programming language.
    Specified by:
    readNClob in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
  • readNClob

    public java.sql.NClob readNClob()
                             throws java.sql.SQLException
    Reads an SQL NCLOB value from the stream and returns it as a Clob object in the Java programming language.
    Specified by:
    readNClob in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6

method:readNString() [CHANGED]

  • readNString

    public java.lang.String readNString()
                                 throws java.sql.SQLException
    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.
    Specified by:
    readNString in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL, returns null
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6
  • readNString

    public java.lang.String readNString()
                                 throws java.sql.SQLException
    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.
    Specified by:
    readNString in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL, returns null
    Throws:
    java.sql.SQLException - if a database access error occurs
  • readNString

    public java.lang.String readNString()
                                 throws java.sql.SQLException
    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.
    Specified by:
    readNString in interface java.sql.SQLInput
    Returns:
    the attribute; if the value is SQL NULL, returns null
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6

method:readSQLXML() [CHANGED]

  • readSQLXML

    public java.sql.SQLXML readSQLXML()
                               throws java.sql.SQLException
    Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.
    Specified by:
    readSQLXML in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6
  • readSQLXML

    public java.sql.SQLXML readSQLXML()
                               throws java.sql.SQLException
    Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.
    Specified by:
    readSQLXML in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
  • readSQLXML

    public java.sql.SQLXML readSQLXML()
                               throws java.sql.SQLException
    Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.
    Specified by:
    readSQLXML in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6

method:readRowId() [CHANGED]

  • readRowId

    public java.sql.RowId readRowId()
                             throws java.sql.SQLException
    Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.
    Specified by:
    readRowId in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6
  • readRowId

    public java.sql.RowId readRowId()
                             throws java.sql.SQLException
    Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.
    Specified by:
    readRowId in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
  • readRowId

    public java.sql.RowId readRowId()
                             throws java.sql.SQLException
    Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.
    Specified by:
    readRowId in interface java.sql.SQLInput
    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
    Throws:
    java.sql.SQLException - if a database access error occurs
    Since:
    1.6