org.tentackle.persist

Class PreparedStatementWrapper

java.lang.Object

org.tentackle.persist.StatementWrapper

org.tentackle.persist.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.persist.StatementKey, boolean, int, int, java.util.function.Supplier<java.lang.String>).

Author:

harald

Field Summary

Fields inherited from class org.tentackle.persist.StatementWrapper

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearParameters() Clears the current parameter values immediately.
void	close() Closes this statement.
protected void	detachSession() Detach the db from the connection. Statements detach the db on executeUpdate or on close() in the resultsetwrapper after executeQuery.
protected int	effectivePosition(int p) Gets the effective position. This the p + columnOffset.
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.
protected int	executeUpdateImpl(String sql) Implementation of executeUpdate.
int	getColumnOffset() Gets the column offset.
Object	getParameter(int p) Gets the parameter at position.
Map<Integer,Object>	getParameters() Gets the parameter map.
PreparedStatement	getStatement() Gets the wrapped prepared statement.
StatementKey	getStatementKey() Gets the statement key.
protected void	rememberParameter(int p, Object value) Sets the parameter to be remembered for diagnostics.
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.
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.
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	setInt(int p, int i)
void	setInteger(int p, Integer i)
void	setLong(int p, long l)
void	setLong(int p, Long l)
void	setNull(int p, int type)
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)
String	toString()

Methods inherited from class org.tentackle.persist.StatementWrapper

assertNotReadOnly, assertOpen, cancel, consume, executeQuery, executeQuery, executeUpdate, forceDetached, getConnection, getFetchDirection, getFetchSize, getMaxRows, getSession, getSql, isCancelled, isClosed, isMarkedReady, isRunning, markReady, setFetchDirection, setFetchSize, setMaxRows, setRunning, unmarkReady

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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

effectivePosition

protected int effectivePosition(int p)

Gets the effective position.
This the p + columnOffset.

Parameters:

p - the sql position

Returns:

the effective position

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 db from the connection.
Statements detach the db on executeUpdate or on close() in the resultsetwrapper after executeQuery.

Overrides:

detachSession in class StatementWrapper

clearParameters

public void clearParameters()

Clears the current parameter values immediately.

See Also:

PreparedStatement.clearParameters()

getParameter

public Object getParameter(int p)

Gets the parameter at position.

Parameters:

p - the sql position

Returns:

the object, null if no such position or object is null

getParameters

public Map<Integer,Object> getParameters()

Gets the parameter map.

Returns:

the parameters

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 failes

executeUpdate

public int executeUpdate()

Executes the update.

Returns:

the row count

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

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

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

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.setBinaryStream(int, java.io.InputStream, int).

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