Android
java.sql
public interface

java.sql.SQLInput

java.sql.SQLInput

The SQLInput interface defines operations which apply to a type of input stream which carries a series of values which represent an instance of an SQL structured type or SQL distinct type.

SQLInput interface is used for custom mapping of SQL User Defined Types (UDTs)to Java classes. It is used by JDBC drivers below the level of the public interfaces and application programs do not normally use the SQLInput methods directly. Reader methods such as readLong and readBytes provide means to read values from an SQLInput stream.

When the getObject method is called with an object which implements the SQLData interface, the JDBC driver determines the SQL type of the UDT being mapped by calling the SQLData.getSQLType method. The driver creates an instance of an SQLInput stream, filling the stream with the attributes of the UDT. The SQLInput stream is passed to the SQLData.readSQL method which then calls the SQLInput reader methods to read the attributes.

Summary

Public Methods

          Array  readArray()
Returns the next attribute in the stream in the form of a java.sql.Array.
          InputStream  readAsciiStream()
Returns the next attribute in the stream in the form of an ASCII character stream embodied as a java.io.InputStream.
          BigDecimal  readBigDecimal()
Returns the next attribute in the stream in the form of a java.math.BigDecimal.
          InputStream  readBinaryStream()
Returns the next attribute in the stream in the form of a stream of bytes embodied as a java.io.InputStream.
          Blob  readBlob()
Returns the next attribute in the stream in the form of a java.sql.Blob.
          boolean  readBoolean()
Returns the next attribute in the stream in the form of a boolean.
          byte  readByte()
Returns the next attribute in the stream in the form of a byte.
          byte[]  readBytes()
Returns the next attribute in the stream in the form of a byte array.
          Reader  readCharacterStream()
Returns the next attribute in the stream in the form of a Unicode character stream embodied as a java.io.Reader.
          Clob  readClob()
Returns the next attribute in the stream in the form of a java.sql.Clob.
          Date  readDate()
Returns the next attribute in the stream in the form of a java.sql.Date.
          double  readDouble()
Returns the next attribute in the stream in the form of a double.
          float  readFloat()
Returns the next attribute in the stream in the form of a float.
          int  readInt()
Returns the next attribute in the stream in the form of an int.
          long  readLong()
Returns the next attribute in the stream in the form of a long.
          Object  readObject()
Returns the next attribute in the stream in the form of a java.lang.Object.
          Ref  readRef()
Returns the next attribute in the stream in the form of a java.sql.Ref.
          short  readShort()
Returns the next attribute in the stream in the form of a short.
          String  readString()
Returns the next attribute in the stream in the form of a String.
          Time  readTime()
Returns the next attribute in the stream in the form of a java.sql.Time.
          Timestamp  readTimestamp()
Returns the next attribute in the stream in the form of a java.sql.Timestamp.
          URL  readURL()
Reads the next attribute in the stream (SQL DATALINK value) and returns it as a java.net.URL object.
          boolean  wasNull()
Reports whether the last value read was SQL NULL.

Details

Public Methods

public Array readArray()

Returns the next attribute in the stream in the form of a java.sql.Array.

Returns

  • the next attribute as an Array. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public InputStream readAsciiStream()

Returns the next attribute in the stream in the form of an ASCII character stream embodied as a java.io.InputStream.

Returns

  • the next attribute as a java.io.InputStream. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public BigDecimal readBigDecimal()

Returns the next attribute in the stream in the form of a java.math.BigDecimal.

Returns

  • the attribute as a java.math.BigDecimal. null if the read returns SQL NULL.

Throws

SQLException if there is a database error

public InputStream readBinaryStream()

Returns the next attribute in the stream in the form of a stream of bytes embodied as a java.io.InputStream.

Returns

  • the next attribute as a java.io.InputStream. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public Blob readBlob()

Returns the next attribute in the stream in the form of a java.sql.Blob.

Returns

  • the next attribute as a java.sql.Blob. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public boolean readBoolean()

Returns the next attribute in the stream in the form of a boolean.

Returns

  • the next attribute as a boolean. false if the value is SQL NULL.

Throws

SQLException if there is a database error

public byte readByte()

Returns the next attribute in the stream in the form of a byte.

Returns

  • the next attribute as a byte. 0 if the value is SQL NULL.

Throws

SQLException if there is a database error

public byte[] readBytes()

Returns the next attribute in the stream in the form of a byte array.

Returns

  • the attribute as a byte array. null if the read returns SQL NULL.

Throws

SQLException if there is a database error

public Reader readCharacterStream()

Returns the next attribute in the stream in the form of a Unicode character stream embodied as a java.io.Reader.

Returns

  • the next attribute as a java.io.Reader. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public Clob readClob()

Returns the next attribute in the stream in the form of a java.sql.Clob.

Returns

  • the next attribute as a java.sql.Clob. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public Date readDate()

Returns the next attribute in the stream in the form of a java.sql.Date.

Returns

  • the next attribute as a java.sql.Date. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public double readDouble()

Returns the next attribute in the stream in the form of a double.

Returns

  • the next attribute as a double. 0 if the value is SQL NULL.

Throws

SQLException if there is a database error

public float readFloat()

Returns the next attribute in the stream in the form of a float.

Returns

  • the next attribute as a float. 0 if the value is SQL NULL.

Throws

SQLException if there is a database error

public int readInt()

Returns the next attribute in the stream in the form of an int.

Returns

  • the next attribute as an int. 0 if the value is SQL NULL.

Throws

SQLException if there is a database error

public long readLong()

Returns the next attribute in the stream in the form of a long.

Returns

  • the next attribute as a long. 0 if the value is SQL NULL.

Throws

SQLException if there is a database error

public Object readObject()

Returns the next attribute in the stream in the form of a java.lang.Object.

The type of the Object returned is determined by the type mapping for this JDBC driver, including any customized mappings in force. A type map is given to the SQLInput by the JDBC driver before the SQLInput is given to the application.

If the attribute is an SQL structured or distinct type, its SQL type is determined. If the streams type map contains an element for that SQL type, the driver creates an object of relevant type and invokes the method SQLData.readSQL on it, which reads supplementary data from the stream using whichever protocol is defined for that method.

Returns

  • the next attribute as an Object. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public Ref readRef()

Returns the next attribute in the stream in the form of a java.sql.Ref.

Returns

  • the next attribute as a java.sql.Ref. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public short readShort()

Returns the next attribute in the stream in the form of a short.

Returns

  • the next attribute as a short. 0 if the value is SQL NULL.

Throws

SQLException if there is a database error

public String readString()

Returns the next attribute in the stream in the form of a String.

Returns

  • the next attribute as a String. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public Time readTime()

Returns the next attribute in the stream in the form of a java.sql.Time.

Returns

  • the attribute as a java.sql.Time. null if the read returns SQL NULL.

Throws

SQLException if there is a database error

public Timestamp readTimestamp()

Returns the next attribute in the stream in the form of a java.sql.Timestamp.

Returns

  • the attribute as a java.sql.Timestamp. null if the read returns SQL NULL.

Throws

SQLException if there is a database error

public URL readURL()

Reads the next attribute in the stream (SQL DATALINK value) and returns it as a java.net.URL object.

Returns

  • the next attribute as a java.net.URL. null if the value is SQL NULL.

Throws

SQLException if there is a database error

public boolean wasNull()

Reports whether the last value read was SQL NULL.

Returns

  • true if the last value read was SQL NULL, false otherwise.

Throws

SQLException if there is a database error
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48