java.sql
Interface SQLOutput

public abstract interface SQLOutput

JDBC 2.0 The 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 SQLData is passed as an argument to an 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 SQLOutput and passes it to the method SQLData.writeSQL. The method writeSQL in turn calls the appropriate SQLOutput.writeXXX methods to write data from the SQLData object to the SQLOutput output stream as the representation of an SQL user-defined type.

Method Summary

void	writeArray(Array x) Writes an array to the stream.
void	writeAsciiStream(InputStream x) Returns the next attribute to the stream as a stream of ASCII characters.
void	writeBigDecimal(BigDecimal x) Writes the next attribute to the stream as a java.math.BigDecimal object.
void	writeBinaryStream(InputStream x) Returns the next attribute to the stream as a stream of uninterpreted bytes.
void	writeBlob(Blob x) Writes a BLOB to the stream.
void	writeBoolean(boolean x) Writes the next attribute to the stream as a Java boolean.
void	writeByte(byte x) Writes the next attribute to the stream as a Java byte.
void	writeBytes(byte[] x) Writes the next attribute to the stream as an array of bytes.
void	writeCharacterStream(Reader x) Returns the next attribute to the stream as a stream of Unicode characters.
void	writeClob(Clob x) Writes a CLOB to the stream.
void	writeDate(Date x) Writes the next attribute to the stream as a java.sql.Date object.
void	writeDouble(double x) Writes the next attribute to the stream as a Java double.
void	writeFloat(float x) Writes the next attribute to the stream as a Java float.
void	writeInt(int x) Writes the next attribute to the stream as a Java int.
void	writeLong(long x) Writes the next attribute to the stream as a Java long.
void	writeObject(SQLData x) Writes to the stream the data contained in the given SQLData object.
void	writeRef(Ref x) Writes a REF(<structured-type>) to the stream.
void	writeShort(short x) Writes the next attribute to the stream as a Java short.
void	writeString(String x) Writes the next attribute to the stream as a Java String.
void	writeStruct(Struct x) Writes a structured-type to the stream.
void	writeTime(Time x) Writes the next attribute to the stream as a java.sql.Time object.
void	writeTimestamp(Timestamp x) Writes the next attribute to the stream as a java.sql.Timestamp object.

Method Detail

writeString

public void writeString(String x)
                 throws SQLException

Writes the next attribute to the stream as a Java String.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeBoolean

public void writeBoolean(boolean x)
                  throws SQLException

Writes the next attribute to the stream as a Java boolean.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeByte

public void writeByte(byte x)
               throws SQLException

Writes the next attribute to the stream as a Java byte.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeShort

public void writeShort(short x)
                throws SQLException

Writes the next attribute to the stream as a Java short.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeInt

public void writeInt(int x)
              throws SQLException

Writes the next attribute to the stream as a Java int.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeLong

public void writeLong(long x)
               throws SQLException

Writes the next attribute to the stream as a Java long.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeFloat

public void writeFloat(float x)
                throws SQLException

Writes the next attribute to the stream as a Java float.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeDouble

public void writeDouble(double x)
                 throws SQLException

Writes the next attribute to the stream as a Java double.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeBigDecimal

public void writeBigDecimal(BigDecimal x)
                     throws SQLException

Writes the next attribute to the stream as a java.math.BigDecimal object.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeBytes

public void writeBytes(byte[] x)
                throws SQLException

Writes the next attribute to the stream as an array of bytes.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeDate

public void writeDate(Date x)
               throws SQLException

Writes the next attribute to the stream as a java.sql.Date object.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeTime

public void writeTime(Time x)
               throws SQLException

Writes the next attribute to the stream as a java.sql.Time object.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeTimestamp

public void writeTimestamp(Timestamp x)
                    throws SQLException

Writes the next attribute to the stream as a java.sql.Timestamp object.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeCharacterStream

public void writeCharacterStream(Reader x)
                          throws SQLException

Returns the next attribute to the stream as a stream of Unicode characters.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeAsciiStream

public void writeAsciiStream(InputStream x)
                      throws SQLException

Returns the next attribute to the stream as a stream of ASCII characters.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeBinaryStream

public void writeBinaryStream(InputStream x)
                       throws SQLException

Returns the next attribute to the stream as a stream of uninterpreted bytes.

Parameters:

x - the value to pass to the database.

Throws:

SQLException - if a database access error occurs

writeObject

public void writeObject(SQLData x)
                 throws SQLException

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

Parameters:

x - the object representing data of an SQL structured or distinct type

Throws:

SQLException - if a database access error occurs

writeRef

public void writeRef(Ref x)
              throws SQLException

Writes a REF(<structured-type>) to the stream.

Parameters:

x - an object representing data of an SQL REF Type

Throws:

SQLException - if a database access error occurs

writeBlob

public void writeBlob(Blob x)
               throws SQLException

Writes a BLOB to the stream.

Parameters:

x - an object representing a BLOB

Throws:

SQLException - if a database access error occurs

writeClob

public void writeClob(Clob x)
               throws SQLException

Writes a CLOB to the stream.

Parameters:

x - an object representing a CLOB

Throws:

SQLException - if a database access error occurs

writeStruct

public void writeStruct(Struct x)
                 throws SQLException

Writes a structured-type to the stream.

Parameters:

x - an object representing data of a Structured Type

Throws:

SQLException - if a database access error occurs

writeArray

public void writeArray(Array x)
                throws SQLException

Writes an array to the stream.

Parameters:

x - an object representing an SQL array

Throws:

SQLException - if a database access error occurs