/* * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved. * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. * * * * * * * * * * * * * * * * * * * * */ package javax.sql.rowset.serial; import java.sql.*; import javax.sql.*; import java.io.*; import java.lang.String; import java.math.*; import java.util.Map; import java.util.Vector; /** * 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 the Class object for the * class that implements SQLData for this UDT. * If the value to be written is an instance of SQLData, * the driver will create an instance of SQLOutputImpl * and pass it to the method SQLData.writeSQL. * The method writeSQL in turn calls the * appropriate SQLOutputImpl.writeXXX methods * to write data from the SQLData object to * the SQLOutputImpl output stream as the * representation of an SQL user-defined type. */ public class SQLOutputImpl implements SQLOutput { /** * A reference to an existing vector that * contains the attributes of a Struct object. */ private Vector attribs; /** * The type map the driver supplies to a newly created * SQLOutputImpl object. This type map * indicates the SQLData class whose * writeSQL method will be called. This * method will in turn call the appropriate * SQLOutputImpl writer methods. */ private Map map; /** * Creates a new SQLOutputImpl object * initialized with the given vector of attributes and * type map. The driver will use the type map to determine * which SQLData.writeSQL method to invoke. * This method will then call the appropriate * SQLOutputImpl writer methods in order and * thereby write the attributes to the new output stream. * * @param attributes a Vector object containing the attributes of * the UDT to be mapped to one or more objects in the Java * programming language * * @param map a java.util.Map object containing zero or * more entries, with each entry consisting of 1) a String * giving the fully qualified name of a UDT and 2) the * Class object for the SQLData implementation * that defines how the UDT is to be mapped * @throws SQLException if the attributes or the map * is a null value */ public SQLOutputImpl(Vector attributes, Map map) throws SQLException { if ((attributes == null) || (map == null)) { throw new SQLException("Cannot instantiate a SQLOutputImpl " + "instance with null parameters"); } this.attribs = attributes; this.map = map; } //================================================================ // Methods for writing attributes to the stream of SQL data. // These methods correspond to the column-accessor methods of // java.sql.ResultSet. //================================================================ /** * Writes a String in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL CHAR, VARCHAR, or * LONGVARCHAR before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeString(String x) throws SQLException { //System.out.println("Adding :"+x); attribs.add(x); } /** * Writes a boolean in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL BIT before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeBoolean(boolean x) throws SQLException { attribs.add(Boolean.valueOf(x)); } /** * Writes a byte in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL BIT before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeByte(byte x) throws SQLException { attribs.add(Byte.valueOf(x)); } /** * Writes a short in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL SMALLINT before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeShort(short x) throws SQLException { attribs.add(Short.valueOf(x)); } /** * Writes an int in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL INTEGER before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeInt(int x) throws SQLException { attribs.add(Integer.valueOf(x)); } /** * Writes a long in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL BIGINT before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeLong(long x) throws SQLException { attribs.add(Long.valueOf(x)); } /** * Writes a float in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL REAL before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeFloat(float x) throws SQLException { attribs.add(new Float(x)); } /** * Writes a double in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL DOUBLE before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeDouble(double x) throws SQLException{ attribs.add(new Double(x)); } /** * Writes a java.math.BigDecimal object in the Java programming * language to this SQLOutputImpl object. The driver converts * it to an SQL NUMERIC before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeBigDecimal(java.math.BigDecimal x) throws SQLException{ attribs.add(x); } /** * Writes an array of bytes in the Java programming language * to this SQLOutputImpl object. The driver converts * it to an SQL VARBINARY or LONGVARBINARY * before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeBytes(byte[] x) throws SQLException { attribs.add(x); } /** * Writes a java.sql.Date object in the Java programming * language to this SQLOutputImpl object. The driver converts * it to an SQL DATE before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeDate(java.sql.Date x) throws SQLException { attribs.add(x); } /** * Writes a java.sql.Time object in the Java programming * language to this SQLOutputImpl object. The driver converts * it to an SQL TIME before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeTime(java.sql.Time x) throws SQLException { attribs.add(x); } /** * Writes a java.sql.Timestamp object in the Java programming * language to this SQLOutputImpl object. The driver converts * it to an SQL TIMESTAMP before returning it to the database. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeTimestamp(java.sql.Timestamp x) throws SQLException { attribs.add(x); } /** * Writes a stream of Unicode characters to this * SQLOutputImpl object. The driver will do any necessary * conversion from Unicode to the database CHAR format. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeCharacterStream(java.io.Reader x) throws SQLException { BufferedReader bufReader = new BufferedReader(x); try { int i; while( (i = bufReader.read()) != -1 ) { char ch = (char)i; StringBuffer strBuf = new StringBuffer(); strBuf.append(ch); String str = new String(strBuf); String strLine = bufReader.readLine(); writeString(str.concat(strLine)); } } catch(IOException ioe) { } } /** * Writes a stream of ASCII characters to this * SQLOutputImpl object. The driver will do any necessary * conversion from ASCII to the database CHAR format. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeAsciiStream(java.io.InputStream x) throws SQLException { BufferedReader bufReader = new BufferedReader(new InputStreamReader(x)); try { int i; while( (i=bufReader.read()) != -1 ) { char ch = (char)i; StringBuffer strBuf = new StringBuffer(); strBuf.append(ch); String str = new String(strBuf); String strLine = bufReader.readLine(); writeString(str.concat(strLine)); } }catch(IOException ioe) { throw new SQLException(ioe.getMessage()); } } /** * Writes a stream of uninterpreted bytes to this SQLOutputImpl * object. * * @param x the value to pass to the database * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeBinaryStream(java.io.InputStream x) throws SQLException { BufferedReader bufReader = new BufferedReader(new InputStreamReader(x)); try { int i; while( (i=bufReader.read()) != -1 ) { char ch = (char)i; StringBuffer strBuf = new StringBuffer(); strBuf.append(ch); String str = new String(strBuf); String strLine = bufReader.readLine(); writeString(str.concat(strLine)); } } catch(IOException ioe) { throw new SQLException(ioe.getMessage()); } } //================================================================ // Methods for writing items of SQL user-defined types to the stream. // These methods pass objects to the database as values of SQL // Structured Types, Distinct Types, Constructed Types, and Locator // Types. They decompose the Java object(s) and write leaf data // items using the methods above. //================================================================ /** * 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 SQLOutputImpl.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 SQLOutputImpl * output stream in the same order in which they were * listed in the SQL definition of the user-defined type. * * @param x the object representing data of an SQL structured or * distinct type * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeObject(SQLData x) throws SQLException { /* * Except for the types that are passed as objects * this seems to be the only way for an object to * get a null value for a field in a structure. * * Note: this means that the class defining SQLData * will need to track if a field is SQL null for itself */ if (x == null) { attribs.add(x); return; } /* * We have to write out a SerialStruct that contains * the name of this class otherwise we don't know * what to re-instantiate during readSQL() */ attribs.add(new SerialStruct((SQLData)x, map)); } /** * Writes a Ref object in the Java programming language * to this SQLOutputImpl object. The driver converts * it to a serializable SerialRef SQL REF value * before returning it to the database. * * @param x an object representing an SQL REF value * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeRef(Ref x) throws SQLException { if (x == null) { attribs.add(x); return; } attribs.add(new SerialRef(x)); } /** * Writes a Blob object in the Java programming language * to this SQLOutputImpl object. The driver converts * it to a serializable SerialBlob SQL BLOB value * before returning it to the database. * * @param x an object representing an SQL BLOB value * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeBlob(Blob x) throws SQLException { if (x == null) { attribs.add(x); return; } attribs.add(new SerialBlob(x)); } /** * Writes a Clob object in the Java programming language * to this SQLOutputImpl object. The driver converts * it to a serializable SerialClob SQL CLOB value * before returning it to the database. * * @param x an object representing an SQL CLOB value * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeClob(Clob x) throws SQLException { if (x == null) { attribs.add(x); return; } attribs.add(new SerialClob(x)); } /** * Writes a Struct object in the Java * programming language to this SQLOutputImpl * 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 method * writeObject should be used if an SQL structured type * has been custom mapped to a class in the Java programming language. * * @param x an object representing the attributes of an SQL structured type * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeStruct(Struct x) throws SQLException { SerialStruct s = new SerialStruct(x,map);; attribs.add(s); } /** * Writes an Array object in the Java * programming language to this SQLOutputImpl * object. The driver converts this value to a serializable * SerialArray SQL ARRAY * value before returning it to the database. * * @param x an object representing an SQL ARRAY value * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeArray(Array x) throws SQLException { if (x == null) { attribs.add(x); return; } attribs.add(new SerialArray(x, map)); } /** * Writes an java.sql.Type.DATALINK object in the Java * programming language to this SQLOutputImpl object. The * driver converts this value to a serializable SerialDatalink * SQL DATALINK value before return it to the database. * * @param url an object representing a SQL DATALINK value * @throws SQLException if the SQLOutputImpl object is in * use by a SQLData object attempting to write the attribute * values of a UDT to the database. */ public void writeURL(java.net.URL url) throws SQLException { if (url == null) { attribs.add(url); return; } attribs.add(new SerialDatalink(url)); } /** * Writes the next attribute to the stream as a String * in the Java programming language. The driver converts this to a * SQL NCHAR or * NVARCHAR or LONGNVARCHAR value * (depending on the argument's * size relative to the driver's limits on NVARCHAR values) * when it sends it to the stream. * * @param x the value to pass to the database * @exception SQLException if a database access error occurs * @since 1.6 */ public void writeNString(String x) throws SQLException { throw new UnsupportedOperationException("Operation not supported"); } /** * Writes an SQL NCLOB value to the stream. * * @param x a NClob object representing data of an SQL * NCLOB value * * @exception SQLException if a database access error occurs * @since 1.6 */ public void writeNClob(NClob x) throws SQLException { throw new UnsupportedOperationException("Operation not supported"); } /** * Writes an SQL ROWID value to the stream. * * @param x a RowId object representing data of an SQL * ROWID value * * @exception SQLException if a database access error occurs * @since 1.6 */ public void writeRowId(RowId x) throws SQLException { throw new UnsupportedOperationException("Operation not supported"); } /** * Writes an SQL XML value to the stream. * * @param x a SQLXML object representing data of an SQL * XML value * * @exception SQLException if a database access error occurs * @since 1.6 */ public void writeSQLXML(SQLXML x) throws SQLException { throw new UnsupportedOperationException("Operation not supported"); } }