oracle.ifs.server.sql
Class IfsPreparedStatement

java.lang.Object
  |
  +--oracle.ifs.server.sql.IfsStatement
        |
        +--oracle.ifs.server.sql.IfsPreparedStatement

Direct Known Subclasses:

IfsCallableStatement

public class IfsPreparedStatement

extends IfsStatement

A SQL statement is pre-compiled and stored in an IfsPreparedStatement 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:

IfsConnection.prepareStatement(java.lang.String)

Constructor Summary

IfsPreparedStatement(java.sql.PreparedStatement pstmt, IfsConnection iconn)
Construct an IfsPreparedStatement object.

Method Summary

void	clearParameters() In general, parameter values remain in force for repeated use of a Statement.
void	dispose() Dispose and close the IfsPreparedStatement.
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 parameterIndex, 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 parameterIndex, java.math.BigDecimal x) Set a parameter to a java.lang.BigDecimal value.
void	setBinaryStream(int parameterIndex, 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 parameterIndex, boolean x) Set a parameter to a Java boolean value.
void	setByte(int parameterIndex, byte x) Set a parameter to a Java byte value.
void	setBytes(int parameterIndex, byte[] x) Set a parameter to a Java array of bytes.
void	setDate(int parameterIndex, java.sql.Date x) Set a parameter to a Date value.
void	setDouble(int parameterIndex, double x) Set a parameter to a Java double value.
void	setFloat(int parameterIndex, float x) Set a parameter to a Java float value.
void	setInt(int parameterIndex, int x) Set a parameter to a Java int value.
void	setLong(int parameterIndex, long x) Set a parameter to a Java long value.
void	setNull(int parameterIndex, int sqlType) Set a parameter to SQL NULL.
void	setObject(int parameterIndex, 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 parameterIndex, java.lang.Object x, int targetSqlType) This method is like setObject above, but assumes a scale of zero.
void	setObject(int parameterIndex, 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 parameterIndex, short x) Set a parameter to a Java short value.
void	setString(int parameterIndex, java.lang.String x) Set a parameter to a Java String value.
void	setTime(int parameterIndex, java.sql.Time x) Set a parameter to a Time value.
void	setTimestamp(int parameterIndex, java.sql.Timestamp x) Set a parameter to a Timestamp value.
void	setUnicodeStream(int parameterIndex, 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 oracle.ifs.server.sql.IfsStatement

cancel, clearWarnings, close, execute, executeQuery, executeUpdate, getMaxFieldSize, getMaxRows, getMoreResults, getQueryTimeout, getResultSet, getSession, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setMaxFieldSize, setMaxRows, setQueryTimeout

Constructor Detail

IfsPreparedStatement

public IfsPreparedStatement(java.sql.PreparedStatement pstmt,
                            IfsConnection iconn)

Construct an IfsPreparedStatement object. Encapsulates java.sql.PreparedStatement. IfsConnection.prepareStatement(String) should be used to get an IfsPreparedStatement object.

Parameters:

pstmt - instance of PreparedStatement

iconn - iFS version of Connection

Method Detail

executeQuery

public java.sql.ResultSet executeQuery()
                                throws java.sql.SQLException

A prepared SQL query is executed and its ResultSet is returned.

Returns:

a ResultSet that contains the data produced by the query; never null

Throws:

java.sql.SQLException - if a database-access error occurs.

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Execute a SQL INSERT, UPDATE or DELETE statement. Although SQL DDL statements can be executed, it is not advised since doing so can cause the iFS repository to be non-functional or irreparable.

Returns:

either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing

Throws:

java.sql.SQLException - if a database-access error occurs.

setNull

public void setNull(int parameterIndex,
                    int sqlType)
             throws java.sql.SQLException

Set a parameter to SQL NULL.

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

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

sqlType - SQL type code defined by Types

Throws:

java.sql.SQLException - if a database-access error occurs.

setBoolean

public void setBoolean(int parameterIndex,
                       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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setByte

public void setByte(int parameterIndex,
                    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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setShort

public void setShort(int parameterIndex,
                     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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setInt

public void setInt(int parameterIndex,
                   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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setLong

public void setLong(int parameterIndex,
                    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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setFloat

public void setFloat(int parameterIndex,
                     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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setDouble

public void setDouble(int parameterIndex,
                      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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException

Set a parameter to a java.lang.BigDecimal value. The driver converts this to a SQL NUMERIC value when it sends it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setString

public void setString(int parameterIndex,
                      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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setBytes

public void setBytes(int parameterIndex,
                     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 argument's size relative to the driver's limits on VARBINARYs) when it sends it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setDate

public void setDate(int parameterIndex,
                    java.sql.Date x)
             throws java.sql.SQLException

Set a parameter to a Date value. The driver converts this to a SQL DATE value when it sends it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setTime

public void setTime(int parameterIndex,
                    java.sql.Time x)
             throws java.sql.SQLException

Set a parameter to a Time value. The driver converts this to a SQL TIME value when it sends it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setTimestamp

public void setTimestamp(int parameterIndex,
                         java.sql.Timestamp x)
                  throws java.sql.SQLException

Set a parameter to a Timestamp value. The driver converts this to a SQL TIMESTAMP value when it sends it to the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           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.

Parameters:

parameterIndex - 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 - if a database-access error occurs.

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

x - the java input stream which contains the UNICODE parameter value

length - the number of bytes in the stream

Throws:

java.sql.SQLException - if a database-access error occurs.

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            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.

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:

java.sql.SQLException - if a database-access error occurs.

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.

Throws:

java.sql.SQLException - if a database-access error occurs.

setObject

public void setObject(int parameterIndex,
                      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. This is done by using a Driver- specific Java type and using a targetSqlType of java.sql.types.OTHER.

Parameters:

parameterIndex - 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 a database-access error occurs.

setObject

public void setObject(int parameterIndex,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException

This method is like setObject above, but assumes a scale of zero.

Throws:

java.sql.SQLException - if a database-access error occurs.

setObject

public void setObject(int parameterIndex,
                      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 datatabase specific abstract data types, by using a Driver specific Java type.

Parameters:

parameterIndex - The first parameter is 1, the second is 2, ...

x - The object containing the input parameter value

Throws:

java.sql.SQLException - if a database-access error occurs.

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.

Throws:

java.sql.SQLException - if a database-access error occurs.

dispose

public void dispose()

Dispose and close the IfsPreparedStatement.

Overrides:

dispose in class IfsStatement