com.orindasoft.pub
Class StatementParameters2

java.lang.Object
  com.orindasoft.pub.StatementParameters2

Direct Known Subclasses:

CallableStatementParameters, DmlStatement

public class StatementParameters2
extends java.lang.Object

A set of parameters for a PreparedStatement or CallableStatement

This class is used to represent IN parameters for a SQL statement or PL/SQL Procedure.

This class supercedes an older class called 'statementParameters.java', which has been retired. JDBCWizard generated code now uses StatementParameters2.java.

Under normal circumstances OrindaBuild users will have no reason to use this class directly - the generated code will use it.

(c) Copyright 2003 - 2012 Orinda Software Ltd

Since:

4.0.1901

Version:

6.0

Author:

Orinda Software

Constructor Summary

StatementParameters2(int howMany, LogInterface theLog)
Create a set of statement Parameters of size howMany.

StatementParameters2(java.lang.String sqlStatement, LogInterface theLog)
Create a set of statement Parameters by counting '?' characters in a SQL statement

Method Summary

void	bindParameters(java.sql.PreparedStatement thePreparedStatement) Bind these parameter to a Prepared Statement.
static void	checkBuild(int pBuild) Return version of this class This menthod is used by generated code to make sure that it's using the right version of com.orindasoft.pub.
void	checkSet() Complain if not all parameters set...
void	clearParameters() Clear our parameter array
java.lang.Object	getParam(int parameterId) Get a parameter
int	getParamCount() Return number of parameters that are null
java.lang.Object[]	getParameters() Get all parameters
java.lang.String	getSignature() Return a String that uniquely identifies a set of parameters.
void	setParam(int parameterId, oracle.sql.BFILE parameterValue) A convenience method to set a BFILE parameter.
void	setParam(int parameterId, java.math.BigDecimal parameterValue) A convenience method to set an double parameter.
void	setParam(int parameterId, oracle.sql.BLOB parameterValue) A convenience method to set a BLOB parameter.
void	setParam(int parameterId, boolean parameterValue) A convenience method to set a boolean parameter.
void	setParam(int parameterId, java.lang.Boolean parameterValue) A convenience method to set a boolean parameter.
void	setParam(int parameterId, java.io.BufferedInputStream parameterValue, int fileSize, int dataType) A convenience method to set a BufferedInputStream parameter.
void	setParam(int parameterId, byte parameterValue) A convenience method to set an byte parameter.
void	setParam(int parameterId, java.lang.Byte parameterValue) A convenience method to set an byte parameter.
void	setParam(int parameterId, byte[] parameterValue) A convenience method to set an byte[] parameter.
void	setParam(int parameterId, oracle.sql.CLOB parameterValue) A convenience method to set a CLOB parameter.
void	setParam(int parameterId, java.sql.Date parameterValue) Set a parameter.
void	setParam(int parameterId, java.util.Date parameterValue) Set a parameter
void	setParam(int parameterId, double parameterValue) A convenience method to set an double parameter.
void	setParam(int parameterId, java.lang.Double parameterValue) A convenience method to set an double parameter.
void	setParam(int parameterId, java.io.File parameterValue) A convenience method to set an File parameter.
void	setParam(int parameterId, float parameterValue) A convenience method to set an float parameter.
void	setParam(int parameterId, java.lang.Float parameterValue) A convenience method to set an float parameter.
void	setParam(int parameterId, java.io.InputStream parameterValue, int fileSize, int dataType) A convenience method to set an InputStream parameter.
void	setParam(int parameterId, int parameterValue) A convenience method to set an int parameter.
void	setParam(int parameterId, java.lang.Integer parameterValue) A convenience method to set an int parameter.
void	setParam(int parameterId, oracle.sql.INTERVALYM parameterValue) Set a parameter
void	setParam(int parameterId, long parameterValue) A convenience method to set an long parameter.
void	setParam(int parameterId, java.lang.Long parameterValue) A convenience method to set an long parameter.
void	setParam(int parameterId, ReadOnlyRowSet parameterValue) A convenience method to set a ReadOnlyRowSet parameter.
void	setParam(int parameterId, oracle.sql.ROWID parameterValue) Set a parameter
void	setParam(int parameterId, short parameterValue) A convenience method to set an short parameter.
void	setParam(int parameterId, java.lang.Short parameterValue) A convenience method to set an short parameter.
void	setParam(int parameterId, java.lang.String parameterValue) Set a parameter
void	setParam(int parameterId, java.sql.Timestamp parameterValue) Set a parameter
void	setParam(int parameterId, oracle.sql.TIMESTAMP parameterValue) Set a parameter
void	setParam(int parameterId, oracle.sql.TIMESTAMPLTZ parameterValue) Set a parameter
void	setParam(int parameterId, oracle.sql.TIMESTAMPTZ parameterValue) Set a parameter
void	setPlSqlTableArrayParam(int parameterId, java.lang.Object parameterValue) /** Set an Array parameter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatementParameters2

public StatementParameters2(int howMany,
                            LogInterface theLog)

Create a set of statement Parameters of size howMany.

Parameters:

int - howMany The number of parameters the statement requires.

StatementParameters2

public StatementParameters2(java.lang.String sqlStatement,
                            LogInterface theLog)

Create a set of statement Parameters by counting '?' characters in a SQL statement

Parameters:

String - sqlStatement The statement that we will be working with

Method Detail

getParamCount

public int getParamCount()

Return number of parameters that are null

Returns:

The number of parameters in this statement.

clearParameters

public void clearParameters()

Clear our parameter array

setParam

public void setParam(int parameterId,
                     java.sql.Timestamp parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

java.sql.Timestamp - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.ROWID parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.ROWID - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.TIMESTAMP parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.TIMESTAMP - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.TIMESTAMPTZ parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.TIMESTAMPTZ - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.TIMESTAMPLTZ parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.TIMESTAMPLTZ - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.INTERVALYM parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.INTERVALYM - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setPlSqlTableArrayParam

public void setPlSqlTableArrayParam(int parameterId,
                                    java.lang.Object parameterValue)
                             throws CSException

/** Set an Array parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Object - parametervalue

Throws:

CSException - if parameterId is not a valid parameter.

Since:

Oracle 9.0.1

setParam

public void setParam(int parameterId,
                     java.sql.Date parameterValue)
              throws CSException

Set a parameter. This isn't normally used as java.sql.Date truncates the time portion of a date.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

java.sql.Date - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.util.Date parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

java.util.Date - parameterValue A java.util.date parameter. We ignore nanoseconds. This is because DATE is stored with a precision of 1 second but can be searched with nanosecond precison. If you don't always drop the nanosecond portion you can create records which you can't find.

Throws:

CSException - if parameterId is not a valid parameter.

Since:

4.0.2016 Support for java.util.Date added.

setParam

public void setParam(int parameterId,
                     boolean parameterValue)
              throws CSException

A convenience method to set a boolean parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

boolean - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     byte parameterValue)
              throws CSException

A convenience method to set an byte parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

byte - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     short parameterValue)
              throws CSException

A convenience method to set an short parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

short - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     int parameterValue)
              throws CSException

A convenience method to set an int parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

int - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     long parameterValue)
              throws CSException

A convenience method to set an long parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

long - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     float parameterValue)
              throws CSException

A convenience method to set an float parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

float - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     double parameterValue)
              throws CSException

A convenience method to set an double parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

double - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Boolean parameterValue)
              throws CSException

A convenience method to set a boolean parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Boolean - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Byte parameterValue)
              throws CSException

A convenience method to set an byte parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Byte - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Short parameterValue)
              throws CSException

A convenience method to set an short parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Short - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Integer parameterValue)
              throws CSException

A convenience method to set an int parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Integer - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Long parameterValue)
              throws CSException

A convenience method to set an long parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Long - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Float parameterValue)
              throws CSException

A convenience method to set an float parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Float - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.Double parameterValue)
              throws CSException

A convenience method to set an double parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Double - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.math.BigDecimal parameterValue)
              throws CSException

A convenience method to set an double parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

java.math.BigDecimal - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.io.File parameterValue)
              throws CSException

A convenience method to set an File parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

File - parameterValue A File containing Long Data.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     byte[] parameterValue)
              throws CSException

A convenience method to set an byte[] parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

byte[] - parameterValue An array of byte[].

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     ReadOnlyRowSet parameterValue)
              throws CSException

A convenience method to set a ReadOnlyRowSet parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

File - parameterValue A ReadOnlyRowSet.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.io.InputStream parameterValue,
                     int fileSize,
                     int dataType)
              throws CSException

A convenience method to set an InputStream parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

InputStream - parameterValue An InputStream containing Long Data.

int - fileSize How many bytes are in the data stream.

int - dataType The OracleType of the underlying object

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.CLOB parameterValue)
              throws CSException

A convenience method to set a CLOB parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.CLOB - parameterValue An oracle.sql.CLOB containing CLOB Data.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.BFILE parameterValue)
              throws CSException

A convenience method to set a BFILE parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.BFILE - parameterValue An oracle.sql.BFILE containing BFILE Data.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     oracle.sql.BLOB parameterValue)
              throws CSException

A convenience method to set a BLOB parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

oracle.sql.BLOB - parameterValue An oracle.sql.BLOB containing BLOB Data.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.io.BufferedInputStream parameterValue,
                     int fileSize,
                     int dataType)
              throws CSException

A convenience method to set a BufferedInputStream parameter.

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

BufferedInputStream - parameterValue A Buffered InputStream containing Long Data.

int - fileSize How many bytes are in the data stream.

Throws:

CSException - if parameterId is not a valid parameter.

setParam

public void setParam(int parameterId,
                     java.lang.String parameterValue)
              throws CSException

Set a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

String - parameterValue A parameter.

Throws:

CSException - if parameterId is not a valid parameter.

getParam

public java.lang.Object getParam(int parameterId)
                          throws CSException

Get a parameter

Parameters:

int - parameterId The id of the parameter to set. Id's start at 0.

Throws:

CSException - if parameterId is not a valid parameter.

getParameters

public java.lang.Object[] getParameters()

Get all parameters

Returns:

An array of Object.

getSignature

public java.lang.String getSignature()

Return a String that uniquely identifies a set of parameters.

Returns:

A unique string that describes this set of parameters.

bindParameters

public void bindParameters(java.sql.PreparedStatement thePreparedStatement)
                    throws CSException

Bind these parameter to a Prepared Statement.

Parameters:

PreparedStatement - thePreparedStatement The prepared statement you want these parameters bound to.

Throws:

CSException

Since:

Oracle 9i Support for TIMESTAMP, TIMESTAMP_TZ, TIMESTAMP_LTZ, 2.0.1098 Support for Boolean parameters, 4.0.1847 Support for PL/SQL Tables

checkSet

public void checkSet()
              throws CSException

Complain if not all parameters set...

Throws:

CSException

Since:

2.0.1504 - method is now public instead of protected

checkBuild

public static void checkBuild(int pBuild)
                       throws CSException

Return version of this class This menthod is used by generated code to make sure that it's using the right version of com.orindasoft.pub.

Parameters:

int - Build , e.g. "2705"

Throws:

CSException - if builds not the same

Since:

6.0.2706