com.informix.jdbc
Interface IfmxPreparedStatement

All Superinterfaces:
java.sql.PreparedStatement, java.sql.Statement

public interface IfmxPreparedStatement
extends java.sql.PreparedStatement

The IfmxPreparedStatement interface contains Informix extensions to the standard JDBC PreparedStatement interface.

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

Field Summary
 
Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
 
Method Summary
 void clearBindColType()
          Reset the values set by calling setBindColType()
 java.sql.ResultSet executeQuery(boolean withHold)
          An Informix executeQuery() extension to specify whether the result should be a HOLD ResultSet (cursor) or not.
 void IfxSetObject(int i, java.lang.Object x, int ifxType)
          This method is the same as the setObject() method, except that the driver converts the object to the given IfxType when sending it to the database.
 void IfxSetObject(int i, java.lang.Object x, int scale, int ifxType)
          This method is the same as the setObject() method, except that the driver converts the object to the given IfxType when sending it to the database.
 void setArray(int i, java.sql.Array x, int ifxType)
          Sets an Array parameter.
 void setAsciiStream(int i, java.io.InputStream x, int length, int ifxType)
          When a very large ASCII value is inserted into to a LONGVARCHAR column, it may be more practical to send the ASCII value via a java.io.InputStream.
 void setBigDecimal(int i, java.math.BigDecimal x, int ifxType)
          Sets a parameter to a java.lang.BigDecimal value.
 void setBinaryStream(int i, java.io.InputStream x, int length, int ifxType)
          When a very large binary value is inserted into a LONGVARBINARY column, it may be more practical to send the binary value via a java.io.InputStream.
 void setBindColIfxType(int colIndex, int ifxtype)
          Similar to setBindColType(), but used when application wants to use Informix SQL types in it's parameter call.
 void setBindColIfxType(int colIndex, int ifxtype, int scale)
          Allows applications to specify the output type to be IFX_TYPE_DECIMAL, IFX_TYPE_MONEY so that the server can cast to that type before returning to the client.
 void setBindColIfxType(int colIndex, int ifxtype, java.lang.String name)
          Allows applications to specify the output type to be IFX_TYPE_LIST, IFX_TYPE_ROW, IFX_TYPE_MULTISET, IFX_TYPE_SET, IFX_TYPE_UDTVAR, IFX_TYPE_UDTFIXED so that the server can cast to that type before returning to the client.
 void setBindColType(int colIndex, int sqltype)
          Allows applications to specify the output type of the resultset values so that the server can cast to that type before returning to the client.
 void setBindColType(int colIndex, int sqltype, int scale)
          Allows applications to specify the output type to be java.sql.DECIMAL or java.sql.NUMERIC, so that the server can cast to that type before returning to the client.
 void setBindColType(int colIndex, int sqltype, java.lang.String name)
          Allows applications to specify the output type to be java.sql.STRUCT, java.sql.ARRAY, java.sql.DISTINCT, and java.sql.JAVA_OBJECT so that the server can cast to that type before returning to the client.
 void setBlob(int i, java.sql.Blob x, int ifxType)
          Sets a BLOB parameter.
 void setBoolean(int i, boolean x, int ifxType)
          Sets a parameter to a Java boolean value.
 void setByte(int i, byte x, int ifxType)
          Sets a parameter to a Java byte value.
 void setBytes(int i, byte[] x, int ifxType)
          Sets a parameter to a Java array of bytes.
 void setCharacterStream(int i, java.io.Reader x, int length, int ifxType)
          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.
 void setClob(int i, java.sql.Clob x, int ifxType)
          Sets a CLOB parameter.
 void setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal, int ifxType)
          Sets a parameter to a java.sql.Date value.
 void setDate(int i, java.sql.Date x, int ifxType)
          Sets a parameter to a java.sql.Date value.
 void setDouble(int i, double x, int ifxType)
          Sets a parameter to a Java double value.
 void setFloat(int i, float x, int ifxType)
          Sets a parameter to a Java float value.
 void setInt(int i, int x, int ifxType)
          Sets a parameter to a Java int value.
 void setInterval(int i, Interval x)
          Sets a parameter to an Interval value.
 void setIntervalDF(int i, IntervalDF x)
          Sets a parameter to an IntervalDF value.
 void setIntervalYM(int i, IntervalYM x)
          Sets a parameter to an IntervalYM value.
 void setLong(int i, long x, int ifxType)
          Sets a parameter to a Java long value.
 void setNull(int i, int sqlType, int ifxType)
          Sets a parameter to SQL NULL.
 void setShort(int i, short x, int ifxType)
          Sets a parameter to a Java short value.
 void setString(int i, java.lang.String x, int ifxType)
          Sets a parameter to a Java String value.
 void setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal, int ifxType)
          Sets a parameter to a java.sql.Time value.
 void setTime(int i, java.sql.Time x, int ifxType)
          Sets a parameter to a java.sql.Time value.
 void setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal, int ifxType)
          Sets a parameter to a java.sql.Timestamp value.
 void setTimestamp(int i, java.sql.Timestamp x, int ifxType)
          Sets a parameter to a java.sql.Timestamp value.
 
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
 
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

Method Detail

executeQuery

public java.sql.ResultSet executeQuery(boolean withHold)
                                throws java.sql.SQLException
An Informix executeQuery() extension to specify whether the result should be a HOLD ResultSet (cursor) or not.

Parameters:
withHold - Specifies whether the ResultSet is a HOLD cursor
Returns:
A ResultSet that contains the data produced by the query
Throws:
java.sql.SQLException

setNull

public void setNull(int i,
                    int sqlType,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to SQL NULL.

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

Parameters:
i - The first parameter is 1, the second is 2, and so on.
sqlType - The SQL type code defined by java.sql.Types.
ifxType - The Informix SQL data type defined in the IfxTypes class.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setBigDecimal

public void setBigDecimal(int i,
                          java.math.BigDecimal x,
                          int ifxType)
                   throws java.sql.SQLException
Sets a parameter to a java.lang.BigDecimal value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setBoolean

public void setBoolean(int i,
                       boolean x,
                       int ifxType)
                throws java.sql.SQLException
Sets a parameter to a Java boolean value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setByte

public void setByte(int i,
                    byte x,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to a Java byte value. The driver converts this to the given Ifxtype when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setShort

public void setShort(int i,
                     short x,
                     int ifxType)
              throws java.sql.SQLException
Sets a parameter to a Java short value. The driver converts this to the given Ifxtype when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setInt

public void setInt(int i,
                   int x,
                   int ifxType)
            throws java.sql.SQLException
Sets a parameter to a Java int value. The driver converts this to the given IfxType value when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setLong

public void setLong(int i,
                    long x,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to a Java long value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setFloat

public void setFloat(int i,
                     float x,
                     int ifxType)
              throws java.sql.SQLException
Sets a parameter to a Java float value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setDouble

public void setDouble(int i,
                      double x,
                      int ifxType)
               throws java.sql.SQLException
Sets a parameter to a Java double value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setString

public void setString(int i,
                      java.lang.String x,
                      int ifxType)
               throws java.sql.SQLException
Sets a parameter to a Java String value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setBytes

public void setBytes(int i,
                     byte[] x,
                     int ifxType)
              throws java.sql.SQLException
Sets a parameter to a Java array of bytes. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setDate

public void setDate(int i,
                    java.sql.Date x,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to a java.sql.Date value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setTime

public void setTime(int i,
                    java.sql.Time x,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to a java.sql.Time value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setTimestamp

public void setTimestamp(int i,
                         java.sql.Timestamp x,
                         int ifxType)
                  throws java.sql.SQLException
Sets a parameter to a java.sql.Timestamp value. The driver converts this parameter to the given IfxType when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setAsciiStream

public void setAsciiStream(int i,
                           java.io.InputStream x,
                           int length,
                           int ifxType)
                    throws java.sql.SQLException
When a very large ASCII value is inserted into to a LONGVARCHAR column, it may be more practical to send the ASCII value via a java.io.InputStream. The JDBC driver reads the data from the stream as needed until it reaches the end-of-file. The JDBC driver does any necessary conversion from ASCII to the given ifxType, if applicable, when sending to the database.

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

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The java input stream that contains the ASCII value.
length - The number of bytes in the stream.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setBinaryStream

public void setBinaryStream(int i,
                            java.io.InputStream x,
                            int length,
                            int ifxType)
                     throws java.sql.SQLException
When a very large binary value is inserted into a LONGVARBINARY column, it may be more practical to send the binary value via a java.io.InputStream. The JDBC driver reads the data from the stream as needed until it reaches the end-of-file. The driver converts to the given ifxType, if applicable, when sending to the database.

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

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The java input stream that contains the binary value.
length - The number of bytes in the stream.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setCharacterStream

public void setCharacterStream(int i,
                               java.io.Reader x,
                               int length,
                               int ifxType)
                        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.Reader. 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.

Parameters:
x - the java reader which contains the UNICODE data
length - the number of characters in the stream
ifxType - the Informix type to bind as
Throws:
java.sql.SQLException - if a database-access error occurs.

setInterval

public void setInterval(int i,
                        Interval x)
                 throws java.sql.SQLException
Sets a parameter to an Interval value. The driver converts this to an Informix Interval value when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
Throws:
java.sql.SQLException

setIntervalYM

public void setIntervalYM(int i,
                          IntervalYM x)
                   throws java.sql.SQLException
Sets a parameter to an IntervalYM value. The driver converts this to an Informix Interval value when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
Throws:
java.sql.SQLException

setIntervalDF

public void setIntervalDF(int i,
                          IntervalDF x)
                   throws java.sql.SQLException
Sets a parameter to an IntervalDF value. The driver converts this to an Informix Interval value when it sends the value to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
Throws:
java.sql.SQLException

IfxSetObject

public void IfxSetObject(int i,
                         java.lang.Object x,
                         int scale,
                         int ifxType)
                  throws java.sql.SQLException

This method is the same as the setObject() method, except that the driver converts the object to the given IfxType when sending it to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The object containing the input parameter value.
scale - For java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, the number of digits after the decimal. For all other types, this value is ignored.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

IfxSetObject

public void IfxSetObject(int i,
                         java.lang.Object x,
                         int ifxType)
                  throws java.sql.SQLException

This method is the same as the setObject() method, except that the driver converts the object to the given IfxType when sending it to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - The object containing the input parameter value.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setBlob

public void setBlob(int i,
                    java.sql.Blob x,
                    int ifxType)
             throws java.sql.SQLException
Sets a BLOB parameter. The driver converts the parameter to the given IfxType when sending it to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - An object representing a BLOB.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setClob

public void setClob(int i,
                    java.sql.Clob x,
                    int ifxType)
             throws java.sql.SQLException
Sets a CLOB parameter. The driver converts the parameter to the given IfxType when sending it to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - An object representing a CLOB.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setArray

public void setArray(int i,
                     java.sql.Array x,
                     int ifxType)
              throws java.sql.SQLException
Sets an Array parameter. The driver converts the parameter to the given IfxType when sending it to the database.

Parameters:
i - The first parameter is 1, the second is 2, and so on.
x - An object representing an SQL array.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setTime

public void setTime(int parameterIndex,
                    java.sql.Time x,
                    java.util.Calendar cal,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to a java.sql.Time value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
parameterIndex - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
cal - The calendar object the driver uses to construct the time.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x,
                    java.util.Calendar cal,
                    int ifxType)
             throws java.sql.SQLException
Sets a parameter to a java.sql.Date value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
parameterIndex - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
cal - The calendar object the driver uses to construct the date.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setTimestamp

public void setTimestamp(int parameterIndex,
                         java.sql.Timestamp x,
                         java.util.Calendar cal,
                         int ifxType)
                  throws java.sql.SQLException
Sets a parameter to a java.sql.Timestamp value. The driver converts this to the given IfxType when it sends the value to the database.

Parameters:
parameterIndex - The first parameter is 1, the second is 2, and so on.
x - The parameter value.
cal - The calendar object the driver uses to construct the timestamp.
ifxType - The Informix type to bind as.
Throws:
java.sql.SQLException
See Also:
IfxTypes

setBindColType

public void setBindColType(int colIndex,
                           int sqltype)
                    throws java.sql.SQLException
Allows applications to specify the output type of the resultset values so that the server can cast to that type before returning to the client. This method is used when the user wants to use JAVA SQL types in it's parameter call.

Parameters:
colIndex - the first parameter is 1, the second is 2, ...
sqltype - the server should cast to.
Throws:
java.sql.SQLException

setBindColIfxType

public void setBindColIfxType(int colIndex,
                              int ifxtype)
                       throws java.sql.SQLException
Similar to setBindColType(), but used when application wants to use Informix SQL types in it's parameter call. Allows applications to specify the output type of the resultset values so that the server can cast to that type before returning to the client.

Parameters:
colIndex - the first parameter is 1, the second is 2, ...
ifxtype - the server should cast to.
Throws:
java.sql.SQLException

setBindColType

public void setBindColType(int colIndex,
                           int sqltype,
                           int scale)
                    throws java.sql.SQLException
Allows applications to specify the output type to be java.sql.DECIMAL or java.sql.NUMERIC, so that the server can cast to that type before returning to the client.

Parameters:
colIndex - the first parameter is 1, the second is 2, ...
sqltype - the server should cast to.
scale - - Java specific scale - not used by Informix
Throws:
java.sql.SQLException

setBindColIfxType

public void setBindColIfxType(int colIndex,
                              int ifxtype,
                              int scale)
                       throws java.sql.SQLException
Allows applications to specify the output type to be IFX_TYPE_DECIMAL, IFX_TYPE_MONEY so that the server can cast to that type before returning to the client.

Parameters:
colIndex - the first parameter is 1, the second is 2, ...
ifxtype - the server should cast to.
scale - - Informix specific encoded length
Throws:
java.sql.SQLException

setBindColType

public void setBindColType(int colIndex,
                           int sqltype,
                           java.lang.String name)
                    throws java.sql.SQLException
Allows applications to specify the output type to be java.sql.STRUCT, java.sql.ARRAY, java.sql.DISTINCT, and java.sql.JAVA_OBJECT so that the server can cast to that type before returning to the client.

Parameters:
colIndex - the first parameter is 1, the second is 2, ...
sqltype - the server should cast to.
name - indicates the string representation of the UDT or complex type
Throws:
java.sql.SQLException

setBindColIfxType

public void setBindColIfxType(int colIndex,
                              int ifxtype,
                              java.lang.String name)
                       throws java.sql.SQLException
Allows applications to specify the output type to be IFX_TYPE_LIST, IFX_TYPE_ROW, IFX_TYPE_MULTISET, IFX_TYPE_SET, IFX_TYPE_UDTVAR, IFX_TYPE_UDTFIXED so that the server can cast to that type before returning to the client.

Parameters:
colIndex - the first parameter is 1, the second is 2, ...
ifxtype - the server should cast to.
name - indicates the string representation of the UDT or complex type
Throws:
java.sql.SQLException

clearBindColType

public void clearBindColType()
                      throws java.sql.SQLException
Reset the values set by calling setBindColType()

Throws:
java.sql.SQLException