represents an input stream that contains a stream of values representing an instance of a SQL structured or distinct type.
More...
|
string | readString () raises (SQLException) |
| reads the next attribute in the stream as string.
|
|
boolean | readBoolean () raises (SQLException) |
| reads the next attribute in the stream as boolean.
|
|
byte | readByte () raises (SQLException) |
| reads the next attribute in the stream as byte.
|
|
short | readShort () raises (SQLException) |
| reads the next attribute in the stream as short.
|
|
long | readInt () raises (SQLException) |
| reads the next attribute in the stream as long.
|
|
hyper | readLong () raises (SQLException) |
| reads the next attribute in the stream as hyper.
|
|
float | readFloat () raises (SQLException) |
| reads the next attribute in the stream as float.
|
|
double | readDouble () raises (SQLException) |
| reads the next attribute in the stream as double.
|
|
sequence< byte > | readBytes () raises (SQLException) |
| reads the next attribute in the stream as sequence of bytes.
|
|
com::sun::star::util::Date | readDate () raises (SQLException) |
| reads the next attribute in the stream as date.
|
|
com::sun::star::util::Time | readTime () raises (SQLException) |
| reads the next attribute in the stream as time.
|
|
com::sun::star::util::DateTime | readTimestamp () raises (SQLException) |
| reads the next attribute in the stream as datetime.
|
|
com::sun::star::io::XInputStream | readBinaryStream () raises (SQLException) |
| reads the next attribute in the stream as sequence of bytes.
|
|
com::sun::star::io::XInputStream | readCharacterStream () raises (SQLException) |
| reads the next attribute in the stream as a Unicode string.
|
|
any | readObject () raises (SQLException) |
| returns the datum at the head of the stream as an any.
|
|
XRef | readRef () raises (SQLException) |
| reads a REF(<structured-type>) from the stream.
|
|
XBlob | readBlob () raises (SQLException) |
| reads a BLOB from the stream.
|
|
XClob | readClob () raises (SQLException) |
| reads a CLOB from the stream.
|
|
XArray | readArray () raises (SQLException) |
| reads an array from the stream.
|
|
boolean | wasNull () raises (SQLException) |
| determines whether the last value read was null.
|
|
any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object.
|
|
void | acquire () |
| increases the reference counter by one.
|
|
void | release () |
| decreases the reference counter by one.
|
|
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 com::sun::star::sdbc::XSQLData::getSQLType() to determine the SQL type of the user-defined type (UDT) being custom mapped. The driver creates an instance of com::sun::star::sdbc::XSQLInput , populating it with the attributes of the UDT. The driver then passes the input stream to the method com::sun::star::sdbc::XSQLData::readSQL() , which in turn calls the XSQLInput.readXXX
methods in its implementation for reading the attributes from the input stream.
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 com::sun::star::sdbc::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.
- Exceptions
-