SQLOutput

public interface SQLOutput

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 the interface SQLData is passed as an argument to an SQL statement, the JDBC driver calls the method 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 writer methods writeBoolean, writeCharacterStream, and so on) to write data from the SQLData object to the SQLOutput output stream as the representation of an SQL user-defined type.

Public Method Summary

abstract void
writeArray(Array x)
Writes an SQL ARRAY value to the stream.
abstract void
writeAsciiStream(InputStream x)
Writes the next attribute to the stream as a stream of ASCII characters.
abstract void
writeBigDecimal(BigDecimal x)
Writes the next attribute to the stream as a java.math.BigDecimal object.
abstract void
writeBinaryStream(InputStream x)
Writes the next attribute to the stream as a stream of uninterpreted bytes.
abstract void
writeBlob(Blob x)
Writes an SQL BLOB value to the stream.
abstract void
writeBoolean(boolean x)
Writes the next attribute to the stream as a Java boolean.
abstract void
writeByte(byte x)
Writes the next attribute to the stream as a Java byte.
abstract void
writeBytes(byte[] x)
Writes the next attribute to the stream as an array of bytes.
abstract void
writeCharacterStream(Reader x)
Writes the next attribute to the stream as a stream of Unicode characters.
abstract void
writeClob(Clob x)
Writes an SQL CLOB value to the stream.
abstract void
writeDate(Date x)
Writes the next attribute to the stream as a java.sql.Date object.
abstract void
writeDouble(double x)
Writes the next attribute to the stream as a Java double.
abstract void
writeFloat(float x)
Writes the next attribute to the stream as a Java float.
abstract void
writeInt(int x)
Writes the next attribute to the stream as a Java int.
abstract void
writeLong(long x)
Writes the next attribute to the stream as a Java long.
abstract void
writeNClob(NClob x)
Writes an SQL NCLOB value to the stream.
abstract void
writeNString(String x)
Writes the next attribute to the stream as a String in the Java programming language.
abstract void
writeObject(SQLData x)
Writes to the stream the data contained in the given SQLData object.
abstract void
writeRef(Ref x)
Writes an SQL REF value to the stream.
abstract void
writeRowId(RowId x)
Writes an SQL ROWID value to the stream.
abstract void
writeSQLXML(SQLXML x)
Writes an SQL XML value to the stream.
abstract void
writeShort(short x)
Writes the next attribute to the stream as a Java short.
abstract void
writeString(String x)
Writes the next attribute to the stream as a String in the Java programming language.
abstract void
writeStruct(Struct x)
Writes an SQL structured type value to the stream.
abstract void
writeTime(Time x)
Writes the next attribute to the stream as a java.sql.Time object.
abstract void
writeTimestamp(Timestamp x)
Writes the next attribute to the stream as a java.sql.Timestamp object.
abstract void
writeURL(URL x)
Writes a SQL DATALINK value to the stream.

Public Methods

public abstract void writeArray (Array x)

Writes an SQL ARRAY value to the stream.

Parameters
x an Array object representing data of an SQL ARRAY type
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract void writeAsciiStream (InputStream x)

Writes 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
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract void writeBigDecimal (BigDecimal x)

Writes the next attribute to the stream as a java.math.BigDecimal object. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x the value to pass to the database
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract void writeBinaryStream (InputStream x)

Writes 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
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract void writeBlob (Blob x)

Writes an SQL BLOB value to the stream.

Parameters
x a Blob object representing data of an SQL BLOB value
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method

public abstract void writeBoolean (boolean x)

Writes the next attribute to the stream as a Java boolean. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x the value to pass to the database
Throws
SQLException if a database access error occurs
SQLFeatureNotSupportedException if the JDBC driver does not support this method