vortex.sql
Class vortexPreparedStatement

java.lang.Object
  |
  +--vortex.sql.vortexStatement
        |
        +--vortex.sql.vortexPreparedStatement
Direct Known Subclasses:
vortexCallableStatement
public class vortexPreparedStatement
extends vortexStatement
implements java.sql.PreparedStatement

A SQL statement is pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

Note: The setXXX methods for setting IN parameter values must specify types that are compatible with the defined SQL type of the input parameter. For instance, if the IN parameter has SQL type Integer then setInt should be used.

If arbitrary parameter type conversions are required then the setObject method should be used with a target SQL type.

See Also:
Connection.prepareStatement(java.lang.String), ResultSet

Field Summary
protected  int npa
          Number of Parameters
 
Fields inherited from class vortex.sql.vortexStatement
cName, conn, lcur, ldb, record, result
 
Constructor Summary
vortexPreparedStatement()
           
vortexPreparedStatement(java.sql.Connection c, dbChannel db, java.lang.String sql)
           
 
Method Summary
 void clearParameters()
          In general parameter values remain in force for repeated use of a Statement.
 boolean execute()
          Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate.
 java.sql.ResultSet executeQuery()
          A prepared SQL query is executed and its ResultSet is returned.
 int executeUpdate()
          Execute a SQL INSERT, UPDATE or DELETE statement.
 void setAsciiStream(int col, java.io.InputStream x, int length)
          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.
 void setBigDecimal(int col, java.math.BigDecimal x)
          Set a parameter to a java.sql.Numeric value.
 void setBinaryStream(int col, java.io.InputStream x, int length)
          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.
 void setBoolean(int col, boolean x)
          Set a parameter to a Java boolean value.
 void setByte(int col, byte x)
          Set a parameter to a Java byte value.
 void setBytes(int col, byte[] x)
          Set a parameter to a Java array of bytes.
 void setDate(int col, java.sql.Date x)
          Set a parameter to a java.sql.Date value.
 void setDouble(int col, double x)
          Set a parameter to a Java double value.
 void setFloat(int col, float x)
          Set a parameter to a Java float value.
 void setInt(int col, int x)
          Set a parameter to a Java int value.
 void setLong(int col, long x)
          Set a parameter to a Java long value.
 void setNull(int col, int sqlType)
          Set a parameter to SQL NULL.
 void setObject(int col, java.lang.Object x)
          Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.
 void setObject(int col, java.lang.Object x, int targetSqlType)
          This method is like setObject above, but assumes scale of zero.
 void setObject(int col, java.lang.Object x, int targetSqlType, int scale)
          Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.
 void setShort(int col, short x)
          Set a parameter to a Java short value.
 void setString(int col, java.lang.String x)
          Set a parameter to a Java String value.
 void setTime(int col, java.sql.Time x)
          Set a parameter to a java.sql.Time value.
 void setTimestamp(int col, java.sql.Timestamp x)
          Set a parameter to a java.sql.Timestamp value.
 void setUnicodeStream(int col, java.io.InputStream x, int length)
          When a very large UNICODE value is input to a LONGVARCHAR parameter it may be more practical to send it via a java.io.InputStream.
 
Methods inherited from class vortex.sql.vortexStatement
cancel, clearWarnings, close, execute, executeQuery, executeUpdate, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setMaxFieldSize, setMaxRows, setQueryTimeout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

npa

protected int npa
Number of Parameters
Constructor Detail

vortexPreparedStatement

public vortexPreparedStatement(java.sql.Connection c,
                               dbChannel db,
                               java.lang.String sql)
                        throws java.sql.SQLException

vortexPreparedStatement

public vortexPreparedStatement()
                        throws java.sql.SQLException
Method Detail

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException
A prepared SQL query is executed and its ResultSet is returned.
Specified by:
executeQuery in interface java.sql.PreparedStatement
Returns:
a ResultSet that contains the data produced by the query
Throws:
java.sql.SQLException - Not use

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException
Execute a SQL INSERT, UPDATE or DELETE statement. In addition, SQL statements that return nothing such as SQL DDL statements can be executed.
Specified by:
executeUpdate in interface java.sql.PreparedStatement
Returns:
either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing
Throws:
java.sql.SQLException - thrown if DB actions fail.

setNull

public void setNull(int col,
                    int sqlType)
             throws java.sql.SQLException
Set a parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

Specified by:
setNull in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
sqlType - SQL type code defined by java.sql.Types
Throws:
java.sql.SQLException - thrown if column out of range

setBoolean

public void setBoolean(int col,
                       boolean x)
                throws java.sql.SQLException
Set a parameter to a Java boolean value. The driver converts this to a SQL BIT value when it sends it to the database.
Specified by:
setBoolean in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setByte

public void setByte(int col,
                    byte x)
             throws java.sql.SQLException
Set a parameter to a Java byte value. The driver converts this to a SQL TINYINT value when it sends it to the database.
Specified by:
setByte in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setShort

public void setShort(int col,
                     short x)
              throws java.sql.SQLException
Set a parameter to a Java short value. The driver converts this to a SQL SMALLINT value when it sends it to the database.
Specified by:
setShort in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setInt

public void setInt(int col,
                   int x)
            throws java.sql.SQLException
Set a parameter to a Java int value. The driver converts this to a SQL INTEGER value when it sends it to the database.
Specified by:
setInt in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setLong

public void setLong(int col,
                    long x)
             throws java.sql.SQLException
Set a parameter to a Java long value. The driver converts this to a SQL BIGINT value when it sends it to the database.
Specified by:
setLong in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setFloat

public void setFloat(int col,
                     float x)
              throws java.sql.SQLException
Set a parameter to a Java float value. The driver converts this to a SQL FLOAT value when it sends it to the database.
Specified by:
setFloat in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setDouble

public void setDouble(int col,
                      double x)
               throws java.sql.SQLException
Set a parameter to a Java double value. The driver converts this to a SQL DOUBLE value when it sends it to the database.
Specified by:
setDouble in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setBigDecimal

public void setBigDecimal(int col,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException
Set a parameter to a java.sql.Numeric value. VORTEXjdbc converts this to a character string value when it sends it to the database.
Specified by:
setBigDecimal in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setString

public void setString(int col,
                      java.lang.String x)
               throws java.sql.SQLException
Set a parameter to a Java String value. The driver converts this to a SQL VARCHAR or LONGVARCHAR value (depending on the arguments size relative to the driver's limits on VARCHARs) when it sends it to the database.
Specified by:
setString in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setBytes

public void setBytes(int col,
                     byte[] x)
              throws java.sql.SQLException
Set a parameter to a Java array of bytes. The driver converts this to a SQL VARBINARY or LONGVARBINARY (depending on the arguments size relative to the driver's limits on VARBINARYs) when it sends
Specified by:
setBytes in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setDate

public void setDate(int col,
                    java.sql.Date x)
             throws java.sql.SQLException
Set a parameter to a java.sql.Date value. The driver converts this to a SQL DATE value when it sends it to the database.
Specified by:
setDate in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setTime

public void setTime(int col,
                    java.sql.Time x)
             throws java.sql.SQLException
Set a parameter to a java.sql.Time value. The driver converts this to a SQL TIME value when it sends it to the database.
Specified by:
setTime in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setTimestamp

public void setTimestamp(int col,
                         java.sql.Timestamp x)
                  throws java.sql.SQLException
Set a parameter to a java.sql.Timestamp value. The driver converts this to a SQL VARCHAR value when it sends it to the database.
Specified by:
setTimestamp in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the parameter value
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setAsciiStream

public void setAsciiStream(int col,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException
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. JDBC will read the data from the stream as needed, until it reaches end-of-file. 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.

Specified by:
setAsciiStream in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the java input stream which contains the ASCII parameter value
length - the number of bytes in the stream
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setUnicodeStream

public void setUnicodeStream(int col,
                             java.io.InputStream x,
                             int length)
                      throws java.sql.SQLException
When a very large UNICODE value is input to a LONGVARCHAR parameter it may be more practical to send it via a java.io.InputStream. JDBC will read the data from the stream as needed, until it reaches end-of-file. 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.

Specified by:
setUnicodeStream in interface java.sql.PreparedStatement
Parameters:
col - the first parameter is 1, the second is 2, ...
x - the java input stream which contains the UNICODE parameter value @param length the number of bytes in the stream
Throws:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

setBinaryStream

public void setBinaryStream(int col,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException
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. JDBC will read the data from the stream as needed, until it reaches end-of-file.

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

Specified by:
setBinaryStream in interface java.sql.PreparedStatement
Parameters:
col - 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:
java.sql.SQLException - thrown if column out of range or unable to bind parameter

clearParameters

public void clearParameters()
                     throws java.sql.SQLException
In general parameter values remain in force for repeated use of a Statement. Setting a parameter value automatically clears its previous value. However In some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling clearParameters.
Specified by:
clearParameters in interface java.sql.PreparedStatement
Throws:
java.sql.SQLException - thrown if column out of range

setObject

public void setObject(int col,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException
Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

The given Java object will be converted to the targetSqlType before being sent to the database.

Note that this method may be used to pass datatabase specific abstract data types, by using a Driver specific Java type and using a targetSqlType of java.sql.types.OTHER.

Specified by:
setObject in interface java.sql.PreparedStatement
Parameters:
col - The first parameter is 1, the second is 2, ...
x - The object containing the input parameter value
targetSqlType - The SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
scale - For java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types this is the number of digits after the decimal. For all other types this value will be ignored,
Throws:
java.sql.SQLException - if object is not supported
See Also:
java.sql.Types

setObject

public void setObject(int col,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException
This method is like setObject above, but assumes scale of zero.
Specified by:
setObject in interface java.sql.PreparedStatement
Parameters:
col - The first parameter is 1, the second is 2, ...
x - The object containing the input parameter value
targetSqlType - The SQL type (as defined in java.sql.Types) to be sent to the database.
Throws:
java.sql.SQLException - if object not supported

setObject

public void setObject(int col,
                      java.lang.Object x)
               throws java.sql.SQLException
Set the value of a parameter using an object; use the java.lang equivalent objects for integral values.

The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument java object will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass database specific abstract data types, by using a Driver specific Java type.

Specified by:
setObject in interface java.sql.PreparedStatement
Parameters:
col - The first parameter is 1, the second is 2, ...
x - The object containing the input parameter value
Throws:
java.sql.SQLException - if object is not supported

execute

public boolean execute()
                throws java.sql.SQLException
Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate.
Specified by:
execute in interface java.sql.PreparedStatement
Throws:
java.sql.SQLException - threw
See Also:
Statement.execute(java.lang.String)