sk.vracon.sqlcomments.spring

Class AbstractSQLCommentsRepository

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.jdbc.core.support.JdbcDaoSupport

sk.vracon.sqlcomments.spring.AbstractSQLCommentsRepository

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class AbstractSQLCommentsRepository
extends org.springframework.jdbc.core.support.JdbcDaoSupport

Abstract spring repository with implemented CRUD operations.

CRUD methods and findByPK are expecting that some configuration classes and statement files already exists. Use sqlcomments maven plugin with goal domain to generate appropriate classes and files:

• domain configuration class - <T>Config
• primary key configuration class - <T>PKConfig
• domain mapper class - <T>Mapper
• insert statement file - <T>.insert.sql
• update statement file - <T>.update.sql
• delete statement file - <T>.delete.sql
• findByPK statement file - <T>.findByPK.sql

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
AbstractSQLCommentsRepository()

Method Summary

Methods

Modifier and Type	Method and Description
protected CallableStatement	createCallableStatement(Connection connection, String statementName, Map<String,Object> parameters) Creates callable statement.
protected CallableStatement	createCallableStatement(Connection connection, String statementName, Map<String,Object> parameters, Set<String> acceptNullParameters) Creates callable statement.
protected PreparedStatement	createPreparedStatement(Connection connection, StatementConfiguration configuration) Creates prepared statement.
protected void	delete(StatementConfiguration configuration) Deletes record from database.
protected <T> void	delete(T domain) Deletes record from database.
protected void	executeStatement(StatementConfiguration config) Executes given statement.
protected <T> T	findByPK(StatementConfiguration config, ResultMapper<T> mapper) Loads instance from database by primary key.
StatementContainer	getStatementContainer() Gets statement container.
protected <T> T	insert(T domain) Inserts instance to database.
protected <T> List<T>	list(StatementConfiguration configuration, ResultMapper<T> mapper) Returns list of transformed query results.
void	setDialect(DatabaseDialect dialect) Sets database dialect to use.
void	setStatementContainer(StatementContainer statementContainer) Sets statement container.
protected <T> T	singleResult(StatementConfiguration configuration, ResultMapper<T> mapper) Returns single row transformed into result object.
protected <T> void	update(T domain) Updates record in database.

Methods inherited from class org.springframework.jdbc.core.support.JdbcDaoSupport

checkDaoConfig, createJdbcTemplate, getConnection, getDataSource, getExceptionTranslator, getJdbcTemplate, initTemplateConfig, releaseConnection, setDataSource, setJdbcTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSQLCommentsRepository

public AbstractSQLCommentsRepository()

Method Detail

findByPK

protected <T> T findByPK(StatementConfiguration config,
             ResultMapper<T> mapper)

Loads instance from database by primary key.

Configuration class is using SQL statement called findByPK which is generated for each domain class.

Type Parameters:

T - instance class

Parameters:

config - statement configuration (usually class generated as a <T>PKConfig)

mapper - class mapper

Returns:

insert

protected <T> T insert(T domain)

Inserts instance to database.

Configuration class is using SQL statement called <T>.insert.sql which is generated for each domain class.

Type Parameters:

T - instance class

Parameters:

domain - domain class to be stored in DB

Returns:

the same instance with primary key filled

update

protected <T> void update(T domain)

Updates record in database.

Configuration class is using SQL statement called <T>.update.sql which is generated for each domain class.

Type Parameters:

T - instance class

Parameters:

domain - domain class to be stored in DB

delete

protected <T> void delete(T domain)

Deletes record from database.

Configuration class is using SQL statement called <T>.delete.sql which is generated for each domain class.

Type Parameters:

T - instance class

Parameters:

domain - domain to be removed from DB

delete

protected void delete(StatementConfiguration configuration)

Deletes record from database.

Configuration class is using SQL statement called <T>.delete.sql which is generated for each domain class.

Parameters:

configuration - statement configuration (usually <T>PKConfig)

list

protected <T> List<T> list(StatementConfiguration configuration,
               ResultMapper<T> mapper)
                throws StatementException

Returns list of transformed query results.

Type Parameters:

T - result class

Parameters:

configuration - statement configuration

mapper - result mapper

Returns:

list of transformed results

Throws:

StatementException - thrown if JDBC call or transformation failed

singleResult

protected <T> T singleResult(StatementConfiguration configuration,
                 ResultMapper<T> mapper)
                  throws StatementException

Returns single row transformed into result object.

Type Parameters:

T - result class

Parameters:

configuration - statement configuration

mapper - result mapper

Returns:

transformed result object or null if no result

Throws:

StatementException - thrown if JDBC call or transformation failed or non-unique result

createPreparedStatement

protected PreparedStatement createPreparedStatement(Connection connection,
                                        StatementConfiguration configuration)

Creates prepared statement.

As a base class is used this.

Parameters:

connection - JDBC connection. Caller is responsible to return connection to pool if necessary.

configuration - statement configuration

Returns:

prepared statement

Throws:

StatementException - thrown if statement creation failed

createCallableStatement

protected CallableStatement createCallableStatement(Connection connection,
                                        String statementName,
                                        Map<String,Object> parameters)
                                             throws StatementException

Creates callable statement.

As a base class is used this.

Parameters:

connection - JDBC connection

statementName - statement simple name

parameters - parameters

Returns:

callable statement

Throws:

StatementException - thrown if statement creation failed

createCallableStatement

protected CallableStatement createCallableStatement(Connection connection,
                                        String statementName,
                                        Map<String,Object> parameters,
                                        Set<String> acceptNullParameters)
                                             throws StatementException

Creates callable statement.

As a base class is used this.

Parameters:

connection - JDBC connection

statementName - statement simple name

parameters - parameters

acceptNullParameters - parameter names accepting null values

Returns:

callable statement

Throws:

StatementException - thrown if statement creation failed

executeStatement

protected void executeStatement(StatementConfiguration config)

Executes given statement.

Method is intended for use with update and delete SQL statements.

Parameters:

config - statement configuration

See Also:

PreparedStatement.execute()

getStatementContainer

public StatementContainer getStatementContainer()

Gets statement container.

Returns:

statement container

setStatementContainer

public void setStatementContainer(StatementContainer statementContainer)

Sets statement container.

Parameters:

statementContainer - statement container

setDialect

public void setDialect(DatabaseDialect dialect)

Sets database dialect to use.

Parameters:

dialect - database dialect