Save This Page
Home » openjdk-7 » javax » sql » rowset » serial » [javadoc | source]
javax.sql.rowset.serial
public class: SQLInputImpl [javadoc | source]
java.lang.Object
   javax.sql.rowset.serial.SQLInputImpl

All Implemented Interfaces:
    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.

Constructor:
 public SQLInputImpl(Object[] attributes,
    Map map) throws 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:
    SQLException - if the attributes or the map is a null value
Method from javax.sql.rowset.serial.SQLInputImpl Summary:
readArray,   readAsciiStream,   readBigDecimal,   readBinaryStream,   readBlob,   readBoolean,   readByte,   readBytes,   readCharacterStream,   readClob,   readDate,   readDouble,   readFloat,   readInt,   readLong,   readNClob,   readNString,   readObject,   readRef,   readRowId,   readSQLXML,   readShort,   readString,   readTime,   readTimestamp,   readURL,   wasNull
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.sql.rowset.serial.SQLInputImpl Detail:
 public Array readArray() throws 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.

 public InputStream readAsciiStream() throws 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.

 public BigDecimal readBigDecimal() throws 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.

 public InputStream readBinaryStream() throws 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.

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

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

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

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

 public Reader readCharacterStream() throws 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.

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

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

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

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

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

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

 public NClob readNClob() throws SQLException 
    Reads an SQL NCLOB value from the stream and returns it as a Clob object in the Java programming language.
 public String readNString() throws 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.
 public Object readObject() throws 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.

 public Ref readRef() throws SQLException 
    Retrieves the value at the head of this SQLInputImpl object as a Ref object in the Java programming language.
 public RowId readRowId() throws SQLException 
    Reads an SQL ROWID value from the stream and returns it as a RowId object in the Java programming language.
 public SQLXML readSQLXML() throws SQLException 
    Reads an SQL XML value from the stream and returns it as a SQLXML object in the Java programming language.
 public short readShort() throws 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.

 public String readString() throws 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.

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

 public Timestamp readTimestamp() throws SQLException 
    Retrieves the next attribute in this SQLInputImpl object as a java.sql.Timestamp object.
 public URL readURL() throws 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.

 public boolean wasNull() throws SQLException 
    Ascertains whether the last value read from this SQLInputImpl object was null.