Module org.tquadrat.foundation.sql

Package org.tquadrat.foundation.sql.internal

Class EnhancedPreparedStatementImpl

java.lang.Object

org.tquadrat.foundation.sql.internal.EnhancedPreparedStatementBase

org.tquadrat.foundation.sql.internal.EnhancedPreparedStatementImpl

All Implemented Interfaces:

AutoCloseable, EnhancedPreparedStatement

@ClassVersion(sourceVersion="$Id: EnhancedPreparedStatementImpl.java 1100 2024-02-16 23:33:45Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class EnhancedPreparedStatementImpl
extends EnhancedPreparedStatementBase

The implementation for EnhancedPreparedStatement.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: EnhancedPreparedStatementImpl.java 1100 2024-02-16 23:33:45Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.sql.internal.EnhancedPreparedStatementImpl"

⁠

Nested Class Summary

Nested classes/interfaces inherited from class org.tquadrat.foundation.sql.internal.EnhancedPreparedStatementBase

EnhancedPreparedStatementBase.ParameterMetaDataImpl

Nested classes/interfaces inherited from interface org.tquadrat.foundation.sql.EnhancedPreparedStatement

EnhancedPreparedStatement.StatementLogger

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	m_AddStacktrace	Flag that controls whether a stack trace should be added to the log output.
private static BooleanSupplier	m_LogCheck	The log check method.
private static EnhancedPreparedStatement.StatementLogger	m_Logger	The logger method.
private static final Pattern	m_VariablePattern	The pattern that is used to identify a variable in a SQL statement text.

Fields inherited from interface org.tquadrat.foundation.sql.EnhancedPreparedStatement

VARIABLE_PATTERN

Constructor Summary

Constructors

Constructor	Description
EnhancedPreparedStatementImpl(String sourceStatement, PreparedStatement preparedStatement, Map<String,int[]> parameterIndex)	Creates a new instance of EnhancedPreparedStatementImpl.

Method Summary

Modifier and Type	Method	Description
protected final boolean	addStacktrace()	Returns a flag that indicates whether a stacktrace should be added to the logging.
static final Map<String,int[]>	convertIndexBufferToParameterIndex(Map<String,? extends List<Integer>> indexBuffer)	Converts the index buffer to a parameter index.
static final EnhancedPreparedStatementImpl	create(Connection connection, String sql)	Creates a new instance of EnhancedPreparedStatementImpl.
protected final void	doLogging(String operation, StackTraceElement[] stackTrace)	Composes the log information and sends it.
static final void	enableLogging(EnhancedPreparedStatement.StatementLogger logger, BooleanSupplier logCheck, boolean addStacktrace)	Enables the logging output for the EnhancedPreparedStatement instances.
final boolean	isLoggingEnabled()	Checks whether logging is currently enabled.
static final String	parseSQL(String sql, Map<? super String,List<Integer>> indexBuffer)	Parses the given SQL statement with the named placeholders and returns the text for a call to Connection.prepareStatement(String).

Methods inherited from class org.tquadrat.foundation.sql.internal.EnhancedPreparedStatementBase

addBatch, cancel, clearBatch, clearParameters, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeQuery, executeUpdate, getConnection, getCurrentValues, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMetaData, getMoreResults, getMoreResults, getParameterIndexes, getParameterMetaData, getParameterNames, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getSourceStatement, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setCursorName, setDate, setDate, setDouble, setFetchDirection, setFetchSize, setFloat, setInt, setLargeMaxRows, setLong, setMaxFieldSize, setMaxRows, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setQueryTimeout, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setURL

Methods inherited from class java.lang.Object

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

Field Details

m_AddStacktrace

private static boolean m_AddStacktrace

Flag that controls whether a stack trace should be added to the log output.

m_LogCheck

private static BooleanSupplier m_LogCheck

The log check method.

m_Logger

private static EnhancedPreparedStatement.StatementLogger m_Logger

The logger method.

m_VariablePattern

private static final Pattern m_VariablePattern

The pattern that is used to identify a variable in a SQL statement text.

Constructor Details

EnhancedPreparedStatementImpl

public EnhancedPreparedStatementImpl(String sourceStatement,
 PreparedStatement preparedStatement,
 Map<String,int[]> parameterIndex)

Creates a new instance of EnhancedPreparedStatementImpl.

Parameters:

sourceStatement - The original SQL statement with the placeholders; mainly used for logging purposes.

preparedStatement - The wrapped instance of PreparedStatement.

parameterIndex - The mapping for the named placeholders to the position based placeholders.

Method Details

addStacktrace

protected final boolean addStacktrace()

Returns a flag that indicates whether a stacktrace should be added to the logging.

Specified by:

addStacktrace in class EnhancedPreparedStatementBase

Returns:

true if the stacktrace should be created and added, false otherwise.

convertIndexBufferToParameterIndex

@API(status=INTERNAL,
     since="0.1.0")
public static final Map<String,int[]> convertIndexBufferToParameterIndex(Map<String,? extends List<Integer>> indexBuffer)

Converts the index buffer to a parameter index.

Note:

• The method is public to allow simpler Unit tests.

Parameters:

indexBuffer - The index buffer.

Returns:

The parameter index.

create

@API(status=MAINTAINED,
     since="0.1.0")
public static final EnhancedPreparedStatementImpl create(Connection connection,
 String sql)
                                                  throws SQLException

Creates a new instance of EnhancedPreparedStatementImpl.

Parameters:

connection - The connection to the database.

sql - The text of the SQL statement with the placeholders.

Returns:

The new statement.

Throws:

SQLException - Unable to create an instance of an EnhancedPreparedStatement.

doLogging

protected final void doLogging(String operation,
 StackTraceElement[] stackTrace)

Composes the log information and sends it.

Specified by:

doLogging in class EnhancedPreparedStatementBase

Parameters:

operation - The operation that logs.

stackTrace - The stack trace; can be null.

enableLogging

public static final void enableLogging(EnhancedPreparedStatement.StatementLogger logger,
 BooleanSupplier logCheck,
 boolean addStacktrace)

Enables the logging output for the EnhancedPreparedStatement instances.

The logger method takes three arguments:

1. operation – The name of the operation that logs.
2. statement – The source of the prepared statement.
3. values – A list of the values in the format

   <name> [<type>]:<value>

   A type of NULL indicates an unknown type; for large values (like Blob or Reader) only the class is given instead of the real value.
4. stacktrace – The stacktrace; will be null if addStacktrace is false.

The logCheck method returns true only when logging should be done. No information is collected while it returns false. As the method is called for nearly any operation, its implementation should be as efficient as possible.

Parameters:

logger - The method that takes the logging information.

logCheck - The method that returns a flag whether log output is desired.

addStacktrace - true if the stacktrace should be added to the log output.

isLoggingEnabled

public final boolean isLoggingEnabled()

Checks whether logging is currently enabled.

Specified by:

isLoggingEnabled in interface EnhancedPreparedStatement

Specified by:

isLoggingEnabled in class EnhancedPreparedStatementBase

Returns:

true if logging is enabled and log information have to be collected, false otherwise.

parseSQL

@API(status=INTERNAL,
     since="0.1.0")
public static final String parseSQL(String sql,
 Map<? super String,List<Integer>> indexBuffer)

Parses the given SQL statement with the named placeholders and returns the text for a call to Connection.prepareStatement(String).

Note:

• The method is public to allow simpler Unit tests.

Parameters:

sql - The source text for the SQL statement.

indexBuffer - The mapping from the names to the indexes.

Returns:

The target SQL text.