- java.lang.Object
-
- javax.sql.rowset.serial.SQLOutputImpl
-
- All Implemented Interfaces:
- SQLOutput
public class SQLOutputImpl extends Object implements SQLOutput
The output stream for writing the attributes of a custom-mapped user-defined type (UDT) back to the database. The driver uses this interface internally, and its methods are never directly invoked by an application programmer.When an application calls the method
PreparedStatement.setObject
, the driver checks to see whether the value to be written is a UDT with a custom mapping. If it is, there will be an entry in a type map containing theClass
object for the class that implementsSQLData
for this UDT. If the value to be written is an instance ofSQLData
, the driver will create an instance ofSQLOutputImpl
and pass it to the methodSQLData.writeSQL
. The methodwriteSQL
in turn calls the appropriateSQLOutputImpl.writeXXX
methods to write data from theSQLData
object to theSQLOutputImpl
output stream as the representation of an SQL user-defined type.
-
-
Constructor Summary
Constructors Constructor and Description SQLOutputImpl(Vector<?> attributes, Map<String,?> map)
Creates a newSQLOutputImpl
object initialized with the given vector of attributes and type map.
-
Method Summary
Methods Modifier and Type Method and Description void
writeArray(Array x)
Writes anArray
object in the Java programming language to thisSQLOutputImpl
object.void
writeAsciiStream(InputStream x)
Writes a stream of ASCII characters to thisSQLOutputImpl
object.void
writeBigDecimal(BigDecimal x)
Writes ajava.math.BigDecimal
object in the Java programming language to thisSQLOutputImpl
object.void
writeBinaryStream(InputStream x)
Writes a stream of uninterpreted bytes to thisSQLOutputImpl
object.void
writeBlob(Blob x)
Writes aBlob
object in the Java programming language to thisSQLOutputImpl
object.void
writeBoolean(boolean x)
Writes aboolean
in the Java programming language to thisSQLOutputImpl
object.void
writeByte(byte x)
Writes abyte
in the Java programming language to thisSQLOutputImpl
object.void
writeBytes(byte[] x)
Writes an array ofbytes
in the Java programming language to thisSQLOutputImpl
object.void
writeCharacterStream(Reader x)
Writes a stream of Unicode characters to thisSQLOutputImpl
object.void
writeClob(Clob x)
Writes aClob
object in the Java programming language to thisSQLOutputImpl
object.void
writeDate(Date x)
Writes ajava.sql.Date
object in the Java programming language to thisSQLOutputImpl
object.void
writeDouble(double x)
Writes adouble
in the Java programming language to thisSQLOutputImpl
object.void
writeFloat(float x)
Writes afloat
in the Java programming language to thisSQLOutputImpl
object.void
writeInt(int x)
Writes anint
in the Java programming language to thisSQLOutputImpl
object.void
writeLong(long x)
Writes along
in the Java programming language to thisSQLOutputImpl
object.void
writeNClob(NClob x)
Writes an SQLNCLOB
value to the stream.void
writeNString(String x)
Writes the next attribute to the stream as aString
in the Java programming language.void
writeObject(SQLData x)
Writes to the stream the data contained in the givenSQLData
object.void
writeRef(Ref x)
Writes aRef
object in the Java programming language to thisSQLOutputImpl
object.void
writeRowId(RowId x)
Writes an SQLROWID
value to the stream.void
writeShort(short x)
Writes ashort
in the Java programming language to thisSQLOutputImpl
object.void
writeSQLXML(SQLXML x)
Writes an SQLXML
value to the stream.void
writeString(String x)
Writes aString
in the Java programming language to thisSQLOutputImpl
object.void
writeStruct(Struct x)
Writes aStruct
object in the Java programming language to thisSQLOutputImpl
object.void
writeTime(Time x)
Writes ajava.sql.Time
object in the Java programming language to thisSQLOutputImpl
object.void
writeTimestamp(Timestamp x)
Writes ajava.sql.Timestamp
object in the Java programming language to thisSQLOutputImpl
object.void
writeURL(URL url)
Writes anjava.sql.Type.DATALINK
object in the Java programming language to thisSQLOutputImpl
object.
-
-
-
Constructor Detail
-
SQLOutputImpl
public SQLOutputImpl(Vector<?> attributes, Map<String,?> map) throws SQLException
Creates a newSQLOutputImpl
object initialized with the given vector of attributes and type map. The driver will use the type map to determine whichSQLData.writeSQL
method to invoke. This method will then call the appropriateSQLOutputImpl
writer methods in order and thereby write the attributes to the new output stream.- Parameters:
attributes
- aVector
object containing the attributes of the UDT to be mapped to one or more objects in the Java programming languagemap
- ajava.util.Map
object containing zero or more entries, with each entry consisting of 1) aString
giving the fully qualified name of a UDT and 2) theClass
object for theSQLData
implementation that defines how the UDT is to be mapped- Throws:
SQLException
- if theattributes
or themap
is anull
value
-
-
Method Detail
-
writeString
public void writeString(String x) throws SQLException
Writes aString
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLCHAR
,VARCHAR
, orLONGVARCHAR
before returning it to the database.- Specified by:
writeString
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeBoolean
public void writeBoolean(boolean x) throws SQLException
Writes aboolean
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLBIT
before returning it to the database.- Specified by:
writeBoolean
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeByte
public void writeByte(byte x) throws SQLException
Writes abyte
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLBIT
before returning it to the database.- Specified by:
writeByte
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeShort
public void writeShort(short x) throws SQLException
Writes ashort
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLSMALLINT
before returning it to the database.- Specified by:
writeShort
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeInt
public void writeInt(int x) throws SQLException
Writes anint
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLINTEGER
before returning it to the database.- Specified by:
writeInt
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeLong
public void writeLong(long x) throws SQLException
Writes along
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLBIGINT
before returning it to the database.- Specified by:
writeLong
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeFloat
public void writeFloat(float x) throws SQLException
Writes afloat
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLREAL
before returning it to the database.- Specified by:
writeFloat
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeDouble
public void writeDouble(double x) throws SQLException
Writes adouble
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLDOUBLE
before returning it to the database.- Specified by:
writeDouble
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeBigDecimal
public void writeBigDecimal(BigDecimal x) throws SQLException
Writes ajava.math.BigDecimal
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLNUMERIC
before returning it to the database.- Specified by:
writeBigDecimal
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeBytes
public void writeBytes(byte[] x) throws SQLException
Writes an array ofbytes
in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLVARBINARY
orLONGVARBINARY
before returning it to the database.- Specified by:
writeBytes
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeDate
public void writeDate(Date x) throws SQLException
Writes ajava.sql.Date
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLDATE
before returning it to the database.- Specified by:
writeDate
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeTime
public void writeTime(Time x) throws SQLException
Writes ajava.sql.Time
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLTIME
before returning it to the database.- Specified by:
writeTime
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeTimestamp
public void writeTimestamp(Timestamp x) throws SQLException
Writes ajava.sql.Timestamp
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to an SQLTIMESTAMP
before returning it to the database.- Specified by:
writeTimestamp
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeCharacterStream
public void writeCharacterStream(Reader x) throws SQLException
Writes a stream of Unicode characters to thisSQLOutputImpl
object. The driver will do any necessary conversion from Unicode to the databaseCHAR
format.- Specified by:
writeCharacterStream
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeAsciiStream
public void writeAsciiStream(InputStream x) throws SQLException
Writes a stream of ASCII characters to thisSQLOutputImpl
object. The driver will do any necessary conversion from ASCII to the databaseCHAR
format.- Specified by:
writeAsciiStream
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeBinaryStream
public void writeBinaryStream(InputStream x) throws SQLException
Writes a stream of uninterpreted bytes to thisSQLOutputImpl
object.- Specified by:
writeBinaryStream
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeObject
public void writeObject(SQLData x) throws SQLException
Writes to the stream the data contained in the givenSQLData
object. When theSQLData
object isnull
, this method writes an SQLNULL
to the stream. Otherwise, it calls theSQLData.writeSQL
method of the given object, which writes the object's attributes to the stream.The implementation of the method
SQLData.writeSQ
calls the appropriateSQLOutputImpl.writeXXX
method(s) for writing each of the object's attributes in order. The attributes must be read from anSQLInput
input stream and written to anSQLOutputImpl
output stream in the same order in which they were listed in the SQL definition of the user-defined type.- Specified by:
writeObject
in interfaceSQLOutput
- Parameters:
x
- the object representing data of an SQL structured or distinct type- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeRef
public void writeRef(Ref x) throws SQLException
Writes aRef
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to a serializableSerialRef
SQLREF
value before returning it to the database.- Specified by:
writeRef
in interfaceSQLOutput
- Parameters:
x
- an object representing an SQLREF
value- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeBlob
public void writeBlob(Blob x) throws SQLException
Writes aBlob
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to a serializableSerialBlob
SQLBLOB
value before returning it to the database.- Specified by:
writeBlob
in interfaceSQLOutput
- Parameters:
x
- an object representing an SQLBLOB
value- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeClob
public void writeClob(Clob x) throws SQLException
Writes aClob
object in the Java programming language to thisSQLOutputImpl
object. The driver converts it to a serializableSerialClob
SQLCLOB
value before returning it to the database.- Specified by:
writeClob
in interfaceSQLOutput
- Parameters:
x
- an object representing an SQLCLOB
value- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeStruct
public void writeStruct(Struct x) throws SQLException
Writes aStruct
object in the Java programming language to thisSQLOutputImpl
object. The driver converts this value to an SQL structured type before returning it to the database.This method should be used when an SQL structured type has been mapped to a
Struct
object in the Java programming language (the standard mapping). The methodwriteObject
should be used if an SQL structured type has been custom mapped to a class in the Java programming language.- Specified by:
writeStruct
in interfaceSQLOutput
- Parameters:
x
- an object representing the attributes of an SQL structured type- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeArray
public void writeArray(Array x) throws SQLException
Writes anArray
object in the Java programming language to thisSQLOutputImpl
object. The driver converts this value to a serializableSerialArray
SQLARRAY
value before returning it to the database.- Specified by:
writeArray
in interfaceSQLOutput
- Parameters:
x
- an object representing an SQLARRAY
value- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeURL
public void writeURL(URL url) throws SQLException
Writes anjava.sql.Type.DATALINK
object in the Java programming language to thisSQLOutputImpl
object. The driver converts this value to a serializableSerialDatalink
SQLDATALINK
value before return it to the database.- Specified by:
writeURL
in interfaceSQLOutput
- Parameters:
url
- an object representing a SQLDATALINK
value- Throws:
SQLException
- if theSQLOutputImpl
object is in use by aSQLData
object attempting to write the attribute values of a UDT to the database.
-
writeNString
public void writeNString(String x) throws SQLException
Writes the next attribute to the stream as aString
in the Java programming language. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
value (depending on the argument's size relative to the driver's limits onNVARCHAR
values) when it sends it to the stream.- Specified by:
writeNString
in interfaceSQLOutput
- Parameters:
x
- the value to pass to the database- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
writeNClob
public void writeNClob(NClob x) throws SQLException
Writes an SQLNCLOB
value to the stream.- Specified by:
writeNClob
in interfaceSQLOutput
- Parameters:
x
- aNClob
object representing data of an SQLNCLOB
value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
writeRowId
public void writeRowId(RowId x) throws SQLException
Writes an SQLROWID
value to the stream.- Specified by:
writeRowId
in interfaceSQLOutput
- Parameters:
x
- aRowId
object representing data of an SQLROWID
value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
writeSQLXML
public void writeSQLXML(SQLXML x) throws SQLException
Writes an SQLXML
value to the stream.- Specified by:
writeSQLXML
in interfaceSQLOutput
- Parameters:
x
- aSQLXML
object representing data of an SQLXML
value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/sql/rowset/serial/sqloutputimpl.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.