Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: sdbc ::

interface XSQLOutput

Base Interface
com::sun::star::uno::XInterface

Description
is used as an output stream for writing the attributes of a user-defined type back to the database. This interface, used only for custom mapping, is used by the driver, and its methods are never directly invoked by a programmer.

When an object of a class implementing interface XSQLData is passed as an argument to a SQL statement, the JDBC driver calls SQLData::getSQLType() to determine the kind of SQL datum being passed to the database.
The driver then creates an instance of XSQLOutput and passes it to the method XSQLData::writeSQL() . The method writeSQL in turn calls the appropriate XSQLOutput.writeXXX methods to write data from the XSQLData object to the XSQLOutput output stream as the representation of a SQL user-defined type.



Methods' Summary

writeString writes the next attribute to the stream as a string.
writeBoolean writes the next attribute to the stream as boolean.
writeByte writes the next attribute to the stream as byte.
writeShort writes the next attribute to the stream as short.
writeInt writes the next attribute to the stream as long.
writeLong writes the next attribute to the stream as hyper.
writeFloat writes the next attribute to the stream as float.
writeDouble writes the next attribute to the stream as double.
writeBytes writes the next attribute to the stream as byte sequence.
writeDate writes the next attribute to the stream as a date.
writeTime writes the next attribute to the stream as a time.
writeTimestamp writes the next attribute to the stream as a datetime.
writeBinaryStream writes the next attribute to the stream as a stream of uninterpreted bytes.
writeCharacterStream writes the next attribute to the stream as a stream of unicode string.
writeObject writes to the stream the data contained in the given XSQLData object.
writeRef writes a REF(<structured-type>) to the stream.
writeBlob writes a BLOB to the stream.
writeClob writes a CLOB to the stream.
writeStruct writes a structured-type to the stream.
writeArray writes an array to the stream.

Methods' Details

writeString
 
void
writeString(
[ in ] string x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as a string.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeBoolean
 
void
writeBoolean(
[ in ] boolean x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as boolean.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeByte
 
void
writeByte(
[ in ] byte x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as byte.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeShort
 
void
writeShort(
[ in ] short x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as short.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeInt
 
void
writeInt(
[ in ] long x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as long.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeLong
 
void
writeLong(
[ in ] hyper x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as hyper.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeFloat
 
void
writeFloat(
[ in ] float x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as float.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeDouble
 
void
writeDouble(
[ in ] double x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as double.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeBytes
 
void
writeBytes(
[ in ] sequence< byte > x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as byte sequence.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeDate
 
void
writeDate(
[ in ] com::sun::star::util::Date x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as a date.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeTime
 
void
writeTime(
[ in ] com::sun::star::util::Time x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as a time.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeTimestamp
 
void
writeTimestamp(
[ in ] com::sun::star::util::DateTime x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as a datetime.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeBinaryStream
 
void
writeBinaryStream(
[ in ] com::sun::star::io::XInputStream x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as a stream of uninterpreted bytes.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeCharacterStream
 
void
writeCharacterStream(
[ in ] com::sun::star::io::XInputStream x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes the next attribute to the stream as a stream of unicode string.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeObject
 
void
writeObject(
[ in ] com::sun::star::sdbc::XSQLData x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes to the stream the data contained in the given XSQLData object.

When the XSQLData object is NULL , this method writes an SQL NULL to the stream. Otherwise, it calls the XSQLData::writeSQL() method of the given object, which writes the object's attributes to the stream. The implementation of the method XSQLData::writeSQL() calls the appropriate XSQLOutput.writeXXX method(s) for writing each of the object's attributes in order.
The attributes must be read from an XSQLInput input stream and written to an XSQLOutput output stream in the same order in which they were listed in the SQL definition of the user-defined type.

Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeRef
 
void
writeRef(
[ in ] com::sun::star::sdbc::XRef x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes a REF(&amp;lt;structured-type&amp;gt;) to the stream.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeBlob
 
void
writeBlob(
[ in ] com::sun::star::sdbc::XBlob x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes a BLOB to the stream.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeClob
 
void
writeClob(
[ in ] com::sun::star::sdbc::XClob x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes a CLOB to the stream.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeStruct
 
void
writeStruct(
[ in ] com::sun::star::sdbc::XStruct x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes a structured-type to the stream.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.
writeArray
 
void
writeArray(
[ in ] com::sun::star::sdbc::XArray x )
raises ( com::sun::star::sdbc::SQLException );

Description
writes an array to the stream.
Parameter x
the value to pass to the database.
Throws
SQLException if a database access error occurs.

Top of Page