|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
| Method Summary | |
|---|---|
void |
writeArray(Array x)
Writes an SQL ARRAY value to the stream. |
void |
writeAsciiStream(InputStream x)
Writes 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)
Writes the next attribute to the stream as a stream of uninterpreted bytes. |
void |
writeBlob(Blob x)
Writes an SQL BLOB value 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)
Writes the next attribute to the stream as a stream of Unicode characters. |
void |
writeClob(Clob x)
Writes an SQL CLOB value 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 an SQL REF value 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 String
in the Java programming language. |
void |
writeStruct(Struct x)
Writes an SQL structured type value 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. |
void |
writeURL(URL x)
Writes a SQL DATALINK value to the stream. |
| Method Detail |
|---|
void writeString(String x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeBoolean(boolean x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeByte(byte x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeShort(short x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeInt(int x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeLong(long x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeFloat(float x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeDouble(double x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeBigDecimal(BigDecimal x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeBytes(byte[] x)
throws SQLException
String
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeDate(Date x)
throws SQLException
java.sql.Date object
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeTime(Time x)
throws SQLException
java.sql.Date object
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeTimestamp(Timestamp x)
throws SQLException
java.sql.Date object
in the Java programming language.
x - the value to pass to the database
SQLException - if a database access error occurs
void writeCharacterStream(Reader x)
throws SQLException
x - the value to pass to the database
SQLException - if a database access error occurs
void writeAsciiStream(InputStream x)
throws SQLException
x - the value to pass to the database
SQLException - if a database access error occurs
void writeBinaryStream(InputStream x)
throws SQLException
x - the value to pass to the database
SQLException - if a database access error occurs
void writeObject(SQLData x)
throws SQLException
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 writer 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.
x - the object representing data of an SQL structured or
distinct type
SQLException - if a database access error occurs
void writeRef(Ref x)
throws SQLException
REF value to the stream.
x - a Ref object representing data of an SQL
REF value
SQLException - if a database access error occurs
void writeBlob(Blob x)
throws SQLException
BLOB value to the stream.
x - a Blob object representing data of an SQL
BLOB value
SQLException - if a database access error occurs
void writeClob(Clob x)
throws SQLException
CLOB value to the stream.
x - a Clob object representing data of an SQL
CLOB value
SQLException - if a database access error occurs
void writeStruct(Struct x)
throws SQLException
x - a Struct object representing data of an SQL
structured type
SQLException - if a database access error occurs
void writeArray(Array x)
throws SQLException
ARRAY value to the stream.
x - an Array object representing data of an SQL
ARRAY type
SQLException - if a database access error occurs
void writeURL(URL x)
throws SQLException
DATALINK value to the stream.
x - a java.net.URL object representing the data
of SQL DATALINK type
SQLException - if a database access error occurs
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.