Class DelayedPreparedStatement

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.storage.DelayedPreparedStatement

public class DelayedPreparedStatement
extends Object

Represents a wrapper around PreparedStatement. It can be used to set variables before obtaining a connection.

It also allows you to easily create a String containing the full statement with all the variable substituted, which can be useful for debugging purposes.

Constructor Summary

Constructors

Constructor	Description
DelayedPreparedStatement(SQLStatement sqlStatement)	Constructs a new DelayedPreparedStatement.

Method Summary

Modifier and Type	Method	Description
PreparedStatement	construct(Connection conn)	Constructs a PreparedStatement from this DelayedPreparedStatement, applying all variables as defined up to this point.
PreparedStatement	construct(Connection conn, int autoGeneratedKeys)	Constructs a PreparedStatement from this DelayedPreparedStatement, applying all variables as defined up to this point.
DelayedPreparedStatement	setBigDecimal(int idx, @Nullable BigDecimal obj)	See PreparedStatement.setBigDecimal(int, BigDecimal).
DelayedPreparedStatement	setBoolean(int idx, boolean obj)	See PreparedStatement.setBoolean(int, boolean).
DelayedPreparedStatement	setByte(int idx, byte obj)	See PreparedStatement.setByte(int, byte).
DelayedPreparedStatement	setBytes(int idx, byte[] obj)	See PreparedStatement.setBytes(int, byte[]).
DelayedPreparedStatement	setDate(int idx, @Nullable Date obj)	See PreparedStatement.setDate(int, Date).
DelayedPreparedStatement	setDouble(int idx, double obj)	See PreparedStatement.setDouble(int, double).
DelayedPreparedStatement	setFloat(int idx, float obj)	See PreparedStatement.setFloat(int, float).
DelayedPreparedStatement	setInt(int idx, int obj)	See PreparedStatement.setInt(int, int).
DelayedPreparedStatement	setLong(int idx, long obj)	See PreparedStatement.setLong(int, long).
DelayedPreparedStatement	setNextBigDecimal(@Nullable BigDecimal obj)	See PreparedStatement.setBigDecimal(int, BigDecimal).
DelayedPreparedStatement	setNextBoolean(boolean obj)	See PreparedStatement.setBoolean(int, boolean).
DelayedPreparedStatement	setNextByte(byte obj)	See PreparedStatement.setByte(int, byte).
DelayedPreparedStatement	setNextBytes(byte[] obj)	See PreparedStatement.setBytes(int, byte[]).
DelayedPreparedStatement	setNextDate(@Nullable Date obj)	See PreparedStatement.setDate(int, Date).
DelayedPreparedStatement	setNextDouble(double obj)	See PreparedStatement.setDouble(int, double).
DelayedPreparedStatement	setNextFloat(float obj)	See PreparedStatement.setFloat(int, float).
DelayedPreparedStatement	setNextInt(int obj)	See PreparedStatement.setInt(int, int).
DelayedPreparedStatement	setNextLong(long obj)	See PreparedStatement.setLong(int, long).
DelayedPreparedStatement	setNextNull(int sqlType)	See PreparedStatement.setNull(int, int).
DelayedPreparedStatement	setNextObject(@Nullable Object obj, int targetSqlType)	See PreparedStatement.setObject(int, Object, int).
DelayedPreparedStatement	setNextRawString(String obj)	Shortcut for setRawString(int, String) with the current index.
DelayedPreparedStatement	setNextShort(short obj)	See PreparedStatement.setShort(int, short).
DelayedPreparedStatement	setNextString(@Nullable String obj)	See PreparedStatement.setString(int, String).
DelayedPreparedStatement	setNextTime(@Nullable Time obj)	See PreparedStatement.setTime(int, Time).
DelayedPreparedStatement	setNextTimestamp(@Nullable Timestamp obj)	See PreparedStatement.setTimestamp(int, Timestamp).
DelayedPreparedStatement	setNull(int idx, int sqlType)	See PreparedStatement.setNull(int, int).
DelayedPreparedStatement	setObject(int idx, @Nullable Object obj, int targetSqlType)	See PreparedStatement.setObject(int, Object, int).
DelayedPreparedStatement	setRawString(int idx, String obj)	Replaces a '?'
DelayedPreparedStatement	setShort(int idx, short obj)	See PreparedStatement.setShort(int, short).
DelayedPreparedStatement	setString(int idx, @Nullable String obj)	See PreparedStatement.setString(int, String).
DelayedPreparedStatement	setTime(int idx, @Nullable Time obj)	See PreparedStatement.setTime(int, Time).
DelayedPreparedStatement	setTimestamp(int idx, @Nullable Timestamp obj)	See PreparedStatement.setTimestamp(int, Timestamp).
String	toString()

Methods inherited from class Object

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

Constructor Details

DelayedPreparedStatement

public DelayedPreparedStatement(SQLStatement sqlStatement)

Constructs a new DelayedPreparedStatement.

It counts the number of variables ('?' characters) in the statement.

Parameters:

sqlStatement - The SQL statement.

Method Details

toString

public String toString()

Overrides:

toString in class Object

construct

public PreparedStatement construct(Connection conn)
                            throws SQLException

Constructs a PreparedStatement from this DelayedPreparedStatement, applying all variables as defined up to this point.

Parameters:

conn - A connection to a database.

Returns:

The constructed PreparedStatement.

Throws:

SQLException - if a database access error occurs or this method is called on a closed connection.

construct

public PreparedStatement construct(Connection conn,
 int autoGeneratedKeys)
                            throws SQLException

Constructs a PreparedStatement from this DelayedPreparedStatement, applying all variables as defined up to this point.

Parameters:

conn - A connection to a database.

autoGeneratedKeys - A flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

Returns:

The constructed PreparedStatement.

Throws:

SQLException - if a database access error occurs or this method is called on a closed connection.

setNextRawString

public DelayedPreparedStatement setNextRawString(String obj)

Shortcut for setRawString(int, String) with the current index.

Read the documentation of setRawString(int, String) to understand the implications of using this method.

Parameters:

obj - The name of the table.

Returns:

This DelayedPreparedStatement.

setRawString

public DelayedPreparedStatement setRawString(int idx,
 String obj)

Replaces a '?' at the given index with a raw String. Unlike all other types, this is executed before constructing the actual PreparedStatement and modifies statement.

Note that you'll have to make sure that the String is sanitized and valid. For example, when using it to specify the name of a table, the name must comply with IStorage.isValidTableName(String). This means that only alphanumerics characters and the underscore character are allowed.

Most importantly: When using this method, it MUST BE USED in the correct order. Variables that should be set before should be added before and those that should be set after should be added after.

Parameters:

idx - The index of the variable character (= "?") in the statement that should be replaced by the table name.

obj - The name of the table.

Returns:

This DelayedPreparedStatement.

setNextBoolean

public DelayedPreparedStatement setNextBoolean(boolean obj)

See PreparedStatement.setBoolean(int, boolean).

The index used is simply the one following from the previous set action.

Parameters:

obj - The boolean to set.

Returns:

This DelayedPreparedStatement.

setBoolean

public DelayedPreparedStatement setBoolean(int idx,
 boolean obj)

See PreparedStatement.setBoolean(int, boolean).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The boolean to set.

Returns:

This DelayedPreparedStatement.

setNextByte

public DelayedPreparedStatement setNextByte(byte obj)

See PreparedStatement.setByte(int, byte).

The index used is simply the one following from the previous set action.

Parameters:

obj - The byte to set.

Returns:

This DelayedPreparedStatement.

setByte

public DelayedPreparedStatement setByte(int idx,
 byte obj)

See PreparedStatement.setByte(int, byte).

Returns:

This DelayedPreparedStatement.

setNextShort

public DelayedPreparedStatement setNextShort(short obj)

See PreparedStatement.setShort(int, short).

The index used is simply the one following from the previous set action.

Parameters:

obj - The short to set.

Returns:

This DelayedPreparedStatement.

setShort

public DelayedPreparedStatement setShort(int idx,
 short obj)

See PreparedStatement.setShort(int, short).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The short to set.

Returns:

This DelayedPreparedStatement.

setNextInt

public DelayedPreparedStatement setNextInt(int obj)

See PreparedStatement.setInt(int, int).

The index used is simply the one following from the previous set action.

Parameters:

obj - The int to set.

Returns:

This DelayedPreparedStatement.

setInt

public DelayedPreparedStatement setInt(int idx,
 int obj)

See PreparedStatement.setInt(int, int).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The int to set.

Returns:

This DelayedPreparedStatement.

setNextLong

public DelayedPreparedStatement setNextLong(long obj)

See PreparedStatement.setLong(int, long).

The index used is simply the one following from the previous set action.

Parameters:

obj - The long to set.

Returns:

This DelayedPreparedStatement.

setLong

public DelayedPreparedStatement setLong(int idx,
 long obj)

See PreparedStatement.setLong(int, long).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The long to set.

Returns:

This DelayedPreparedStatement.

setNextFloat

public DelayedPreparedStatement setNextFloat(float obj)

See PreparedStatement.setFloat(int, float).

The index used is simply the one following from the previous set action.

Parameters:

obj - The float to set.

Returns:

This DelayedPreparedStatement.

setFloat

public DelayedPreparedStatement setFloat(int idx,
 float obj)

See PreparedStatement.setFloat(int, float).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The float to set.

Returns:

This DelayedPreparedStatement.

setNextDouble

public DelayedPreparedStatement setNextDouble(double obj)

See PreparedStatement.setDouble(int, double).

The index used is simply the one following from the previous set action.

Parameters:

obj - The double to set.

Returns:

This DelayedPreparedStatement.

setDouble

public DelayedPreparedStatement setDouble(int idx,
 double obj)

See PreparedStatement.setDouble(int, double).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The double to set.

Returns:

This DelayedPreparedStatement.

setNextBigDecimal

public DelayedPreparedStatement setNextBigDecimal(@Nullable BigDecimal obj)

See PreparedStatement.setBigDecimal(int, BigDecimal).

The index used is simply the one following from the previous set action.

Parameters:

obj - The BigDecimal to set.

Returns:

This DelayedPreparedStatement.

setBigDecimal

public DelayedPreparedStatement setBigDecimal(int idx,
 @Nullable BigDecimal obj)

See PreparedStatement.setBigDecimal(int, BigDecimal).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The BigDecimal to set.

Returns:

This DelayedPreparedStatement.

setNextString

public DelayedPreparedStatement setNextString(@Nullable String obj)

See PreparedStatement.setString(int, String).

The index used is simply the one following from the previous set action.

Parameters:

obj - The string to set.

Returns:

This DelayedPreparedStatement.

setString

public DelayedPreparedStatement setString(int idx,
 @Nullable String obj)

See PreparedStatement.setString(int, String).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The string to set.

Returns:

This DelayedPreparedStatement.

setNextBytes

public DelayedPreparedStatement setNextBytes(byte[] obj)

See PreparedStatement.setBytes(int, byte[]).

The index used is simply the one following from the previous set action.

Parameters:

obj - The bytes to set.

Returns:

This DelayedPreparedStatement.

setBytes

public DelayedPreparedStatement setBytes(int idx,
 byte[] obj)

See PreparedStatement.setBytes(int, byte[]).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The bytes to set.

Returns:

This DelayedPreparedStatement.

setNextDate

public DelayedPreparedStatement setNextDate(@Nullable Date obj)

See PreparedStatement.setDate(int, Date).

The index used is simply the one following from the previous set action.

Parameters:

obj - The date to set.

Returns:

This DelayedPreparedStatement.

setDate

public DelayedPreparedStatement setDate(int idx,
 @Nullable Date obj)

See PreparedStatement.setDate(int, Date).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The date to set.

Returns:

This DelayedPreparedStatement.

setNextTime

public DelayedPreparedStatement setNextTime(@Nullable Time obj)

See PreparedStatement.setTime(int, Time).

The index used is simply the one following from the previous set action.

Parameters:

obj - The time to set.

Returns:

This DelayedPreparedStatement.

setTime

public DelayedPreparedStatement setTime(int idx,
 @Nullable Time obj)

See PreparedStatement.setTime(int, Time).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The time to set.

Returns:

This DelayedPreparedStatement.

setNextTimestamp

public DelayedPreparedStatement setNextTimestamp(@Nullable Timestamp obj)

See PreparedStatement.setTimestamp(int, Timestamp).

The index used is simply the one following from the previous set action.

Parameters:

obj - The timestamp to set.

Returns:

This DelayedPreparedStatement.

setTimestamp

public DelayedPreparedStatement setTimestamp(int idx,
 @Nullable Timestamp obj)

See PreparedStatement.setTimestamp(int, Timestamp).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The timestamp to set.

Returns:

This DelayedPreparedStatement.

setNextObject

public DelayedPreparedStatement setNextObject(@Nullable Object obj,
 int targetSqlType)

See PreparedStatement.setObject(int, Object, int).

The index used is simply the one following from the previous set action.

Parameters:

obj - The object to set.

targetSqlType - The SQL type to send to the database as defined in Types.

Returns:

This DelayedPreparedStatement.

setObject

public DelayedPreparedStatement setObject(int idx,
 @Nullable Object obj,
 int targetSqlType)

See PreparedStatement.setObject(int, Object, int).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

obj - The object to set.

targetSqlType - The SQL type to send to the database as defined in Types.

Returns:

This DelayedPreparedStatement.

setNextNull

public DelayedPreparedStatement setNextNull(int sqlType)

See PreparedStatement.setNull(int, int).

The index used is simply the one following from the previous set action.

Parameters:

sqlType - The SQL type to send to the database as defined in Types.

Returns:

This DelayedPreparedStatement.

setNull

public DelayedPreparedStatement setNull(int idx,
 int sqlType)

See PreparedStatement.setNull(int, int).

Parameters:

idx - The parameter index. The first parameter is 1, the second is 2, ...

sqlType - The SQL type to send to the database as defined in Types.

Returns:

This DelayedPreparedStatement.