com.dbSpaces.jdb.Statement Class Reference

Inherits com.dbSpaces.jdb.Base.

Public Member Functions
void	addBatch () throws DatabaseException
void	addBatch (String stmt) throws DatabaseException
void	clearBatch ()
boolean	isClosed ()
ResultSet	execute () throws DatabaseException
long	executeUpdate () throws DatabaseException
int[]	executeBatch () throws DatabaseException
ResultSet	executeDirect (String sql) throws DatabaseException
void	prepare (String sqlStmt) throws DatabaseException
void	cancel () throws DatabaseException
boolean	close () throws DatabaseException
void	setInt (int parameterIndex, int parameterValue) throws DatabaseException
void	setLong (int parameterIndex, long parameterValue) throws DatabaseException
void	setShort (int parameterIndex, short parameterValue) throws DatabaseException
void	setString (int parameterIndex, String parameterValue) throws DatabaseException
void	setTime (int parameterIndex, Time parameterValue) throws DatabaseException
void	setTime (int parameterIndex, Time[] parameterValue) throws DatabaseException
void	setTimestamp (int parameterIndex, Timestamp parameterValue) throws DatabaseException
void	setTimestamp (int parameterIndex, Timestamp[] parameterValue) throws DatabaseException
void	setFloat (int parameterIndex, float parameterValue) throws DatabaseException
void	setDouble (int parameterIndex, double parameterValue) throws DatabaseException
void	setDate (int parameterIndex, Date parameterValue) throws DatabaseException
void	setDate (int parameterIndex, Date[] parameterValue) throws DatabaseException
void	setBytes (int parameterIndex, byte[] parameterValue) throws DatabaseException
void	setByte (int parameterIndex, byte parameterValue) throws DatabaseException
void	setBoolean (int parameterIndex, boolean parameterValue) throws DatabaseException
void	setArray (int parameterIndex, com.dbSpaces.types.Array parameterValue) throws DatabaseException
void	setBlob (int parameterIndex, Blob parameterValue) throws DatabaseException
void	setClob (int parameterIndex, Clob parameterValue) throws DatabaseException
void	setBigDecimal (int parameterIndex, BigDecimal parameterValue) throws DatabaseException
void	setBinaryStream (int parameterIndex, InputStream parameterValue, int len) throws DatabaseException
void	setCharacterStream (int parameterIndex, Reader parameterValue, int len) throws DatabaseException
void	setNull (int parameterIndex, byte storageClass) throws DatabaseException
void	setAsciiStream (int parameterIndex, InputStream parameterValue, int len) throws DatabaseException
void	setUnicodeStream (int parameterIndex, InputStream parameterValue, int len) throws DatabaseException
void	setInt (int parameterIndex, int[] parameterValue) throws DatabaseException
void	setShort (int parameterIndex, short[] parameterValue) throws DatabaseException
void	setBoolean (int parameterIndex, boolean[] parameterValue) throws DatabaseException
void	setString (int parameterIndex, String[] parameterValue) throws DatabaseException
void	setLong (int parameterIndex, long[] parameterValue) throws DatabaseException
void	setFloat (int parameterIndex, float[] parameterValue) throws DatabaseException
void	setDouble (int parameterIndex, double[] parameterValue) throws DatabaseException
void	registerOutParameter (int parameterIndex, byte storageClass) throws DatabaseException
void	registerOutParameter (int parameterIndex, byte storageClass, int scale) throws DatabaseException
void	registerOutParameter (int parameterIndex, byte storageClass, String typeName) throws DatabaseException
void	clearParameters () throws DatabaseException
boolean	wasNull () throws DatabaseException
boolean	wasNull (int lastParam)
ResultSet	getMoreResults () throws DatabaseException
int	getFetchSize () throws DatabaseException
int	getMaxRows () throws DatabaseException
dtRtnStatus	setMaxRows (int rows) throws DatabaseException
dtRtnStatus	setFetchSize (int rows) throws DatabaseException
ResultSet	getResultSet () throws DatabaseException
String	getCursorName ()
int	getNumberResultColumns () throws DatabaseException
long	getRowCount () throws DatabaseException
String	getString (int parameterIndex) throws DatabaseException
String	getString (String parameterName) throws DatabaseException
boolean	getBoolean (int parameterIndex) throws DatabaseException
boolean	getBoolean (String parameterName) throws DatabaseException
byte	getByte (int parameterIndex) throws DatabaseException
byte	getByte (String parameterName) throws DatabaseException
short	getShort (int parameterIndex) throws DatabaseException
short	getShort (String parameterName) throws DatabaseException
int	getInt (int parameterIndex) throws DatabaseException
int	getInt (String parameterName) throws DatabaseException
long	getLong (int parameterIndex) throws DatabaseException
long	getLong (String parameterName) throws DatabaseException
float	getFloat (int parameterIndex) throws DatabaseException
float	getFloat (String parameterName) throws DatabaseException
double	getDouble (int parameterIndex) throws DatabaseException
double	getDouble (String parameterName) throws DatabaseException
BigDecimal	getBigDecimal (int parameterIndex, int scale) throws DatabaseException
byte[]	getBytes (int parameterIndex) throws DatabaseException
Date	getDate (int parameterIndex) throws DatabaseException
Date	getDate (String parameterName) throws DatabaseException
Time	getTime (int parameterIndex) throws DatabaseException
Time	getTime (String parameterName) throws DatabaseException
Timestamp	getTimestamp (int parameterIndex) throws DatabaseException
Timestamp	getTimestamp (String parameterName) throws DatabaseException
Object	getObject (int parameterIndex) throws DatabaseException
Object	getObject (String parameterName) throws DatabaseException
BigDecimal	getBigDecimal (int parameterIndex) throws DatabaseException
BigDecimal	getBigDecimal (String parameterName) throws DatabaseException
Array	getArray (int parameterIndex) throws DatabaseException
Array	getArray (String parameterName) throws DatabaseException

Protected Member Functions
	Statement (Connection connection) throws DatabaseException
	Statement (Connection connection, String cursorName) throws DatabaseException
long	getHandle ()

Detailed Description

A Statement object is used for executing a static/dynamic SQL statement and obtaining the results produced by it.

Only one ResultSet per Statement can be open at any point in time. Therefore, if the reading of one ResultSet is interleaved with the reading of another, each must have been generated by different Statements. All statement execute methods implicitly close a statment's current ResultSet if an open one exists.

A DatabaseException will be thrown if a database error occurs and exceptions are enabled. If exceptions are not enabled the following error methods can be used to get information about the error;

• GetErrorStatus()
• GetErrorCode()
• GetErrorMessage()

See also

Connection::createStatement

ResultSet

Since

Version 1.0

Constructor & Destructor Documentation

Statement() [1/2]

com.dbSpaces.jdb.Statement.Statement ( Connection  connection ) throws DatabaseException

protected

Constructor.

Parameters

connection

Connection object.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Statement() [2/2]

com.dbSpaces.jdb.Statement.Statement ( Connection  connection, String  cursorName  ) throws DatabaseException

protected

Constructor.

Parameters

connection	Connection object.
name	the statement name.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Member Function Documentation

addBatch() [1/2]

void com.dbSpaces.jdb.Statement.addBatch

(

)

throws DatabaseException

Start a new batch of SQL statements.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

addBatch() [2/2]

void com.dbSpaces.jdb.Statement.addBatch

(

String

stmt

)

throws DatabaseException

Add a SQL statement to a batch of SQL statements.

Parameters

stmt	SQL statement.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

See also

clearBatch() and executeBatch()

Since

Version 1.0

cancel()

void com.dbSpaces.jdb.Statement.cancel

(

)

throws DatabaseException

Cancel an executing SQL statement.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the call graph for this function:

clearBatch()

void com.dbSpaces.jdb.Statement.clearBatch

(

)

Clear any batch SQL statements.

See also

addBatch()

Since

Version 1.0

clearParameters()

void com.dbSpaces.jdb.Statement.clearParameters

(

)

throws DatabaseException

Clear any existing statement parameters.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

close()

boolean com.dbSpaces.jdb.Statement.close

(

)

throws DatabaseException

Close the statement resources.

Returns

boolean

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

execute()

ResultSet com.dbSpaces.jdb.Statement.execute

(

)

throws DatabaseException

Execute the prepared statement and return a ResultSet object.

Returns

ResultSet object if successful; otherwise null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

See also

prepare().

Since

Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

executeBatch()

int[] com.dbSpaces.jdb.Statement.executeBatch

(

)

throws DatabaseException

Execute the batched statements.

Returns

Array of update counts for the executed statements.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

See also

addBatch()

executeDirect()

ResultSet com.dbSpaces.jdb.Statement.executeDirect

(

String

sql

)

throws DatabaseException

Execute a SQL statement immediately without first preparing and then executing it.

Parameters

sql	SQL statement.

Returns

ResultSet object if successful; otherwise null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the call graph for this function:

executeUpdate()

long com.dbSpaces.jdb.Statement.executeUpdate

(

)

throws DatabaseException

Execute the prepared update statement.

Returns

The update count.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

See also

prepare().

Since

Version 1.0

Here is the call graph for this function:

getArray() [1/2]

Array com.dbSpaces.jdb.Statement.getArray

(

int

parameterIndex

)

throws DatabaseException

Get an Array OUT parameter.

Parameters

parameterIndex

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

Returns

An object representing an SQL array.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getArray() [2/2]

public Array com.dbSpaces.jdb.Statement.getArray

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getBigDecimal() [1/3]

BigDecimal com.dbSpaces.jdb.Statement.getBigDecimal

(

int

parameterIndex

)

throws DatabaseException

Get the value of a NUMERIC parameter as a java.math.BigDecimal object.

Parameters

parameterIndex

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

Returns

The parameter value (full precision); if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

getBigDecimal() [2/3]

BigDecimal com.dbSpaces.jdb.Statement.getBigDecimal	(	int	parameterIndex,
		int	scale
	)		throws DatabaseException

Get the value of a NUMERIC parameter as a java.math.BigDecimal object.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
scale	a value greater than or equal to zero representing the desired number of digits to the right of the decimal point.

Returns

The parameter value; if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getBigDecimal() [3/3]

public BigDecimal com.dbSpaces.jdb.Statement.getBigDecimal

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getBoolean() [1/2]

boolean com.dbSpaces.jdb.Statement.getBoolean

(

int

parameterIndex

)

throws DatabaseException

Get the value of a BIT parameter as a Java boolean.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is false.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getBoolean() [2/2]

public boolean com.dbSpaces.jdb.Statement.getBoolean

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getByte() [1/2]

byte com.dbSpaces.jdb.Statement.getByte

(

int

parameterIndex

)

throws DatabaseException

Get the value of a TINYINT parameter as a Java byte.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is 0.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getByte() [2/2]

public byte com.dbSpaces.jdb.Statement.getByte

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getBytes()

byte[] com.dbSpaces.jdb.Statement.getBytes

(

int

parameterIndex

)

throws DatabaseException

Get the value of a SQL BINARY or VARBINARY parameter as a Java byte[]

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

getCursorName()

String com.dbSpaces.jdb.Statement.getCursorName

(

)

Get the statement's cursor name.

Returns

cursor name

Since

Version 1.0

Here is the caller graph for this function:

getDate() [1/2]

Date com.dbSpaces.jdb.Statement.getDate

(

int

parameterIndex

)

throws DatabaseException

Get the value of a SQL DATE parameter as a java.sql.Date object

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getDate() [2/2]

public Date com.dbSpaces.jdb.Statement.getDate

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getDouble() [1/2]

double com.dbSpaces.jdb.Statement.getDouble

(

int

parameterIndex

)

throws DatabaseException

Get the value of a DOUBLE parameter as a Java double.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is 0.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getDouble() [2/2]

double com.dbSpaces.jdb.Statement.getDouble

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getFetchSize()

int com.dbSpaces.jdb.Statement.getFetchSize

(

)

throws DatabaseException

Get the fetch size for returning rows with the ResultSet object.

Returns

The fetch size.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

getFloat() [1/2]

float com.dbSpaces.jdb.Statement.getFloat

(

int

parameterIndex

)

throws DatabaseException

Get the value of a FLOAT parameter as a Java float.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is 0.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getFloat() [2/2]

public float com.dbSpaces.jdb.Statement.getFloat

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getHandle()

long com.dbSpaces.jdb.Statement.getHandle ( )

protected

Get the statement handle.

Returns

handle.

Since

Version 1.0

Here is the caller graph for this function:

getInt() [1/2]

int com.dbSpaces.jdb.Statement.getInt

(

int

parameterIndex

)

throws DatabaseException

Get the value of an INTEGER parameter as a Java int.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is 0.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getInt() [2/2]

public int com.dbSpaces.jdb.Statement.getInt

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getLong() [1/2]

long com.dbSpaces.jdb.Statement.getLong

(

int

parameterIndex

)

throws DatabaseException

Get the value of a BIGINT parameter as a Java long.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is 0.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getLong() [2/2]

public long com.dbSpaces.jdb.Statement.getLong

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getMaxRows()

int com.dbSpaces.jdb.Statement.getMaxRows

(

)

throws DatabaseException

Get the maximum rows that can be returned in a ReesultSet object.

Returns

The maximum rows.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

getMoreResults()

ResultSet com.dbSpaces.jdb.Statement.getMoreResults

(

)

throws DatabaseException

Get the next ResultSet object if the query generated multiple ResultSets.

Returns

The next ResultSet object; otherwise null if there are no more available.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the call graph for this function:

getNumberResultColumns()

int com.dbSpaces.jdb.Statement.getNumberResultColumns

(

)

throws DatabaseException

Get the number of columns that make up the ResultSet.

Returns

The number of columns.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getObject() [1/2]

Object com.dbSpaces.jdb.Statement.getObject

(

int

parameterIndex

)

throws DatabaseException

Get the value of a parameter as a Java object.

This method returns a Java object whose type coresponds to the SQL type that was registered for this parameter using registerOutParameter.

Note that this method may be used to read datatabase-specific, abstract data types. This is done by specifying a targetSqlType of java.sql.types.OTHER, which allows the driver to return a database-specific Java type.

The behavior of method getObject() is extended to materialize data of SQL user-defined types. When the OUT parameter @index is a UDT value, the behavior of this method is as if it were a call to: getObject(index, this.getConnection().getTypeMap())

Parameters

parameterIndex

The parameter index starting from 1.

Returns

A java.lang.Object holding the OUT parameter value.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

See also

Types

Since

Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

getObject() [2/2]

public Object com.dbSpaces.jdb.Statement.getObject

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getResultSet()

ResultSet com.dbSpaces.jdb.Statement.getResultSet

(

)

throws DatabaseException

Get the current ResultSet object.

Returns

The ResultSet object.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getRowCount()

long com.dbSpaces.jdb.Statement.getRowCount

(

)

throws DatabaseException

Get the row count for the number of rows processed for either an insert, delete or update request.

Returns

The number of rows processed.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getShort() [1/2]

short com.dbSpaces.jdb.Statement.getShort

(

int

parameterIndex

)

throws DatabaseException

Get the value of a SMALLINT parameter as a Java short.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is 0.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getShort() [2/2]

public short com.dbSpaces.jdb.Statement.getShort

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getString() [1/2]

String com.dbSpaces.jdb.Statement.getString

(

int

parameterIndex

)

throws DatabaseException

Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a Java String.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getString() [2/2]

public String com.dbSpaces.jdb.Statement.getString

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getTime() [1/2]

Time com.dbSpaces.jdb.Statement.getTime

(

int

parameterIndex

)

throws DatabaseException

Get the value of a TIME parameter as Time object.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getTime() [2/2]

public Time com.dbSpaces.jdb.Statement.getTime

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

getTimestamp() [1/2]

Timestamp com.dbSpaces.jdb.Statement.getTimestamp

(

int

parameterIndex

)

throws DatabaseException

Get the value of a TIMESTAMP parameter as a Timestamp object.

Parameters

parameterIndex

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

Returns

The parameter value; if the value is SQL NULL, the result is null.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

getTimestamp() [2/2]

public Timestamp com.dbSpaces.jdb.Statement.getTimestamp

(

String

parameterName

)

throws DatabaseException

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since

Version 1.0

Here is the call graph for this function:

isClosed()

boolean com.dbSpaces.jdb.Statement.isClosed

(

)

Is the Statement closed?

Returns

true if closed; false if otherwise.

Since

Version 1.0

prepare()

void com.dbSpaces.jdb.Statement.prepare

(

String

sqlStmt

)

throws DatabaseException

Prepare a SQL statement.

Parameters

sqlStmt

The SQL statement to prepare.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

See also

execute()

Since

Version 1.0

Here is the caller graph for this function:

registerOutParameter() [1/3]

void com.dbSpaces.jdb.Statement.registerOutParameter	(	int	parameterIndex,
		byte	storageClass
	)		throws DatabaseException

Register an output statement parameter.

Parameters

parameterIndex	The parameter index of output parameter.
storageClass	The storage class that represents the output parameter.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

registerOutParameter() [2/3]

void com.dbSpaces.jdb.Statement.registerOutParameter	(	int	parameterIndex,
		byte	storageClass,
		int	scale
	)		throws DatabaseException

Register an output Statement parameter.

Parameters

parameterIndex	The parameter index of output parameter.
storageClass	The storage class that represents the output parameter.
scale	The scale of the storage class.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

registerOutParameter() [3/3]

void com.dbSpaces.jdb.Statement.registerOutParameter	(	int	parameterIndex,
		byte	storageClass,
		String	typeName
	)		throws DatabaseException

Register an output statement parameter.

Parameters

parameterIndex	The parameter index of output parameter.
storageClass	The storage class that represents the output parameter.
typeName	Fully qualified SQL type name.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setArray()

void com.dbSpaces.jdb.Statement.setArray	(	int	parameterIndex,
		com.dbSpaces.types.Array	parameterValue
	)		throws DatabaseException

Set an array input parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setAsciiStream()

void com.dbSpaces.jdb.Statement.setAsciiStream	(	int	parameterIndex,
		InputStream	parameterValue,
		int	len
	)		throws DatabaseException

Set a ascii stream parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.
len	Then length of the value.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setBigDecimal()

void com.dbSpaces.jdb.Statement.setBigDecimal	(	int	parameterIndex,
		BigDecimal	parameterValue
	)		throws DatabaseException

Set a bigdecimal parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setBinaryStream()

void com.dbSpaces.jdb.Statement.setBinaryStream	(	int	parameterIndex,
		InputStream	parameterValue,
		int	len
	)		throws DatabaseException

Set a binary stream parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.
len	The length of the value.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

setBlob()

void com.dbSpaces.jdb.Statement.setBlob	(	int	parameterIndex,
		Blob	parameterValue
	)		throws DatabaseException

\Set a blob parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setBoolean() [1/2]

void com.dbSpaces.jdb.Statement.setBoolean	(	int	parameterIndex,
		boolean	parameterValue
	)		throws DatabaseException

Set a boolean parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

setBoolean() [2/2]

void com.dbSpaces.jdb.Statement.setBoolean	(	int	parameterIndex,
		boolean[]	parameterValue
	)		throws DatabaseException

Set a boolean array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setByte()

void com.dbSpaces.jdb.Statement.setByte	(	int	parameterIndex,
		byte	parameterValue
	)		throws DatabaseException

Set a byte parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setBytes()

void com.dbSpaces.jdb.Statement.setBytes	(	int	parameterIndex,
		byte[]	parameterValue
	)		throws DatabaseException

Set an array of byte parameter values.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setCharacterStream()

void com.dbSpaces.jdb.Statement.setCharacterStream	(	int	parameterIndex,
		Reader	parameterValue,
		int	len
	)		throws DatabaseException

Set a character stream parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.
len	The length of the value.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setClob()

void com.dbSpaces.jdb.Statement.setClob	(	int	parameterIndex,
		Clob	parameterValue
	)		throws DatabaseException

Set a clob parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setDate() [1/2]

void com.dbSpaces.jdb.Statement.setDate	(	int	parameterIndex,
		Date	parameterValue
	)		throws DatabaseException

Set a date parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setDate() [2/2]

void com.dbSpaces.jdb.Statement.setDate	(	int	parameterIndex,
		Date[]	parameterValue
	)		throws DatabaseException

Set an array of Date object parameter values.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setDouble() [1/2]

void com.dbSpaces.jdb.Statement.setDouble	(	int	parameterIndex,
		double	parameterValue
	)		throws DatabaseException

Set a double parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setDouble() [2/2]

void com.dbSpaces.jdb.Statement.setDouble	(	int	parameterIndex,
		double[]	parameterValue
	)		throws DatabaseException

Set a double array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setFetchSize()

dtRtnStatus com.dbSpaces.jdb.Statement.setFetchSize

(

int

rows

)

throws DatabaseException

Set the fetch size for the number of rows returned to the ResultSet object.

Parameters

size	The new fetch size.

Returns

RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setFloat() [1/2]

void com.dbSpaces.jdb.Statement.setFloat	(	int	parameterIndex,
		float	parameterValue
	)		throws DatabaseException

Set a float parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setFloat() [2/2]

void com.dbSpaces.jdb.Statement.setFloat	(	int	parameterIndex,
		float[]	parameterValue
	)		throws DatabaseException

Set a long array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setInt() [1/2]

void com.dbSpaces.jdb.Statement.setInt	(	int	parameterIndex,
		int	parameterValue
	)		throws DatabaseException

Set a integer parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setInt() [2/2]

void com.dbSpaces.jdb.Statement.setInt	(	int	parameterIndex,
		int[]	parameterValue
	)		throws DatabaseException

Set an int array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setLong() [1/2]

void com.dbSpaces.jdb.Statement.setLong	(	int	parameterIndex,
		long	parameterValue
	)		throws DatabaseException

Set a long parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setLong() [2/2]

void com.dbSpaces.jdb.Statement.setLong	(	int	parameterIndex,
		long[]	parameterValue
	)		throws DatabaseException

Set a long array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setMaxRows()

dtRtnStatus com.dbSpaces.jdb.Statement.setMaxRows

(

int

rows

)

throws DatabaseException

Set the maximum rows that can be returned in a resultset.

Parameters

rows	The new maximum rows.

Returns

RTN_STATUS_SUCCESS or RTN_STATUS_ERROR.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setNull()

void com.dbSpaces.jdb.Statement.setNull	(	int	parameterIndex,
		byte	storageClass
	)		throws DatabaseException

Set a parameter value to be null.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
storageClass	The storage class of the parameter.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setShort() [1/2]

void com.dbSpaces.jdb.Statement.setShort	(	int	parameterIndex,
		short	parameterValue
	)		throws DatabaseException

Set a short parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

setShort() [2/2]

void com.dbSpaces.jdb.Statement.setShort	(	int	parameterIndex,
		short[]	parameterValue
	)		throws DatabaseException

Set a short array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setString() [1/2]

void com.dbSpaces.jdb.Statement.setString	(	int	parameterIndex,
		String	parameterValue
	)		throws DatabaseException

Set a string parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the caller graph for this function:

setString() [2/2]

void com.dbSpaces.jdb.Statement.setString	(	int	parameterIndex,
		String[]	parameterValue
	)		throws DatabaseException

Set a string array parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setTime() [1/2]

void com.dbSpaces.jdb.Statement.setTime	(	int	parameterIndex,
		Time	parameterValue
	)		throws DatabaseException

Set a time parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setTime() [2/2]

void com.dbSpaces.jdb.Statement.setTime	(	int	parameterIndex,
		Time[]	parameterValue
	)		throws DatabaseException

Set an array of time parameter values.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setTimestamp() [1/2]

void com.dbSpaces.jdb.Statement.setTimestamp	(	int	parameterIndex,
		Timestamp	parameterValue
	)		throws DatabaseException

Set a timestamp parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

setTimestamp() [2/2]

void com.dbSpaces.jdb.Statement.setTimestamp	(	int	parameterIndex,
		Timestamp[]	parameterValue
	)		throws DatabaseException

Set an array of timestamp parameter values.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the call graph for this function:

setUnicodeStream()

void com.dbSpaces.jdb.Statement.setUnicodeStream	(	int	parameterIndex,
		InputStream	parameterValue,
		int	len
	)		throws DatabaseException

Set a unicode parameter value.

Parameters

parameterIndex	The first parameter is 1, the second is 2, ...
parameterValue	The parameter value to set.
len	The length of the value.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

wasNull() [1/2]

boolean com.dbSpaces.jdb.Statement.wasNull

(

)

throws DatabaseException

An OUT parameter may have the value of SQL NULL; wasNull reports whether the last value read has this special value.

Note: You must first call getXXX on a parameter to read its value and then call wasNull() to see if the value was SQL NULL.

Returns

true if the last parameter read was SQL NULL; false if otherwise.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0

Here is the call graph for this function:

Here is the caller graph for this function:

wasNull() [2/2]

boolean com.dbSpaces.jdb.Statement.wasNull

(

int

lastParam

)

An OUT parameter may have the value of SQL NULL; wasNull reports whether the last value read has this special value.

Parameters

parameterIndex

The parameter index to test.

Returns

true if the last parameter read was SQL NULL; false if otherwise.

Exceptions

DatabaseException

(if exceptions are enabled) when a database error occurs.

Since

Version 1.0