Module org.tentackle.database

Package org.tentackle.dbms

Class PreparedStatementWrapper

java.lang.Object

org.tentackle.dbms.StatementWrapper

org.tentackle.dbms.PreparedStatementWrapper

All Implemented Interfaces:

AutoCloseable, BackendPreparedStatement

public class PreparedStatementWrapper
extends StatementWrapper
implements BackendPreparedStatement

A wrapper for prepared statements.
Will catch and report SQLExceptions and keep track of being used only once after Db.getPreparedStatement(org.tentackle.dbms.StatementKey, boolean, int, int, org.tentackle.dbms.SqlSupplier).

Author:

harald

Field Summary

Fields inherited from class org.tentackle.dbms.StatementWrapper

cancelled, con, openResultSet, parallelOk, ready, running, sql, stackTrace, stmt

Constructor Summary

Constructors

Constructor	Description
PreparedStatementWrapper(ManagedConnection con, PreparedStatement stmt, StatementKey statementKey, String sql)	Creates a wrapper for a prepared statement.

Method Summary

Modifier and Type	Method	Description
void	addBatch()	Adds a set of parameters to this PreparedStatement's batch of commands.
void	addBatch(String sql)	Method must not be invoked on a PreparedStatementWrapper. Always throws PersistenceException.
void	clearBatch()	Empties this Statement object's current list of batched SQL commands.
void	clearParameters()	Clears the current parameter values immediately.
void	close()	Closes this statement.
protected void	detachSession()	Detach the session from the connection. Statements detach the session on executeUpdate or on close() in the ResultSetWrapper after executeQuery.
int[]	executeBatch(boolean finish)	Submits a batch of commands.
ResultSetWrapper	executeQuery()	Executes the query.
ResultSetWrapper	executeQuery(boolean withinTx)	Executes the query.
protected ResultSet	executeQueryImpl(String sql)	Implementation of executeQuery.
int	executeUpdate()	Executes the update.
int	executeUpdate(String sql)	Method must not be invoked on a PreparedStatementWrapper.
protected int	executeUpdateImpl(String sql)	Implementation of executeUpdate.
protected DbBatch	getBatch()	Gets the statement batch.
int	getBatchCount()	Gets the number of pending addBatch invocations.
List<Map<Integer,Object>>	getBatchParameters()	Gets the parameter map for a batched statement.
int	getColumnOffset()	Gets the column offset.
Map<Integer,Object>	getParameters()	Gets the parameter map.
PreparedStatement	getStatement()	Gets the wrapped prepared statement.
StatementKey	getStatementKey()	Gets the statement key.
protected boolean	isBatched()	Returns whether statement is batched.
boolean	isExecutionPending()	Returns whether parameters have been set so that execution is pending.
void	markReady()	Marks the statement to be ready for being consumed by a Db attached to a ConnectionManager. This is an additional measure to enforce the programming rule that a statement is being used only once after Db.createStatement() (for non-prepared statements) or after Db.getPreparedStatement(org.tentackle.dbms.StatementKey, boolean, int, int, org.tentackle.dbms.SqlSupplier) for prepared statements.
protected void	rememberParameter(int p, Object value)	Sets the parameter to be remembered for diagnostics.
<T> int	set(DataType<T> dataType, int p, T object, boolean mapNull, Integer size)
<T> void	set(DataType<T> dataType, int p, T object, int index, boolean mapNull, Integer size)
void	set(SqlType sqlType, int p, Object object)
void	setArray(int p, Class<?> type, int columnIndex, Collection<?> elements, String operator)
protected void	setBatch(DbBatch batch)	Sets the statement batch if batched within the current transaction.
void	setBigDecimal(int p, BigDecimal d)
void	setBinary(int p, org.tentackle.common.Binary<?> b)	Sets the designated parameter to the given Binary value.
void	setBMoney(int p, org.tentackle.common.BMoney m)	Sets the designated parameter to a BMoney value. A BMoney will not be stored as a single field but as two fields: a double representing the value an int representing the scale This is due to most DBMS can't store arbitrary scaled decimals in a single column, i.e. all values in the column must have the same scale.
void	setBoolean(int p, boolean b)
void	setBoolean(int p, Boolean b)
void	setByte(int p, byte b)
void	setByte(int p, Byte b)
void	setChar(int p, char c)
void	setCharacter(int p, Character c)
void	setCharacter(int p, Character c, boolean mapNull)
void	setColumnOffset(int columnOffset)	Sets the column offset.
void	setDate(int p, Date d)
void	setDate(int p, Date d, boolean mapNull)
void	setDate(int p, Date d, Calendar timezone)
void	setDate(int p, Date d, Calendar timezone, boolean mapNull)
void	setDMoney(int p, org.tentackle.common.DMoney m)	Sets the designated parameter to a DMoney value. A DMoney will not be stored as a single field but as two fields: a BigDecimal with a scale of 0 representing the value an int representing the scale This is due to most DBMS can't store arbitrary scaled decimals in a single column, i.e. all values in the column must have the same scale.
void	setDouble(int p, double d)
void	setDouble(int p, Double d)
void	setFloat(int p, float f)
void	setFloat(int p, Float f)
void	setInstant(int p, Instant ts)
void	setInstant(int p, Instant ts, boolean mapNull)
void	setInt(int p, int i)
void	setInteger(int p, Integer i)
void	setLargeString(int p, String s)
void	setLargeString(int p, String s, boolean mapNull)
void	setLocalDate(int p, LocalDate d)
void	setLocalDate(int p, LocalDate d, boolean mapNull)
void	setLocalDateTime(int p, LocalDateTime ts)
void	setLocalDateTime(int p, LocalDateTime ts, boolean mapNull)
void	setLocalTime(int p, LocalTime t)
void	setLong(int p, long l)
void	setLong(int p, Long l)
void	setNull(int p, int type)
void	setOffsetDateTime(int p, OffsetDateTime ts)
void	setOffsetDateTime(int p, OffsetDateTime ts, boolean mapNull)
void	setOffsetTime(int p, OffsetTime t)
void	setShort(int p, short s)
void	setShort(int p, Short s)
void	setString(int p, String s)
void	setString(int p, String s, boolean mapNull)
void	setTime(int p, Time t)
void	setTime(int p, Time t, Calendar timezone)
void	setTimestamp(int p, Timestamp ts)
void	setTimestamp(int p, Timestamp ts, boolean mapNull)
void	setTimestamp(int p, Timestamp ts, Calendar timezone)
void	setTimestamp(int p, Timestamp ts, Calendar timezone, boolean mapNull)
void	setZonedDateTime(int p, ZonedDateTime ts)
void	setZonedDateTime(int p, ZonedDateTime ts, boolean mapNull)
String	toString()

Methods inherited from class org.tentackle.dbms.StatementWrapper

assertNotReadOnly, assertOpen, cancel, consume, executeQuery, executeQuery, forceDetached, getAttachedSession, getConnection, getFetchDirection, getFetchSize, getMaxRows, getSession, getSql, getStackTrace, isCancelled, isClosed, isMarkedReady, isParallelOk, isRunning, setFetchDirection, setFetchSize, setMaxRows, setParallelOk, setRunning, setStackTrace, unmarkReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PreparedStatementWrapper

public PreparedStatementWrapper(ManagedConnection con,
 PreparedStatement stmt,
 StatementKey statementKey,
 String sql)

Creates a wrapper for a prepared statement.

Parameters:

con - the connection

stmt - the jdbc statement

statementKey - the statement key if not a one-shot

sql - the original sql string that created the stmt

Method Details

toString

public String toString()

Overrides:

toString in class StatementWrapper

close

public void close()

Description copied from class: StatementWrapper

Closes this statement.

Specified by:

close in interface AutoCloseable

Overrides:

close in class StatementWrapper

getStatement

public PreparedStatement getStatement()

Gets the wrapped prepared statement.

Overrides:

getStatement in class StatementWrapper

Returns:

the prepared statement, null if closed

getStatementKey

public StatementKey getStatementKey()

Gets the statement key.

Returns:

the key, null if one-shot

setColumnOffset

public void setColumnOffset(int columnOffset)

Sets the column offset. Useful for eager loading or joining in general.

Parameters:

columnOffset - (default is 0)

getColumnOffset

public int getColumnOffset()

Gets the column offset.

Returns:

the current columnOffset

rememberParameter

protected void rememberParameter(int p,
 Object value)

Sets the parameter to be remembered for diagnostics.

Parameters:

p - the effective sql position

value - the value of the parameter

detachSession

protected void detachSession()

Description copied from class: StatementWrapper

Detach the session from the connection.
Statements detach the session on executeUpdate or on close() in the ResultSetWrapper after executeQuery.

Overrides:

detachSession in class StatementWrapper

markReady

public void markReady()

Description copied from class: StatementWrapper

Marks the statement to be ready for being consumed by a Db attached to a ConnectionManager.
This is an additional measure to enforce the programming rule that a statement is being used only once after Db.createStatement() (for non-prepared statements) or after Db.getPreparedStatement(org.tentackle.dbms.StatementKey, boolean, int, int, org.tentackle.dbms.SqlSupplier) for prepared statements.

If a statement is marked ready more than once, i.e. an open result exists (which would be closed according to the JDBC specs), a PersistenceException is thrown. The specs in Statement say:

 By default, only one ResultSet object per Statement object can be open at the same time.
 Therefore, if the reading of one ResultSet object is interleaved with the reading of another,
 each must have been generated by different Statement objects.
 All execution methods in the Statement interface implicitly close a statement's current
 ResultSet object if an open one exists.
 

Without this additional measure a "ResultSet closed" exception will be thrown by the JDBC-driver on the next usage of the first result set, and you wouldn't have any clue which result set forced the closing.

Overrides:

markReady in class StatementWrapper

setBatch

protected void setBatch(DbBatch batch)

Sets the statement batch if batched within the current transaction.

Parameters:

batch - the batch

getBatch

protected DbBatch getBatch()

Gets the statement batch.

Returns:

null if not batched

isBatched

protected boolean isBatched()

Returns whether statement is batched.

Returns:

true if used in a batched transaction

clearParameters

public void clearParameters()

Clears the current parameter values immediately.

See Also:

• PreparedStatement.clearParameters()

getParameters

public Map<Integer,Object> getParameters()

Gets the parameter map.

Returns:

the parameters

getBatchParameters

public List<Map<Integer,Object>> getBatchParameters()

Gets the parameter map for a batched statement.

Returns:

the parameter batch list, null if not batched

executeUpdateImpl

protected int executeUpdateImpl(String sql)
                         throws SQLException

Implementation of executeUpdate.

Overridden because sql-string isn't used.

Overrides:

executeUpdateImpl in class StatementWrapper

Parameters:

sql - the sql string

Returns:

the number of affected rows

Throws:

SQLException - if update failed

executeUpdate

public int executeUpdate()

Executes the update.

Returns:

the row count

executeUpdate

public int executeUpdate(String sql)

Method must not be invoked on a PreparedStatementWrapper.

Overrides:

executeUpdate in class StatementWrapper

Parameters:

sql - must be null, any non-null results in a PersistenceException

Returns:

the row count

addBatch

public void addBatch(String sql)

Method must not be invoked on a PreparedStatementWrapper.
Always throws PersistenceException.

Overrides:

addBatch in class StatementWrapper

Parameters:

sql - ignored

addBatch

public void addBatch()

Adds a set of parameters to this PreparedStatement's batch of commands.

clearBatch

public void clearBatch()

Description copied from class: StatementWrapper

Empties this Statement object's current list of batched SQL commands.

Overrides:

clearBatch in class StatementWrapper

executeBatch

public int[] executeBatch(boolean finish)

Description copied from class: StatementWrapper

Submits a batch of commands.

Overrides:

executeBatch in class StatementWrapper

Parameters:

finish - true if this is the last invocation

Returns:

an array of update counts containing one element for each command in the batch

isExecutionPending

public boolean isExecutionPending()

Returns whether parameters have been set so that execution is pending.

Returns:

true if pending, false otherwise

getBatchCount

public int getBatchCount()

Gets the number of pending addBatch invocations.

Returns:

0 if nothing pending

executeQueryImpl

protected ResultSet executeQueryImpl(String sql)
                              throws SQLException

Implementation of executeQuery.

Overridden because sql-string isn't used.

Overrides:

executeQueryImpl in class StatementWrapper

Parameters:

sql - the sql string

Returns:

the result set

Throws:

SQLException - if query failed

executeQuery

public ResultSetWrapper executeQuery(boolean withinTx)

Executes the query.

Parameters:

withinTx - is true if start a transaction for this query.

Returns:

the result set as a ResultSetWrapper

executeQuery

public ResultSetWrapper executeQuery()

Executes the query.

Returns:

the result set as a ResultSetWrapper

setNull

public void setNull(int p,
 int type)

Specified by:

setNull in interface BackendPreparedStatement

set

public <T> int set(DataType<T> dataType,
 int p,
 T object,
 boolean mapNull,
 Integer size)

Specified by:

set in interface BackendPreparedStatement

set

public <T> void set(DataType<T> dataType,
 int p,
 T object,
 int index,
 boolean mapNull,
 Integer size)

Specified by:

set in interface BackendPreparedStatement

set

public void set(SqlType sqlType,
 int p,
 Object object)

Specified by:

set in interface BackendPreparedStatement

setArray

public void setArray(int p,
 Class<?> type,
 int columnIndex,
 Collection<?> elements,
 String operator)

Specified by:

setArray in interface BackendPreparedStatement

setString

public void setString(int p,
 String s,
 boolean mapNull)

Specified by:

setString in interface BackendPreparedStatement

setString

public void setString(int p,
 String s)

Specified by:

setString in interface BackendPreparedStatement

setLargeString

public void setLargeString(int p,
 String s,
 boolean mapNull)

Specified by:

setLargeString in interface BackendPreparedStatement

setLargeString

public void setLargeString(int p,
 String s)

Specified by:

setLargeString in interface BackendPreparedStatement

setBoolean

public void setBoolean(int p,
 boolean b)

Specified by:

setBoolean in interface BackendPreparedStatement

setBoolean

public void setBoolean(int p,
 Boolean b)

Specified by:

setBoolean in interface BackendPreparedStatement

setByte

public void setByte(int p,
 byte b)

Specified by:

setByte in interface BackendPreparedStatement

setByte

public void setByte(int p,
 Byte b)

Specified by:

setByte in interface BackendPreparedStatement

setChar

public void setChar(int p,
 char c)

Specified by:

setChar in interface BackendPreparedStatement

setCharacter

public void setCharacter(int p,
 Character c,
 boolean mapNull)

Specified by:

setCharacter in interface BackendPreparedStatement

setCharacter

public void setCharacter(int p,
 Character c)

Specified by:

setCharacter in interface BackendPreparedStatement

setShort

public void setShort(int p,
 short s)

Specified by:

setShort in interface BackendPreparedStatement

setShort

public void setShort(int p,
 Short s)

Specified by:

setShort in interface BackendPreparedStatement

setInt

public void setInt(int p,
 int i)

Specified by:

setInt in interface BackendPreparedStatement

setInteger

public void setInteger(int p,
 Integer i)

Specified by:

setInteger in interface BackendPreparedStatement

setLocalDate

public void setLocalDate(int p,
 LocalDate d,
 boolean mapNull)

Specified by:

setLocalDate in interface BackendPreparedStatement

setLocalDate

public void setLocalDate(int p,
 LocalDate d)

Specified by:

setLocalDate in interface BackendPreparedStatement

setLocalDateTime

public void setLocalDateTime(int p,
 LocalDateTime ts)

Specified by:

setLocalDateTime in interface BackendPreparedStatement

setLocalDateTime

public void setLocalDateTime(int p,
 LocalDateTime ts,
 boolean mapNull)

Specified by:

setLocalDateTime in interface BackendPreparedStatement

setOffsetDateTime

public void setOffsetDateTime(int p,
 OffsetDateTime ts)

Specified by:

setOffsetDateTime in interface BackendPreparedStatement

setOffsetDateTime

public void setOffsetDateTime(int p,
 OffsetDateTime ts,
 boolean mapNull)

Specified by:

setOffsetDateTime in interface BackendPreparedStatement

setZonedDateTime

public void setZonedDateTime(int p,
 ZonedDateTime ts)

Specified by:

setZonedDateTime in interface BackendPreparedStatement

setZonedDateTime

public void setZonedDateTime(int p,
 ZonedDateTime ts,
 boolean mapNull)

Specified by:

setZonedDateTime in interface BackendPreparedStatement

setInstant

public void setInstant(int p,
 Instant ts)

Specified by:

setInstant in interface BackendPreparedStatement

setInstant

public void setInstant(int p,
 Instant ts,
 boolean mapNull)

Specified by:

setInstant in interface BackendPreparedStatement

setLocalTime

public void setLocalTime(int p,
 LocalTime t)

Specified by:

setLocalTime in interface BackendPreparedStatement

setOffsetTime

public void setOffsetTime(int p,
 OffsetTime t)

Specified by:

setOffsetTime in interface BackendPreparedStatement

setLong

public void setLong(int p,
 long l)

Specified by:

setLong in interface BackendPreparedStatement

setLong

public void setLong(int p,
 Long l)

Specified by:

setLong in interface BackendPreparedStatement

setFloat

public void setFloat(int p,
 float f)

Specified by:

setFloat in interface BackendPreparedStatement

setFloat

public void setFloat(int p,
 Float f)

Specified by:

setFloat in interface BackendPreparedStatement

setDouble

public void setDouble(int p,
 double d)

Specified by:

setDouble in interface BackendPreparedStatement

setDouble

public void setDouble(int p,
 Double d)

Specified by:

setDouble in interface BackendPreparedStatement

setBigDecimal

public void setBigDecimal(int p,
 BigDecimal d)

Specified by:

setBigDecimal in interface BackendPreparedStatement

setBMoney

public void setBMoney(int p,
 org.tentackle.common.BMoney m)

Sets the designated parameter to a BMoney value.
A BMoney will not be stored as a single field but as two fields:

1. a double representing the value
2. an int representing the scale

This is due to most DBMS can't store arbitrary scaled decimals in a single column, i.e. all values in the column must have the same scale.

Parameters:

p - the sql position

m - the money value, null to set SQL NULL

See Also:

• setDMoney(int, DMoney)

setDMoney

public void setDMoney(int p,
 org.tentackle.common.DMoney m)

Sets the designated parameter to a DMoney value.
A DMoney will not be stored as a single field but as two fields:

1. a BigDecimal with a scale of 0 representing the value
2. an int representing the scale

This is due to most DBMS can't store arbitrary scaled decimals in a single column, i.e. all values in the column must have the same scale.

Parameters:

p - the sql position

m - the money value, null to set SQL NULL

See Also:

• setBMoney(int, BMoney)

setDate

public void setDate(int p,
 Date d,
 Calendar timezone,
 boolean mapNull)

Specified by:

setDate in interface BackendPreparedStatement

setDate

public void setDate(int p,
 Date d,
 Calendar timezone)

Specified by:

setDate in interface BackendPreparedStatement

setDate

public void setDate(int p,
 Date d,
 boolean mapNull)

Specified by:

setDate in interface BackendPreparedStatement

setDate

public void setDate(int p,
 Date d)

Specified by:

setDate in interface BackendPreparedStatement

setTimestamp

public void setTimestamp(int p,
 Timestamp ts,
 Calendar timezone,
 boolean mapNull)

Specified by:

setTimestamp in interface BackendPreparedStatement

setTimestamp

public void setTimestamp(int p,
 Timestamp ts,
 Calendar timezone)

Specified by:

setTimestamp in interface BackendPreparedStatement

setTimestamp

public void setTimestamp(int p,
 Timestamp ts,
 boolean mapNull)

Specified by:

setTimestamp in interface BackendPreparedStatement

setTimestamp

public void setTimestamp(int p,
 Timestamp ts)

Specified by:

setTimestamp in interface BackendPreparedStatement

setTime

public void setTime(int p,
 Time t,
 Calendar timezone)

Specified by:

setTime in interface BackendPreparedStatement

setTime

public void setTime(int p,
 Time t)

Specified by:

setTime in interface BackendPreparedStatement

setBinary

public void setBinary(int p,
 org.tentackle.common.Binary<?> b)

Sets the designated parameter to the given Binary value. will The driver converts this to an SQL BLOB value when it sends it to the database. The implementation translates the Binary into an InputStream and invokes PreparedStatement.setBlob(int, java.io.InputStream, long).

Parameters:

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

b - the parameter value, null if the value should be set to SQL NULL