Package com.github.ddth.dao.jdbc

Class AbstractJdbcHelper

java.lang.Object

com.github.ddth.dao.jdbc.AbstractJdbcHelper

All Implemented Interfaces:

IJdbcHelper, java.lang.AutoCloseable

Direct Known Subclasses:

DdthJdbcHelper, JdbcTemplateJdbcHelper

public abstract class AbstractJdbcHelper
extends java.lang.Object
implements IJdbcHelper, java.lang.AutoCloseable

Abstract implementation of IJdbcHelper.

Since:

0.8.0

Author:

Thanh Nguyen

Field Summary

Fields inherited from interface com.github.ddth.dao.jdbc.IJdbcHelper

DEFAULT_DATASOURCE

Constructor Summary

Constructors

Constructor	Description
AbstractJdbcHelper()

Method Summary

Modifier and Type	Method	Description
protected int	calcFetchSizeForStream(int hintFetchSize, java.sql.Connection conn)	Calculate fetch size used for streaming.
void	close()
boolean	commitTransaction(java.sql.Connection conn)	Commit a transaction.
void	destroy()	Destroying method.
int	execute(java.lang.String sql, java.lang.Object... bindValues)	Execute a non-SELECT statement.
int	execute(java.lang.String sql, java.util.Map<java.lang.String,?> bindValues)	Execute a non-SELECT statement.
<T> java.util.List<T>	executeSelect(IRowMapper<T> rowMapper, java.lang.String sql, java.lang.Object... bindValues)	Execute a SELECT statement.
<T> java.util.List<T>	executeSelect(IRowMapper<T> rowMapper, java.lang.String sql, java.util.Map<java.lang.String,?> bindValues)	Execute a SELECT statement.
<T> java.util.stream.Stream<T>	executeSelectAsStream(IRowMapper<T> rowMapper, java.sql.Connection conn, boolean autoCloseConnection, int fetchSize, java.lang.String sql, java.lang.Object... bindValues)	Execute a SELECT statement and return result as a Stream.
<T> java.util.stream.Stream<T>	executeSelectAsStream(IRowMapper<T> rowMapper, java.sql.Connection conn, boolean autoCloseConnection, int fetchSize, java.lang.String sql, java.util.Map<java.lang.String,?> bindValues)	Execute a SELECT statement and return result as a Stream.
<T> T	executeSelectOne(IRowMapper<T> rowMapper, java.lang.String sql, java.lang.Object... bindValues)	Execute a SELECT statement and fetch one row.
<T> T	executeSelectOne(IRowMapper<T> rowMapper, java.lang.String sql, java.util.Map<java.lang.String,?> bindValues)	Execute a SELECT statement and fetch one row.
java.sql.Connection	getConnection(java.lang.String dsName, boolean startTransaction)	Obtain a Connection instance from the specified data source, starts a transaction if specified.
javax.sql.DataSource	getDataSource()
javax.sql.DataSource	getDataSource(java.lang.String dsName)
java.util.Map<java.lang.String,javax.sql.DataSource>	getDataSources()
int	getDefaultFetchSize()	Get default fetch size for SELECT statements.
protected org.springframework.jdbc.support.SQLErrorCodesFactory	getSQLErrorCodesFactory()
protected org.springframework.jdbc.support.SQLExceptionTranslator	getSQLExceptionTranslator(java.sql.Connection conn)
AbstractJdbcHelper	init()	Initializing method.
void	returnConnection(java.sql.Connection conn)	Return a previously obtained Connection via IJdbcHelper.getConnection() or IJdbcHelper.getConnection(boolean).
boolean	rollbackTransaction(java.sql.Connection conn)	Rollback a transaction.
AbstractJdbcHelper	setDataSource(java.lang.String dsName, javax.sql.DataSource ds)
AbstractJdbcHelper	setDataSource(javax.sql.DataSource ds)
AbstractJdbcHelper	setDataSources(java.util.Map<java.lang.String,javax.sql.DataSource> dataSources)
AbstractJdbcHelper	setDefaultFetchSize(int fetchSize)	Set default fetch size for SELECT statements.
boolean	startTransaction(java.sql.Connection conn)	Start a transaction.
protected DaoException	translateSQLException(java.sql.Connection conn, java.lang.String task, java.lang.String sql, java.sql.SQLException e)
protected DaoException	translateSQLException(java.sql.Connection conn, java.sql.SQLException e)
protected DaoException	translateSQLException(org.springframework.dao.DataAccessException dae)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.ddth.dao.jdbc.IJdbcHelper

execute, execute, executeSelect, executeSelect, executeSelect, executeSelect, executeSelect, executeSelect, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectAsStream, executeSelectOne, executeSelectOne, executeSelectOne, executeSelectOne, executeSelectOne, executeSelectOne, getConnection, getConnection, getConnection

Constructor Detail

AbstractJdbcHelper

public AbstractJdbcHelper()

Method Detail

setDefaultFetchSize

public AbstractJdbcHelper setDefaultFetchSize(int fetchSize)

Set default fetch size for SELECT statements.

Parameters:

fetchSize -

Returns:

Since:

0.8.2

getDefaultFetchSize

public int getDefaultFetchSize()

Get default fetch size for SELECT statements.

Returns:

Since:

0.8.2

getSQLErrorCodesFactory

protected org.springframework.jdbc.support.SQLErrorCodesFactory getSQLErrorCodesFactory()

Returns:

Since:

0.8.2

getSQLExceptionTranslator

protected org.springframework.jdbc.support.SQLExceptionTranslator getSQLExceptionTranslator(java.sql.Connection conn)

Parameters:

conn -

Returns:

Since:

0.8.2

translateSQLException

protected DaoException translateSQLException(java.sql.Connection conn,
                                             java.sql.SQLException e)

Parameters:

conn -

e -

Returns:

Since:

0.8.2

translateSQLException

protected DaoException translateSQLException(java.sql.Connection conn,
                                             java.lang.String task,
                                             java.lang.String sql,
                                             java.sql.SQLException e)

Parameters:

conn -

task -

sql -

e -

Returns:

Since:

0.8.2

translateSQLException

protected DaoException translateSQLException(org.springframework.dao.DataAccessException dae)

Parameters:

dae -

Returns:

Since:

0.8.2

setDataSource

public AbstractJdbcHelper setDataSource(java.lang.String dsName,
                                        javax.sql.DataSource ds)

Parameters:

dsName -

ds -

Returns:

Since:

0.8.1

getDataSource

public javax.sql.DataSource getDataSource(java.lang.String dsName)

Parameters:

dsName -

Returns:

Since:

0.8.1

getDataSources

public java.util.Map<java.lang.String,javax.sql.DataSource> getDataSources()

Returns:

Since:

0.8.1

setDataSources

public AbstractJdbcHelper setDataSources(java.util.Map<java.lang.String,javax.sql.DataSource> dataSources)

Parameters:

dataSources -

Returns:

Since:

0.8.1

setDataSource

public AbstractJdbcHelper setDataSource(javax.sql.DataSource ds)

getDataSource

public javax.sql.DataSource getDataSource()

init

public AbstractJdbcHelper init()

Initializing method.

Returns:

destroy

public void destroy()

Destroying method.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

getConnection

public java.sql.Connection getConnection(java.lang.String dsName,
                                         boolean startTransaction)

Obtain a Connection instance from the specified data source, starts a transaction if specified.

Specified by:

getConnection in interface IJdbcHelper

Returns:

Since:

0.8.1

returnConnection

public void returnConnection(java.sql.Connection conn)

Return a previously obtained Connection via IJdbcHelper.getConnection() or IJdbcHelper.getConnection(boolean).

Specified by:

returnConnection in interface IJdbcHelper

startTransaction

public boolean startTransaction(java.sql.Connection conn)

Start a transaction. Has no effect if already in a transaction.

Specified by:

startTransaction in interface IJdbcHelper

Returns:

commitTransaction

public boolean commitTransaction(java.sql.Connection conn)

Commit a transaction. Has no effect if not in a transaction.

Note: autoCommit is set to true after calling this method.

Specified by:

commitTransaction in interface IJdbcHelper

Returns:

rollbackTransaction

public boolean rollbackTransaction(java.sql.Connection conn)

Rollback a transaction. Has no effect if not in a transaction.

Note: autoCommit is set to true after calling this method.

Specified by:

rollbackTransaction in interface IJdbcHelper

Returns:

execute

public int execute(java.lang.String sql,
                   java.lang.Object... bindValues)

Execute a non-SELECT statement.

Specified by:

execute in interface IJdbcHelper

bindValues - index-based bind values

Returns:

DaoException

execute

public int execute(java.lang.String sql,
                   java.util.Map<java.lang.String,?> bindValues)

Execute a non-SELECT statement.

Specified by:

execute in interface IJdbcHelper

bindValues - name-based bind values

Returns:

DaoException

executeSelect

public <T> java.util.List<T> executeSelect(IRowMapper<T> rowMapper,
                                           java.lang.String sql,
                                           java.lang.Object... bindValues)

Execute a SELECT statement.

Specified by:

executeSelect in interface IJdbcHelper

Parameters:

rowMapper - to map the ResultSet to object

bindValues - index-based bind values

Returns:

executeSelect

public <T> java.util.List<T> executeSelect(IRowMapper<T> rowMapper,
                                           java.lang.String sql,
                                           java.util.Map<java.lang.String,?> bindValues)

Execute a SELECT statement.

Specified by:

executeSelect in interface IJdbcHelper

Parameters:

rowMapper - to map the ResultSet to object

bindValues - name-based bind values

Returns:

executeSelectOne

public <T> T executeSelectOne(IRowMapper<T> rowMapper,
                              java.lang.String sql,
                              java.lang.Object... bindValues)

Execute a SELECT statement and fetch one row.

Specified by:

executeSelectOne in interface IJdbcHelper

Parameters:

rowMapper - to map the ResultSet to object

bindValues - index-based bind values

Returns:

executeSelectOne

public <T> T executeSelectOne(IRowMapper<T> rowMapper,
                              java.lang.String sql,
                              java.util.Map<java.lang.String,?> bindValues)

Execute a SELECT statement and fetch one row.

Specified by:

executeSelectOne in interface IJdbcHelper

Parameters:

rowMapper - to map the ResultSet to object

bindValues - name-based bind values

Returns:

calcFetchSizeForStream

protected int calcFetchSizeForStream(int hintFetchSize,
                                     java.sql.Connection conn)
                              throws java.sql.SQLException

Calculate fetch size used for streaming.

Difference db-drivers/vendors accept different fetch-size values for result-set streaming.

Parameters:

hintFetchSize -

conn -

Returns:

Throws:

java.sql.SQLException

executeSelectAsStream

public <T> java.util.stream.Stream<T> executeSelectAsStream(IRowMapper<T> rowMapper,
                                                            java.sql.Connection conn,
                                                            boolean autoCloseConnection,
                                                            int fetchSize,
                                                            java.lang.String sql,
                                                            java.lang.Object... bindValues)

Execute a SELECT statement and return result as a Stream.

Specified by:

executeSelectAsStream in interface IJdbcHelper

autoCloseConnection - if true the supplied Connection will be automatically closed when the returned Stream closes.

Returns:

executeSelectAsStream

public <T> java.util.stream.Stream<T> executeSelectAsStream(IRowMapper<T> rowMapper,
                                                            java.sql.Connection conn,
                                                            boolean autoCloseConnection,
                                                            int fetchSize,
                                                            java.lang.String sql,
                                                            java.util.Map<java.lang.String,?> bindValues)

Execute a SELECT statement and return result as a Stream.

Specified by:

executeSelectAsStream in interface IJdbcHelper

autoCloseConnection - if true the supplied Connection will be automatically closed when the returned Stream closes.

Returns: