com.goldencode.p2j.persist.orm

Class SQLExecutor

java.lang.Object

com.goldencode.p2j.persist.orm.SQLExecutor

public class SQLExecutor
extends java.lang.Object

Class responsible with executing SQLs. If logging is intended, then the execution job will be passed to SQLStatementLogger.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SQLExecutor.BiConsumerWithException<T,U> Functional interface, similar to BiConsumer, but with the capability to throw an Exception.
static interface	SQLExecutor.ConsumerWithException<T> Functional interface, similar to Consumer, but with the capability to throw an Exception.
static interface	SQLExecutor.DMLStatement A more specific ConsumerWithException, applied to PreparedStatement only.
static interface	SQLExecutor.FunctionWithException<T,R> Functional interface, similar to Function, but with the capability to throw an Exception.
static interface	SQLExecutor.LambdaLogger Basic interface that groups the functional interfaces used for logging statements.
protected static class	SQLExecutor.LambdaLoggerType Enumeration used to distinguish between different SQLExecutor.LambdaLoggers.
static interface	SQLExecutor.QueryStatement A more specific FunctionWithException, applied to PreparedStatement and ResultSet only.
static interface	SQLExecutor.UpdateBatchStatement A more specific FunctionWithException, applied to PreparedStatement and int[] only.
static interface	SQLExecutor.UpdateStatement A more specific FunctionWithException, applied to PreparedStatement and Integer only.

Field Summary

Fields

Modifier and Type	Field and Description
private int	defaultBatchSize Usually, SQLs are executed one by one.
private static SQLExecutor	instance The static singleton instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SQLExecutor() The private default constructor.

Method Summary

Modifier and Type	Method and Description
<T,U> void	execute(Database database, SQLExecutor.BiConsumerWithException<T,U> r, T receiver, U otherReceiver) Logs a statement for a database.
<T> void	execute(Database database, java.lang.String sql, SQLExecutor.ConsumerWithException<T> r, T receiver) Logs a statement for a database.
<T> void	execute(Database database, java.lang.String sql, SQLExecutor.ConsumerWithException<T> r, T receiver, int batchSize) Logs a statement for a database.
<T,U> U	execute(Database database, java.lang.String sql, SQLExecutor.FunctionWithException<T,U> r, T receiver) Logs a statement for a database.
private <T,U> U	execute(Database database, java.lang.String sql, SQLExecutor.LambdaLogger r, T receiver, U otherReceiver, int batchSize, SQLExecutor.LambdaLoggerType type) Logs a statement for a database.
private <T,U> U	executeImpl(SQLExecutor.LambdaLogger r, T receiver, U otherReceiver, SQLExecutor.LambdaLoggerType type)
static SQLExecutor	getInstance() Static accessor to singleton.

Methods inherited from class java.lang.Object

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

Field Detail

instance

private static final SQLExecutor instance

The static singleton instance.

defaultBatchSize

private final int defaultBatchSize

Usually, SQLs are executed one by one. There are methods that take care of SQLs executed in proper batches.

See Also:

Constant Field Values

Constructor Detail

SQLExecutor

private SQLExecutor()

The private default constructor.

Method Detail

getInstance

public static SQLExecutor getInstance()

Static accessor to singleton.

Returns:

The SQLExecutor singleton instance.

execute

public <T> void execute(Database database,
                        java.lang.String sql,
                        SQLExecutor.ConsumerWithException<T> r,
                        T receiver)
                 throws java.sql.SQLException

Logs a statement for a database. If the actions for this Database are disabled the method will return without printing anything.

Type Parameters:

T - The statement type.

Parameters:

database - The reference Database.

sql - String representing the SQL used in the statement.

r - A SQLExecutor.ConsumerWithException that handles the execution of a statement.

receiver - Receiver denoting the statement that will be executed.

Throws:

java.sql.SQLException

execute

public <T> void execute(Database database,
                        java.lang.String sql,
                        SQLExecutor.ConsumerWithException<T> r,
                        T receiver,
                        int batchSize)
                 throws java.sql.SQLException

Logs a statement for a database. If the actions for this Database are disabled the method will return without printing anything.

Type Parameters:

T - The statement type.

Parameters:

database - The reference Database.

sql - String representing the SQL used in the statement.

r - A SQLExecutor.ConsumerWithException that handles the execution of a statement.

receiver - Receiver denoting the statement that will be executed.

batchSize - How many SQLs are executed in this batch.

Throws:

java.sql.SQLException

execute

public <T,U> void execute(Database database,
                          SQLExecutor.BiConsumerWithException<T,U> r,
                          T receiver,
                          U otherReceiver)
                   throws java.sql.SQLException

Logs a statement for a database. If the actions for this Database are disabled the method will return without printing anything. It will use the toString() method of the Statement.

Type Parameters:

T - The statement type.

U - The argument type.

Parameters:

database - The reference Database.

r - A SQLExecutor.BiConsumerWithException that handles the execution of a statement with a parameter.

receiver - Receiver denoting the statement that will be executed.

otherReceiver - The parameter that will be given to the execution.

Throws:

java.sql.SQLException

execute

public <T,U> U execute(Database database,
                       java.lang.String sql,
                       SQLExecutor.FunctionWithException<T,U> r,
                       T receiver)
                throws java.sql.SQLException

Logs a statement for a database. If the actions for this Database are disabled the method will return without printing anything. It will use the toString() method of the Statement.

Type Parameters:

T - The statement type.

U - The result type.

Parameters:

database - The reference Database.

sql - The SQL used in the statement.

r - SQLExecutor.FunctionWithException that handles the execution of a statement and returns a result.

receiver - Receiver denoting the statement that will be executed.

Returns:

The result generated by the execution of the statement.

Throws:

java.sql.SQLException

execute

private <T,U> U execute(Database database,
                        java.lang.String sql,
                        SQLExecutor.LambdaLogger r,
                        T receiver,
                        U otherReceiver,
                        int batchSize,
                        SQLExecutor.LambdaLoggerType type)
                 throws java.sql.SQLException

Logs a statement for a database. If the actions for this Database are disabled the method will return without printing anything.

Type Parameters:

T - The statement type.

U - The argument type or the result type, depending on LambaLoggerType.

Parameters:

database - The reference Database.

sql - The SQL used in the statement.

r - A SQLExecutor.LambdaLoggerType that handles the execution of a statement.

receiver - Receiver denoting the statement that will be executed.

otherReceiver - The parameter that will be given to the execution.

batchSize - How many SQLs are executed in this batch.

type - The type of the receiver.

Returns:

The result generated by the execution of the statement, if requested, or null otherwise.

Throws:

java.sql.SQLException

executeImpl

private <T,U> U executeImpl(SQLExecutor.LambdaLogger r,
                            T receiver,
                            U otherReceiver,
                            SQLExecutor.LambdaLoggerType type)
                     throws java.sql.SQLException

Type Parameters:

T - The statement type.

U - The argument type or the result type, depending on LambaLoggerType.

Parameters:

r - A SQLExecutor.LambdaLoggerType that handles the execution of a statement.

receiver - Receiver denoting the statement that will be executed.

otherReceiver - The parameter that will be given to the execution.

type - The type of the receiver.

Returns:

U The result.

Throws:

java.sql.SQLException