Java example source code file (SQLOutputImpl.java)

This example Java source code file (SQLOutputImpl.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

bufferedreader, cannot, inputstreamreader, jdbc, map, serialblob, serialdatalink, serialref, serialstruct, sql, sqlexception, sqloutputimpl, string, stringbuffer, suppresswarnings, util, vector

The SQLOutputImpl.java Java example source code

/*
 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.sql.rowset.serial;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.sql.*;
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.
 * <p>
 * When an application calls the
 * method <code>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 <code>Class object for the
 * class that implements <code>SQLData for this UDT.
 * If the value to be written is an instance of <code>SQLData,
 * the driver will create an instance of <code>SQLOutputImpl
 * and pass it to the method <code>SQLData.writeSQL.
 * The method <code>writeSQL in turn calls the
 * appropriate <code>SQLOutputImpl.writeXXX methods
 * to write data from the <code>SQLData object to
 * the <code>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 <code>Struct object.
     */
    @SuppressWarnings("rawtypes")
    private Vector attribs;

    /**
     * The type map the driver supplies to a newly created
     * <code>SQLOutputImpl object.  This type map
     * indicates the <code>SQLData class whose
     * <code>writeSQL method will be called.  This
     * method will in turn call the appropriate
     * <code>SQLOutputImpl writer methods.
     */
    @SuppressWarnings("rawtypes")
    private Map map;

    /**
     * Creates a new <code>SQLOutputImpl object
     * initialized with the given vector of attributes and
     * type map.  The driver will use the type map to determine
     * which <code>SQLData.writeSQL method to invoke.
     * This method will then call the appropriate
     * <code>SQLOutputImpl writer methods in order and
     * thereby write the attributes to the new output stream.
     *
     * @param attributes a <code>Vector object containing the attributes of
     *        the UDT to be mapped to one or more objects in the Java
     *        programming language
     *
     * @param map a <code>java.util.Map object containing zero or
     *        more entries, with each entry consisting of 1) a <code>String
     *        giving the fully qualified name of a UDT and 2) the
     *        <code>Class object for the SQLData implementation
     *        that defines how the UDT is to be mapped
     * @throws SQLException if the <code>attributes or the map
     *        is a <code>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 <code>String in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>CHAR, VARCHAR, or
     * <code>LONGVARCHAR before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeString(String x) throws SQLException {
        //System.out.println("Adding :"+x);
        attribs.add(x);
    }

    /**
     * Writes a <code>boolean in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>BIT before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeBoolean(boolean x) throws SQLException {
        attribs.add(Boolean.valueOf(x));
    }

    /**
     * Writes a <code>byte in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>BIT before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeByte(byte x) throws SQLException {
        attribs.add(Byte.valueOf(x));
    }

    /**
     * Writes a <code>short in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>SMALLINT before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeShort(short x) throws SQLException {
        attribs.add(Short.valueOf(x));
    }

    /**
     * Writes an <code>int in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>INTEGER before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeInt(int x) throws SQLException {
        attribs.add(Integer.valueOf(x));
    }

    /**
     * Writes a <code>long in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>BIGINT before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeLong(long x) throws SQLException {
        attribs.add(Long.valueOf(x));
    }

    /**
     * Writes a <code>float in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>REAL before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeFloat(float x) throws SQLException {
        attribs.add(Float.valueOf(x));
    }

    /**
     * Writes a <code>double in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>DOUBLE before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeDouble(double x) throws SQLException{
        attribs.add(Double.valueOf(x));
    }

    /**
     * Writes a <code>java.math.BigDecimal object in the Java programming
     * language to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>NUMERIC before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeBigDecimal(java.math.BigDecimal x) throws SQLException{
        attribs.add(x);
    }

    /**
     * Writes an array of <code>bytes in the Java programming language
     * to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>VARBINARY or LONGVARBINARY
     * before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeBytes(byte[] x) throws SQLException {
        attribs.add(x);
    }

    /**
     * Writes a <code>java.sql.Date object in the Java programming
     * language to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>DATE before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeDate(java.sql.Date x) throws SQLException {
        attribs.add(x);
    }

    /**
     * Writes a <code>java.sql.Time object in the Java programming
     * language to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>TIME before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeTime(java.sql.Time x) throws SQLException {
        attribs.add(x);
    }

    /**
     * Writes a <code>java.sql.Timestamp object in the Java programming
     * language to this <code>SQLOutputImpl object. The driver converts
     * it to an SQL <code>TIMESTAMP before returning it to the database.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeTimestamp(java.sql.Timestamp x) throws SQLException {
        attribs.add(x);
    }

    /**
     * Writes a stream of Unicode characters to this
     * <code>SQLOutputImpl object. The driver will do any necessary
     * conversion from Unicode to the database <code>CHAR format.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    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
     * <code>SQLOutputImpl object. The driver will do any necessary
     * conversion from ASCII to the database <code>CHAR format.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    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 <code>SQLOutputImpl
     * object.
     *
     * @param x the value to pass to the database
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    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
     * <code>SQLData object.
     * When the <code>SQLData object is null, this
     * method writes an SQL <code>NULL to the stream.
     * Otherwise, it calls the <code>SQLData.writeSQL
     * method of the given object, which
     * writes the object's attributes to the stream.
     * <P>
     * The implementation of the method <code>SQLData.writeSQ
     * calls the appropriate <code>SQLOutputImpl.writeXXX method(s)
     * for writing each of the object's attributes in order.
     * The attributes must be read from an <code>SQLInput
     * input stream and written to an <code>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 <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    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(null);
        } else {
            /*
             * 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(x, map));
        }
    }

    /**
     * Writes a <code>Ref object in the Java programming language
     * to this <code>SQLOutputImpl object.  The driver converts
     * it to a serializable <code>SerialRef SQL REF value
     * before returning it to the database.
     *
     * @param x an object representing an SQL <code>REF value
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeRef(Ref x) throws SQLException {
        if (x == null) {
            attribs.add(null);
        } else {
            attribs.add(new SerialRef(x));
        }
    }

    /**
     * Writes a <code>Blob object in the Java programming language
     * to this <code>SQLOutputImpl object.  The driver converts
     * it to a serializable <code>SerialBlob SQL BLOB value
     * before returning it to the database.
     *
     * @param x an object representing an SQL <code>BLOB value
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeBlob(Blob x) throws SQLException {
        if (x == null) {
            attribs.add(null);
        } else {
            attribs.add(new SerialBlob(x));
        }
    }

    /**
     * Writes a <code>Clob object in the Java programming language
     * to this <code>SQLOutputImpl object.  The driver converts
     * it to a serializable <code>SerialClob SQL CLOB value
     * before returning it to the database.
     *
     * @param x an object representing an SQL <code>CLOB value
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeClob(Clob x) throws SQLException {
        if (x == null) {
            attribs.add(null);
        } else {
            attribs.add(new SerialClob(x));
        }
    }

    /**
     * Writes a <code>Struct object in the Java
     * programming language to this <code>SQLOutputImpl
     * object. The driver converts this value to an SQL structured type
     * before returning it to the database.
     * <P>
     * This method should be used when an SQL structured type has been
     * mapped to a <code>Struct object in the Java programming
     * language (the standard mapping).  The method
     * <code>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 <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeStruct(Struct x) throws SQLException {
        SerialStruct s = new SerialStruct(x,map);;
        attribs.add(s);
    }

    /**
     * Writes an <code>Array object in the Java
     * programming language to this <code>SQLOutputImpl
     * object. The driver converts this value to a serializable
     * <code>SerialArray SQL ARRAY
     * value before returning it to the database.
     *
     * @param x an object representing an SQL <code>ARRAY value
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeArray(Array x) throws SQLException {
        if (x == null) {
            attribs.add(null);
        } else {
            attribs.add(new SerialArray(x, map));
        }
    }

    /**
     * Writes an <code>java.sql.Type.DATALINK object in the Java
     * programming language to this <code>SQLOutputImpl object. The
     * driver converts this value to a serializable <code>SerialDatalink
     * SQL <code>DATALINK value before return it to the database.
     *
     * @param url an object representing a SQL <code>DATALINK value
     * @throws SQLException if the <code>SQLOutputImpl object is in
     *        use by a <code>SQLData object attempting to write the attribute
     *        values of a UDT to the database.
     */
    @SuppressWarnings("unchecked")
    public void writeURL(java.net.URL url) throws SQLException {
        if (url == null) {
            attribs.add(null);
        } else {
            attribs.add(new SerialDatalink(url));
        }
    }


  /**
   * Writes the next attribute to the stream as a <code>String
   * in the Java programming language. The driver converts this to a
   * SQL <code>NCHAR or
   * <code>NVARCHAR or LONGNVARCHAR value
   * (depending on the argument's
   * size relative to the driver's limits on <code>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
   */
   @SuppressWarnings("unchecked")
   public void writeNString(String x) throws SQLException {
       attribs.add(x);
   }

  /**
   * Writes an SQL <code>NCLOB value to the stream.
   *
   * @param x a <code>NClob object representing data of an SQL
   * <code>NCLOB value
   *
   * @exception SQLException if a database access error occurs
   * @since 1.6
   */
   @SuppressWarnings("unchecked")
   public void writeNClob(NClob x) throws SQLException {
           attribs.add(x);
   }


  /**
   * Writes an SQL <code>ROWID value to the stream.
   *
   * @param x a <code>RowId object representing data of an SQL
   * <code>ROWID value
   *
   * @exception SQLException if a database access error occurs
   * @since 1.6
   */
   @SuppressWarnings("unchecked")
   public void writeRowId(RowId x) throws SQLException {
        attribs.add(x);
   }


  /**
   * Writes an SQL <code>XML value to the stream.
   *
   * @param x a <code>SQLXML object representing data of an SQL
   * <code>XML value
   *
   * @exception SQLException if a database access error occurs
   * @since 1.6
   */
   @SuppressWarnings("unchecked")
   public void writeSQLXML(SQLXML x) throws SQLException {
        attribs.add(x);
    }

}