Class PreparedStatementWrapper40

    • Constructor Detail

      • PreparedStatementWrapper40

        public PreparedStatementWrapper40​(Connection con,
                                          PreparedStatement statement,
                                          boolean statementCaching)
                                   throws SQLException
        Creates a new instance of PreparedStatement Wrapper for JDBC 4.0
        Parameters:
        con - ConnectionWrapper
        statement - PreparedStatement that is wrapped
        statementCaching - boolean that enabled/disables caching
        Throws:
        SQLException - Exception thrown from underlying statement
    • Method Detail

      • setRowId

        public void setRowId​(int parameterIndex,
                             RowId x)
                      throws SQLException
        Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the parameter value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setNString

        public void setNString​(int parameterIndex,
                               String value)
                        throws SQLException
        Sets the designated paramter to the given String object. 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 database.
        Parameters:
        parameterIndex - of the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setNCharacterStream

        public void setNCharacterStream​(int parameterIndex,
                                        Reader value,
                                        long length)
                                 throws SQLException
        Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.
        Parameters:
        parameterIndex - of the first parameter is 1, the second is 2, ...
        value - the parameter value
        length - the number of characters in the parameter data.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setNClob

        public void setNClob​(int parameterIndex,
                             NClob value)
                      throws SQLException
        Sets the designated parameter to a java.sql.NClob object. The driver converts this to a SQL NCLOB value when it sends it to the database.
        Parameters:
        parameterIndex - of the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setClob

        public void setClob​(int parameterIndex,
                            Reader reader,
                            long length)
                     throws SQLException
        Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB
        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        reader - An object that contains the data to set the parameter value to.
        length - the number of characters in the parameter data.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if the length specified is less than zero.
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setBlob

        public void setBlob​(int parameterIndex,
                            InputStream inputStream,
                            long length)
                     throws SQLException
        Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB
        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        inputStream - An object that contains the data to set the parameter value to.
        length - the number of bytes in the parameter data.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement; if the length specified is less than zero or if the number of bytes in the inputstream does not match the specfied length.
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setNClob

        public void setNClob​(int parameterIndex,
                             Reader reader,
                             long length)
                      throws SQLException
        Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB
        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        reader - An object that contains the data to set the parameter value to.
        length - the number of characters in the parameter data.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setSQLXML

        public void setSQLXML​(int parameterIndex,
                              SQLXML xmlObject)
                       throws SQLException
        Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.
        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        xmlObject - a SQLXML object that maps an SQL XML value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setAsciiStream

        public void setAsciiStream​(int parameterIndex,
                                   InputStream x,
                                   long length)
                            throws SQLException
        Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the Java input stream that contains the ASCII parameter value
        length - the number of bytes in the stream
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        Since:
        1.6
      • setBinaryStream

        public void setBinaryStream​(int parameterIndex,
                                    InputStream x,
                                    long length)
                             throws SQLException
        Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the java input stream which contains the binary parameter value
        length - the number of bytes in the stream
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        Since:
        1.6
      • setCharacterStream

        public void setCharacterStream​(int parameterIndex,
                                       Reader reader,
                                       long length)
                                throws SQLException
        Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        reader - the java.io.Reader object that contains the Unicode data
        length - the number of characters in the stream
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        Since:
        1.6
      • setAsciiStream

        public void setAsciiStream​(int parameterIndex,
                                   InputStream x)
                            throws SQLException
        Sets the designated parameter to the given input stream. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the Java input stream that contains the ASCII parameter value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setBinaryStream

        public void setBinaryStream​(int parameterIndex,
                                    InputStream x)
                             throws SQLException
        Sets the designated parameter to the given input stream. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        x - the java input stream which contains the binary parameter value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setCharacterStream

        public void setCharacterStream​(int parameterIndex,
                                       Reader reader)
                                throws SQLException
        Sets the designated parameter to the given Reader object. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter.

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        reader - the java.io.Reader object that contains the Unicode data
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setNCharacterStream

        public void setNCharacterStream​(int parameterIndex,
                                        Reader value)
                                 throws SQLException
        Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

        Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter.

        Parameters:
        parameterIndex - of the first parameter is 1, the second is 2, ...
        value - the parameter value
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setClob

        public void setClob​(int parameterIndex,
                            Reader reader)
                     throws SQLException
        Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter.

        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        reader - An object that contains the data to set the parameter value to.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setBlob

        public void setBlob​(int parameterIndex,
                            InputStream inputStream)
                     throws SQLException
        Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter.

        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        inputStream - An object that contains the data to set the parameter value to.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs; this method is called on a closed PreparedStatement or if parameterIndex does not correspond to a parameter marker in the SQL statement,
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • setNClob

        public void setNClob​(int parameterIndex,
                             Reader reader)
                      throws SQLException
        Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB

        Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter.

        Parameters:
        parameterIndex - index of the first parameter is 1, the second is 2, ...
        reader - An object that contains the data to set the parameter value to.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.6
      • isClosed

        public boolean isClosed()
                         throws SQLException
        Retrieves whether this Statement object has been closed. A Statement is closed if the method close has been called on it, or if it is automatically closed.
        Returns:
        true if this Statement object is closed; false if it is still open
        Throws:
        SQLException - if a database access error occurs
        Since:
        1.6
      • setPoolable

        public void setPoolable​(boolean poolable)
                         throws SQLException
        Requests that a Statement be pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the application wants the statement to be pooled. It is up to the statement pool manager as to whether the hint is used.

        The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.

        By default, a Statement is not poolable when created, and a PreparedStatement and CallableStatement are poolable when created.
        Parameters:
        poolable - requests that the statement be pooled if true and that the statement not be pooled if false
        Throws:
        SQLException - if this method is called on a closed Statement
        Since:
        1.6
      • isPoolable

        public boolean isPoolable()
                           throws SQLException
        Returns a value indicating whether the Statement is poolable or not.
        Returns:
        true if the Statement is poolable; false otherwise
        Throws:
        SQLException - if this method is called on a closed Statement
        Since:
        1.6
        See Also:
        setPoolable(boolean)
      • unwrap

        public <T> T unwrap​(Class<T> iface)
                     throws SQLException
        Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

        If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

        Parameters:
        iface - A Class defining an interface that the result must implement.
        Returns:
        an object that implements the interface. May be a proxy for the actual implementing object.
        Throws:
        SQLException - If no object found that implements the interface
        Since:
        1.6
      • isWrapperFor

        public boolean isWrapperFor​(Class<?> iface)
                             throws SQLException
        Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.
        Parameters:
        iface - a Class defining an interface.
        Returns:
        true if this implements the interface or directly or indirectly wraps an object that does.
        Throws:
        SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
        Since:
        1.6
      • executeQuery

        public ResultSet executeQuery()
                               throws SQLException
        Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
        Returns:
        a ResultSet object that contains the data produced by the query; never null
        Throws:
        SQLException - if a database access error occurs; this method is called on a closed PreparedStatement or the SQL statement does not return a ResultSet object
      • executeQuery

        public ResultSet executeQuery​(String sql)
                               throws SQLException
        Executes the given SQL statement, which returns a single ResultSet object.
        Parameters:
        sql - an SQL statement to be sent to the database, typically a static SQL SELECT statement
        Returns:
        a ResultSet object that contains the data produced by the given query; never null
        Throws:
        SQLException - if a database access error occurs, this method is called on a closed Statement or the given SQL statement produces anything other than a single ResultSet object
      • getGeneratedKeys

        public ResultSet getGeneratedKeys()
                                   throws SQLException
        Retrieves any auto-generated keys created as a result of executing this Statement object. If this Statement object did not generate any keys, an empty ResultSet object is returned.

        Note:If the columns which represent the auto-generated keys were not specified, the JDBC driver implementation will determine the columns which best represent the auto-generated keys.

        Returns:
        a ResultSet object containing the auto-generated key(s) generated by the execution of this Statement object
        Throws:
        SQLException - if a database access error occurs or this method is called on a closed Statement
        SQLFeatureNotSupportedException - if the JDBC driver does not support this method
        Since:
        1.4
      • getResultSet

        public ResultSet getResultSet()
                               throws SQLException
        Retrieves the current result as a ResultSet object. This method should be called only once per result.
        Returns:
        the current result as a ResultSet object or null if the result is an update count or there are no more results
        Throws:
        SQLException - if a database access error occurs or this method is called on a closed Statement
        See Also:
        PreparedStatementWrapper.execute()
      • setObject

        public void setObject​(int parameterIndex,
                              Object parameterValue,
                              SQLType targetSqlType,
                              int scaleOrLength)
                       throws SQLException

        Sets the value of the designated parameter with the given object. .The given Java object will be converted to the given targetSqlType before being sent to the database

        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        parameterValue - the object containing the input parameter value
        targetSqlType - the SQL type to be sent to the database. The scale argument may further qualify this type.
        scaleOrLength - for java.sql.JDBCType.DECIMAL or java.sql.JDBCType.NUMERIC types, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored.
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero
        SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      • setObject

        public void setObject​(int parameterIndex,
                              Object parameterValue,
                              SQLType targetSqlType)
                       throws SQLException
        Sets the value of the designated parameter with the given object.
        Parameters:
        parameterIndex - the first parameter is 1, the second is 2, ...
        parameterValue - the object containing the input parameter value
        targetSqlType - the SQL type to be sent to the database
        Throws:
        SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement
        SQLFeatureNotSupportedException - if the JDBC driver does not support the specified targetSqlType
      • executeLargeUpdate

        public long executeLargeUpdate()
                                throws SQLException
        Executes the SQL statement in this PreparedStatement object, which must be an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement.
        Returns:
        either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
        Throws:
        SQLException - if a database access error occurs; this method is called on a closed PreparedStatement or the SQL statement returns a ResultSet object
        SQLTimeoutException - when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement
        Since:
        1.8