com.goldencode.p2j.persist.orm

Class SQLStatementLogger

java.lang.Object

com.goldencode.p2j.persist.orm.PersistenceLogger

com.goldencode.p2j.persist.orm.SQLStatementLogger

public class SQLStatementLogger
extends PersistenceLogger

A logger object is used to log messages for a database events. Primarily, the SQL commands are targeted, but any other event can be logged as well. The object will log each event/statement to a stream using its database as reference. The databases can be configured independently, as result all events for a specific database will go to the associates stream. Alternatively, a database can be disabled, leading to all its events being muted. To be able to log data for any database, the logger must be activated in directory.xml at DIR_PATH location because, by default, global logging is disabled. The object itself allows a bit of configuration: with or without a timestamp and the specific one, using the simple date format.

Field Summary

Fields

Modifier and Type	Field and Description
private static SQLStatementLogger	logger The static singleton instance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SQLStatementLogger	getLogger() Static accessor to singleton.
protected <T,U> void	log(java.lang.String databaseName, java.lang.String statement, boolean isFullStatement, SQLStatementLoggerConfiguration config, int batchSize, java.lang.Double profilingTime) Log something using a Database as reference.
private void	simplify(java.lang.String statement, java.lang.StringBuilder sb) Simplifies a statement in order to fit on a single line.

Methods inherited from class com.goldencode.p2j.persist.orm.PersistenceLogger

getStackMethodParent

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final SQLStatementLogger logger

The static singleton instance.

Constructor Detail

SQLStatementLogger

private SQLStatementLogger()

The private default constructor.

Method Detail

getLogger

public static SQLStatementLogger getLogger()

Static accessor to singleton.

Returns:

The SQLStatementLogger singleton instance.

log

protected <T,U> void log(java.lang.String databaseName,
                         java.lang.String statement,
                         boolean isFullStatement,
                         SQLStatementLoggerConfiguration config,
                         int batchSize,
                         java.lang.Double profilingTime)
                  throws java.sql.SQLException

Log something using a Database as reference. The method use the settings specific to this database, as previously set. If the LOGGING_ENABLED is not active, this method will not be called at all.

When called the first time for a specific database, it will query the registry to see whether that database has the logging logic enabled. This flag will be saved for further calls. It can be programmatically altered by using setEnabled() API.

Type Parameters:

T - The statement type.

U - Either the argument type or the result type.

Parameters:

databaseName - The name of the Database.

statement - The statement used.

isFullStatement - Flag that denotes whether the statement contains parameter values or not.

config - The logging configuration for this database.

batchSize - How many SQLs are in this batch.

profilingTime - The execution time of the SQL query.

Throws:

java.sql.SQLException

simplify

private void simplify(java.lang.String statement,
                      java.lang.StringBuilder sb)

Simplifies a statement in order to fit on a single line. New-lines are dropped and replaced with simple spaces.

Parameters:

statement - The statement to be printed. It eventually takes multiple lines.

sb - The StringBuilder to append the result to.