Package com.saperion.common.sql

Class SimpleDataSource<CommonReadResultException extends Exception>

java.lang.Object

com.saperion.common.sql.DataSource<IllegalStateException,CommonReadResultException>

com.saperion.common.sql.SimpleDataSource<CommonReadResultException>

Type Parameters:

CommonReadResultException - common type of all used ResultReaders during DataSource.executeQuery(String, ResultReader) -operations to signal business-exceptions during ResultReader.readResult(ResultSet)

public class SimpleDataSource<CommonReadResultException extends Exception>
extends DataSource<IllegalStateException,CommonReadResultException>

SimpleDataSource is a simple implementation of an DataSource that can be used directly and that has no logging, no runtime-information and treats all errors as IllegalStateExceptions. While this class is easy to use, it is still strongly recommended to write your own subclass of DataSource in any real project to provide improved treatment.

Author:

agz

Field Summary

Fields inherited from class com.saperion.common.sql.DataSource

LOGGER

Constructor Summary

Constructors

Constructor	Description
SimpleDataSource(DataSource dataSource)	Creates a new SimpleDataSource encapsulating the specified DataSource.

Method Summary

Modifier and Type	Method	Description
protected void	afterExecuteQuery(String sql)	This event-method is called immediately after Statement.executeQuery(String) was successfully called.
protected void	afterExecuteUpdate(String sql, int rowCount)	This event-method is called immediately after Statement.executeUpdate(String) was successfully called.
protected void	afterReadResult(String sql, int rowCount)	This event-method is called immediately after ResultReader.readResult(ResultSet) was successfully called.It is called after DataSource.noteReadResultTime(String, long, boolean).
protected void	beforeExecuteQuery(String sql)	This event-method is called immediately before Statement.executeQuery(String) is called.
protected void	beforeExecuteUpdate(String sql)	This event-method is called immediately before Statement.executeUpdate(String) is called.
protected void	beforeReadResult(String sql)	This event-method is called immediately before ResultReader.readResult(ResultSet) is called.
protected void	noteExecuteQueryTime(String sql, long timeNanoseconds, boolean success)	This event-method is called immediately after Statement.executeQuery(String) is called, no matter whether the call was successful or not.
protected void	noteExecuteUpdateTime(String sql, long timeNanoseconds, boolean success)	This event-method is called immediately after Statement.executeUpdate(String) is called, no matter whether the call was successful or not.
protected void	noteReadResultTime(String sql, long timeNanoseconds, boolean success)	This event-method is called immediately after ResultReader.readResult(ResultSet) is called, no matter whether the call was successful or not.
protected IllegalStateException	onErrorCreatingStatement(Throwable t, String sql)	This event-method is called by all SQL-execution-methods if there is no Statement available from the underlying Connection.
protected IllegalStateException	onErrorExecutingQuery(Throwable t, String sql)	This event-method is called by DataSource.executeQuery(String, ResultReader) if there is any error executing the statement.
protected IllegalStateException	onErrorExecutingUpdate(Throwable t, String sql)	This event-method is called by DataSource.executeUpdate(String) if there is any error executing the statement.
protected IllegalStateException	onErrorGettingConnection(Throwable t, String sql)	This event-method is called by all SQL-execution-methods if there is no Connection available from the underlying DataSource.
protected IllegalStateException	onErrorGettingDatabaseProductName(Throwable t)	This event-method is called by DataSource.getSqlDialect() if there is any error getting the database product name.
protected IllegalStateException	onErrorGettingMetaData(Throwable t)	This event-method is called by DataSource.getSqlDialect() if there is any error getting the DatabaseMetaData.
protected IllegalStateException	onErrorReadingResultSet(Throwable t, String sql)	This event-method is called by DataSource.executeQuery(String, ResultReader) if there is any error reading the ResultSet.

Methods inherited from class com.saperion.common.sql.DataSource

executeQuery, executeUpdate, getSqlDataSource, getSqlDialect

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleDataSource

public SimpleDataSource(DataSource dataSource)

Creates a new SimpleDataSource encapsulating the specified DataSource.

The specified DataSource must not be null.

Parameters:

dataSource - underlying DataSource

Method Details

onErrorGettingConnection

protected IllegalStateException onErrorGettingConnection(Throwable t,
 String sql)

Description copied from class: DataSource

This event-method is called by all SQL-execution-methods if there is no Connection available from the underlying DataSource. This method must return a suitable Exception.

Specified by:

onErrorGettingConnection in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by DataSource.getConnection()

sql - SQL-statement of the SQL-execution-method

Returns:

a suitable Exception

onErrorCreatingStatement

protected IllegalStateException onErrorCreatingStatement(Throwable t,
 String sql)

Description copied from class: DataSource

This event-method is called by all SQL-execution-methods if there is no Statement available from the underlying Connection. This method must return a suitable Exception.

Specified by:

onErrorCreatingStatement in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by Connection.createStatement()

sql - SQL-statement of the SQL-execution-method

Returns:

a suitable Exception

onErrorExecutingQuery

protected IllegalStateException onErrorExecutingQuery(Throwable t,
 String sql)

Description copied from class: DataSource

This event-method is called by DataSource.executeQuery(String, ResultReader) if there is any error executing the statement. This method must return a suitable Exception.

Specified by:

onErrorExecutingQuery in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by Statement.executeQuery(String)

sql - SQL-statement of the SQL-execution-method

Returns:

a suitable Exception

onErrorExecutingUpdate

protected IllegalStateException onErrorExecutingUpdate(Throwable t,
 String sql)

Description copied from class: DataSource

This event-method is called by DataSource.executeUpdate(String) if there is any error executing the statement. This method must return a suitable Exception.

Specified by:

onErrorExecutingUpdate in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by Statement.executeUpdate(String)

sql - SQL-statement of the SQL-execution-method

Returns:

a suitable Exception

onErrorReadingResultSet

protected IllegalStateException onErrorReadingResultSet(Throwable t,
 String sql)

Description copied from class: DataSource

This event-method is called by DataSource.executeQuery(String, ResultReader) if there is any error reading the ResultSet. This method must return a suitable Exception.

Specified by:

onErrorReadingResultSet in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by any of the ResultSet.get...()-methods

sql - SQL-statement of the SQL-execution-method

Returns:

a suitable Exception

onErrorGettingMetaData

protected IllegalStateException onErrorGettingMetaData(Throwable t)

Description copied from class: DataSource

This event-method is called by DataSource.getSqlDialect() if there is any error getting the DatabaseMetaData. This method must return a suitable Exception.

Specified by:

onErrorGettingMetaData in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by Connection.getMetaData()

Returns:

a suitable Exception

onErrorGettingDatabaseProductName

protected IllegalStateException onErrorGettingDatabaseProductName(Throwable t)

Description copied from class: DataSource

This event-method is called by DataSource.getSqlDialect() if there is any error getting the database product name. This method must return a suitable Exception.

Specified by:

onErrorGettingDatabaseProductName in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

t - original Throwable thrown by DatabaseMetaData.getDatabaseProductName()

Returns:

a suitable Exception

beforeExecuteUpdate

protected void beforeExecuteUpdate(String sql)

Description copied from class: DataSource

This event-method is called immediately before Statement.executeUpdate(String) is called.

Specified by:

beforeExecuteUpdate in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

noteExecuteUpdateTime

protected void noteExecuteUpdateTime(String sql,
 long timeNanoseconds,
 boolean success)

Description copied from class: DataSource

This event-method is called immediately after Statement.executeUpdate(String) is called, no matter whether the call was successful or not.

Specified by:

noteExecuteUpdateTime in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

timeNanoseconds - the execution-time of Statement.executeUpdate(String) in nanoseconds, no matter whether the call was successful or not

success - indicates whether the call was successful or not

afterExecuteUpdate

protected void afterExecuteUpdate(String sql,
 int rowCount)

Description copied from class: DataSource

This event-method is called immediately after Statement.executeUpdate(String) was successfully called. It is called after DataSource.noteExecuteUpdateTime(String, long, boolean).

Specified by:

afterExecuteUpdate in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

rowCount - count of manipulated rows

beforeExecuteQuery

protected void beforeExecuteQuery(String sql)

Description copied from class: DataSource

This event-method is called immediately before Statement.executeQuery(String) is called.

Specified by:

beforeExecuteQuery in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

noteExecuteQueryTime

protected void noteExecuteQueryTime(String sql,
 long timeNanoseconds,
 boolean success)

Description copied from class: DataSource

This event-method is called immediately after Statement.executeQuery(String) is called, no matter whether the call was successful or not.

Specified by:

noteExecuteQueryTime in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

timeNanoseconds - the execution-time of Statement.executeQuery(String) in nanoseconds, no matter whether the call was successful or not

success - indicates whether the call was successful or not

afterExecuteQuery

protected void afterExecuteQuery(String sql)

Description copied from class: DataSource

This event-method is called immediately after Statement.executeQuery(String) was successfully called. It is called after DataSource.noteExecuteQueryTime(String, long, boolean).

Specified by:

afterExecuteQuery in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

beforeReadResult

protected void beforeReadResult(String sql)

Description copied from class: DataSource

This event-method is called immediately before ResultReader.readResult(ResultSet) is called.

Specified by:

beforeReadResult in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

noteReadResultTime

protected void noteReadResultTime(String sql,
 long timeNanoseconds,
 boolean success)

Description copied from class: DataSource

This event-method is called immediately after ResultReader.readResult(ResultSet) is called, no matter whether the call was successful or not.

Specified by:

noteReadResultTime in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

timeNanoseconds - the execution-time of ResultReader.readResult(ResultSet) in nanoseconds, no matter whether the call was successful or not

success - indicates whether the call was successful or not

afterReadResult

protected void afterReadResult(String sql,
 int rowCount)

Description copied from class: DataSource

This event-method is called immediately after ResultReader.readResult(ResultSet) was successfully called.It is called after DataSource.noteReadResultTime(String, long, boolean).

Specified by:

afterReadResult in class DataSource<IllegalStateException,CommonReadResultException extends Exception>

Parameters:

sql - SQL-statement of the SQL-execution-method

rowCount - count of selected rows