Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sdbc ::
interface XSQLInput
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XSQLInput
Description represents an input stream that contains a stream of values representing an instance of a SQL structured or distinct type. This interface, used only for custom mapping, is used by the driver behind the scenes, and a programmer never directly invokes `SQLInput` methods. When the method `getObject` is called with an object of a service implementing the interface `SQLData` , the SDBC driver calls the method XSQLData::getSQLType() to determine the SQL type of the user-defined type (UDT) being custom mapped. The driver creates an instance of XSQLInput , populating it with the attributes of the UDT. The driver then passes the input stream to the method XSQLData::readSQL() , which in turn calls the `XSQLInput.readXXX` methods in its implementation for reading the attributes from the input stream.

Methods' Summary
readString | reads the next attribute in the stream as string.
readBoolean | reads the next attribute in the stream as boolean.
readByte | reads the next attribute in the stream as byte.
readShort | reads the next attribute in the stream as short.
readInt | reads the next attribute in the stream as long.
readLong | reads the next attribute in the stream as hyper.
readFloat | reads the next attribute in the stream as float.
readDouble | reads the next attribute in the stream as double.
readBytes | reads the next attribute in the stream as sequence of bytes.
readDate | reads the next attribute in the stream as date.
readTime | reads the next attribute in the stream as time.
readTimestamp | reads the next attribute in the stream as datetime.
readBinaryStream | reads the next attribute in the stream as sequence of bytes.
readCharacterStream | reads the next attribute in the stream as a unicode string.
readObject | returns the datum at the head of the stream as an any.
readRef | reads a REF(&lt;structured-type&gt;) from the stream.
readBlob | reads a BLOB from the stream.
readClob | reads a CLOB from the stream.
readArray | reads an array from the stream.
wasNull | determines whether the last value read was null.

Methods' Details
readString
string readString() | raises( | SQLException );
Description reads the next attribute in the stream as string. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readBoolean
boolean readBoolean() | raises( | SQLException );
Description reads the next attribute in the stream as boolean. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readByte
byte readByte() | raises( | SQLException );
Description reads the next attribute in the stream as byte. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readShort
short readShort() | raises( | SQLException );
Description reads the next attribute in the stream as short. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readInt
long readInt() | raises( | SQLException );
Description reads the next attribute in the stream as long. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readLong
hyper readLong() | raises( | SQLException );
Description reads the next attribute in the stream as hyper. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readFloat
float readFloat() | raises( | SQLException );
Description reads the next attribute in the stream as float. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readDouble
double readDouble() | raises( | SQLException );
Description reads the next attribute in the stream as double. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readBytes
sequence< byte > readBytes() | raises( | SQLException );
Description reads the next attribute in the stream as sequence of bytes. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readDate
::com::sun::star::util::Date readDate() | raises( | SQLException );
Description reads the next attribute in the stream as date. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readTime
::com::sun::star::util::Time readTime() | raises( | SQLException );
Description reads the next attribute in the stream as time. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readTimestamp
::com::sun::star::util::DateTime readTimestamp() | raises( | SQLException );
Description reads the next attribute in the stream as datetime. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readBinaryStream
::com::sun::star::io::XInputStream readBinaryStream() | raises( | SQLException );
Description reads the next attribute in the stream as sequence of bytes. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readCharacterStream
::com::sun::star::io::XInputStream readCharacterStream() | raises( | SQLException );
Description reads the next attribute in the stream as a unicode string. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readObject
any readObject() | raises( | SQLException );
Description returns the datum at the head of the stream as an any. The actual type of the any returned is determined by the default type mapping, and any customizations present in this stream's type map. A type map is registered with the stream by the SDBC driver before the stream is passed to the application. When the datum at the head of the stream is a SQL NULL, the method returns void . If the datum is a SQL structured or distinct type, it determines the SQL type of the datum at the head of the stream, constructs an object of the appropriate service, and calls the method XSQLData::readSQL() on that object, which reads additional data from the stream using the protocol described for that method. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readRef
XRef readRef() | raises( | SQLException );
Description reads a REF(&lt;structured-type&gt;) from the stream. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readBlob
XBlob readBlob() | raises( | SQLException );
Description reads a BLOB from the stream. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readClob
XClob readClob() | raises( | SQLException );
Description reads a CLOB from the stream. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
readArray
XArray readArray() | raises( | SQLException );
Description reads an array from the stream. Returns the attribute; if the value is SQL NULL, return null. Throws SQLException if a database access error occurs.
wasNull
boolean wasNull() | raises( | SQLException );
Description determines whether the last value read was null. Returns true if the most recently gotten SQL value was null; otherwise, false Throws SQLException if a database access error occurs.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.