org.apache.empire.spring

Class EmpireTemplate

java.lang.Object

org.apache.empire.spring.EmpireTemplate

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class EmpireTemplate
extends Object
implements org.springframework.beans.factory.InitializingBean

This class simplifies database access methods with Empire. Database queries are executed with the help of callback interfaces, while hides connection handling from the developer. Only the query logic has to be implemented and leave getting and releasing the connection to the template. Some methods (delete, update) delegates to DBRecord, DBDatabase and DBCommand methods while hiding connection handling from developers. This class is working with a wrapped JdbcTemplate, so either jdbcTemplate or dataSource must be set. Allows customization of creating DBReader and DBRecord instances through ObjectFactories. This class is based on JdbcTemplate.

Constructor Summary

Constructors

Constructor and Description
EmpireTemplate() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	deleteRecord(DBRecord record) Deletes a given record from the database.
void	deleteRecord(DBTable table, Object key) Deletes a record from a table with a given single primary key.
void	deleteRecord(DBTable table, Object[] keys) Deletes a record from a table with a given multiple primary key.
<K> K	execute(org.springframework.jdbc.core.ConnectionCallback<K> connectionCallback) Executes a ConnectionCallback.
int	executeDelete(DBTable table, DBCommand cmd) Executes a Delete statement from a command object.
int	executeInsert(DBCommand cmd) Executes an Insert statement from a command object.
int	executeUpdate(DBCommand cmd) Executes an Update statement from a command object.
org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate()
DBRecord	getRecord(DBRowSet table, Object key) Opens a DBRecord instance with the given single primary key.
DBRecord	getRecord(DBRowSet table, Object[] keys) Opens a DBRecord instance with the given multiple primary keys.
DBRecord	newRecord(DBRowSet table) Helper method to an create a DBRecord instance.
DBRecord	openRecord(DBRowSet table, Object key) Opens a DBRecord instance with the given multiple primary keys.
DBRecord	openRecord(DBRowSet table, Object[] keys) Opens a DBRecord instance with the given multiple primary keys.
<K> K	query(DBCommand cmd, DBReaderExtractor<K> readerExtractor) Executes a given DBCommand and handles the DBReader with the provided DBReaderExtractor.
void	query(DBCommand cmd, DBRecordCallbackHandler recordCallbackHandler) Executes a given DBCommand and handles each row of the DBReader with the provided DBRecordCallbackHandler.
<K> List<K>	query(DBCommand cmd, DBRecordMapper<K> recordMapper) Executes a given DBCommand, mapping each row to a Java object via a DBRecordMapper.
<T> T	queryForBean(DBCommand cmd, Class<T> t) Executes a given DBCommand query and maps a single row to Class object using DBReader.getBeanList method.
<C extends Collection<T>,T> C	queryForBeanList(DBCommand cmd, C c, Class<T> t, int maxCount) Executes a given DBCommand query and maps each row to Class object using DBReader.getBeanList method.
<T> List<T>	queryForBeanList(DBCommand cmd, Class<T> t) Executes a given DBCommand query and maps each row to Class object using DBReader.getBeanList method.
<T> List<T>	queryForBeanList(DBCommand cmd, Class<T> t, int maxItems) Executes a given DBCommand query and maps each row to Class object using DBReader.getBeanList method.
Integer	queryForInteger(DBCommand cmd, DBColumnExpr col, Integer defaultValue) Executes a given DBCommand, mapping a single column to a single Integer.
List<Integer>	queryForIntegerList(DBCommand cmd, DBColumnExpr col, Integer defaultValue) Executes a given DBCommand, extracting a single column to a List of Integers.
List<Object>	queryForList(DBCommand cmd, DBColumnExpr col) Executes a given DBCommand, mapping a single column to a Java object using on DBRecordData.getValue() method.
Long	queryForLong(DBCommand cmd, DBColumnExpr col, Long defaultValue) Executes a given DBCommand, mapping a single column to a single Long.
List<Long>	queryForLongList(DBCommand cmd, DBColumnExpr col, Long defaultValue) Executes a given DBCommand, extracting a single column to a List of Long.
<K> K	queryForObject(DBCommand cmd, DBRecordMapper<K> recordMapper) Executes a given DBCommand, mapping a single row to a Java object using the provided DBRecordMapper.
String	queryForString(DBCommand cmd, DBColumnExpr col) Executes a given DBCommand, mapping a single column to a single String.
List<String>	queryForStringList(DBCommand cmd, DBColumnExpr col) Executes a given DBCommand, extracting a single column to a List of Strings.
void	setDataSource(DataSource dataSource) Setting the datasource
void	setDBReaderClass(Class<? extends DBReader> readerClass) Setting a custom DBReader class to use in queries.
void	setDBReaderFactory(org.springframework.beans.factory.ObjectFactory<DBReader> readerFactory) Setting a custom ObjectFactory to allow custom DBReaders to use in queries.
void	setDBRecordClass(Class<? extends DBRecord> recordClass) Setting a custom DBRecord class to use in newRecord().
void	setDBRecordFactory(org.springframework.beans.factory.ObjectFactory<DBRecord> recordFactory) Setting a custom ObjectFactory to allow custom DBRecord create with newRecord().
void	setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate) Setting the wrapped JdbcTemplate
DBRecord	updateRecord(DBRecord record) Updates the record and saves all changes in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmpireTemplate

public EmpireTemplate()

Default constructor

Method Detail

setDBRecordFactory

public void setDBRecordFactory(org.springframework.beans.factory.ObjectFactory<DBRecord> recordFactory)

Setting a custom ObjectFactory to allow custom DBRecord create with newRecord().

Parameters:

recordFactory -

setDBRecordClass

public void setDBRecordClass(Class<? extends DBRecord> recordClass)

Setting a custom DBRecord class to use in newRecord().

Parameters:

recordClass - the class which extends DBRecord.class

setDBReaderFactory

public void setDBReaderFactory(org.springframework.beans.factory.ObjectFactory<DBReader> readerFactory)

Setting a custom ObjectFactory to allow custom DBReaders to use in queries.

Parameters:

readerFactory -

setDBReaderClass

public void setDBReaderClass(Class<? extends DBReader> readerClass)

Setting a custom DBReader class to use in queries.

Parameters:

readerClass - the class which extends DBReader.class

setJdbcTemplate

public void setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)

Setting the wrapped JdbcTemplate

getJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate()

setDataSource

public final void setDataSource(DataSource dataSource)

Setting the datasource

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

query

public <K> List<K> query(DBCommand cmd,
                DBRecordMapper<K> recordMapper)

Executes a given DBCommand, mapping each row to a Java object via a DBRecordMapper.

Parameters:

cmd - the DBCommand to execute

recordMapper - the mapper which maps each DBRecordData to a Java object

Returns:

the extracted list

queryForObject

public <K> K queryForObject(DBCommand cmd,
                   DBRecordMapper<K> recordMapper)

Executes a given DBCommand, mapping a single row to a Java object using the provided DBRecordMapper.

Parameters:

cmd - the DBCommand to execute

recordMapper - the DBRecordMapper to map

Returns:

the single Object

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if more than one result object has been found

queryForList

public List<Object> queryForList(DBCommand cmd,
                        DBColumnExpr col)

Executes a given DBCommand, mapping a single column to a Java object using on DBRecordData.getValue() method.

Parameters:

cmd - the DBCommand to execute

col - the column to map

Returns:

the extracted list

queryForLong

public Long queryForLong(DBCommand cmd,
                DBColumnExpr col,
                Long defaultValue)

Executes a given DBCommand, mapping a single column to a single Long. If the value in the database is null, defaultValue is returned.

Parameters:

cmd - the DBCommand to execute

col - the column to map

defaultValue - the value to return in case of the database value is null

Returns:

the single Long value

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if more than one result object has been found

queryForLongList

public List<Long> queryForLongList(DBCommand cmd,
                          DBColumnExpr col,
                          Long defaultValue)

Executes a given DBCommand, extracting a single column to a List of Long. If the value in the database is null, defaultValue is added to the list.

Parameters:

cmd - the DBCommand to execute

col - the column to map

defaultValue - the value to return in case of the database value is null

Returns:

the extracted list

queryForInteger

public Integer queryForInteger(DBCommand cmd,
                      DBColumnExpr col,
                      Integer defaultValue)

Executes a given DBCommand, mapping a single column to a single Integer. If the value in the database is null, defaultValue is returned.

Parameters:

cmd - the DBCommand to execute

col - the column to map

defaultValue - the value to return in case of the database value is null

Returns:

the single Integer value

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if more than one result object has been found

queryForIntegerList

public List<Integer> queryForIntegerList(DBCommand cmd,
                                DBColumnExpr col,
                                Integer defaultValue)

Executes a given DBCommand, extracting a single column to a List of Integers. If the value in the database is null, defaultValue is added to the list.

Parameters:

cmd - the DBCommand to execute

col - the column to map

defaultValue - the value to return in case of the database value is null

Returns:

the extracted list

queryForString

public String queryForString(DBCommand cmd,
                    DBColumnExpr col)

Executes a given DBCommand, mapping a single column to a single String.

Parameters:

cmd - the DBCommand to execute

col - the column to map

Returns:

the single String value

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if more than one result object has been found

queryForStringList

public List<String> queryForStringList(DBCommand cmd,
                              DBColumnExpr col)

Executes a given DBCommand, extracting a single column to a List of Strings.

Parameters:

cmd - the DBCommand to execute

col - the column to map

Returns:

the extracted list

query

public <K> K query(DBCommand cmd,
          DBReaderExtractor<K> readerExtractor)

Executes a given DBCommand and handles the DBReader with the provided DBReaderExtractor.

Parameters:

cmd - the DBCommand to execute

readerExtractor -

Returns:

the result returned by the readerExtractor

query

public void query(DBCommand cmd,
         DBRecordCallbackHandler recordCallbackHandler)

Executes a given DBCommand and handles each row of the DBReader with the provided DBRecordCallbackHandler.

Parameters:

cmd - the DBCommand to execute

recordCallbackHandler -

deleteRecord

public void deleteRecord(DBRecord record)

Deletes a given record from the database. Calls DBRecord.delete(connection).

Parameters:

record - to delete

See Also:

DBRecord.delete(Connection)

deleteRecord

public void deleteRecord(DBTable table,
                Object key)

Deletes a record from a table with a given single primary key.

Parameters:

table - the table to delete from

key - the primary key

deleteRecord

public void deleteRecord(DBTable table,
                Object[] keys)

Deletes a record from a table with a given multiple primary key. Calls DBTable.deleteRecord(Object[], Connection).

Parameters:

table - the table to delete from

keys - the primary keys array

See Also:

org.apache.empire.db.DBTable.deleteRecord(Object[], Connection)

updateRecord

public DBRecord updateRecord(DBRecord record)

Updates the record and saves all changes in the database. Calls DBRecord.update(connection).

Parameters:

record - to update

Returns:

the updated record

See Also:

DBRecord.update(Connection)

executeUpdate

public int executeUpdate(DBCommand cmd)

Executes an Update statement from a command object. This method delegates to DBDatabase.executeUpdate(cmd, connection), getting the DBDatabase instance from the DBCOmmand object.

Parameters:

cmd - the command object containing the update command

Returns:

the number of records that have been updated with the supplied statement

See Also:

DBDatabase.executeUpdate(DBCommand, Connection)

executeDelete

public int executeDelete(DBTable table,
                DBCommand cmd)

Executes a Delete statement from a command object. This method delegates to DBDatabase.executeDelete(cmd, connection), getting the DBDatabase instance from the DBCOmmand object.

Parameters:

cmd - the command object containing the delete command

Returns:

the number of records that have been deleted with the supplied statement

See Also:

org.apache.empire.db.DBDatabase#executeDelete(DBCommand, Connection)

executeInsert

public int executeInsert(DBCommand cmd)

Executes an Insert statement from a command object. This method delegates to DBDatabase.executeInsert(cmd, connection), getting the DBDatabase instance from the DBCOmmand object.

Parameters:

cmd - the command object containing the insert command

Returns:

the number of records that have been inserted with the supplied statement

See Also:

DBDatabase.executeInsert(DBCommand, Connection)

newRecord

public DBRecord newRecord(DBRowSet table)

Helper method to an create a DBRecord instance. Can be customized through setRecordFactory or setRecordClass methods.

Parameters:

table - the table

Returns:

the new DBRecord instance

openRecord

public DBRecord openRecord(DBRowSet table,
                  Object key)

Opens a DBRecord instance with the given multiple primary keys. In contrast of getRecord(DBRowSet, Object) this method throws RecordNotFoundExpcetion if matching record exists.

Parameters:

table - the table to read the record from

key - the primary key

Returns:

the DBRecord instance, never null

Throws:

RecordNotFoundException - in case of the record not found

openRecord

public DBRecord openRecord(DBRowSet table,
                  Object[] keys)

Opens a DBRecord instance with the given multiple primary keys. In contrast of getRecord(DBRowSet, Object[]) this method throws RecordNotFoundExpcetion if matching record exists.

Parameters:

table - the table to read the record from

keys - the primary key array

Returns:

the DBRecord instance, never null

Throws:

RecordNotFoundException - in case of the record not found

getRecord

public DBRecord getRecord(DBRowSet table,
                 Object key)

Opens a DBRecord instance with the given single primary key. In contrast of openRecord(DBRowSet, Object) this method returns null if no matching record exists.

Parameters:

table - the table to read the record from

key - the primary key

Returns:

the DBRecord instance, can be null

getRecord

public DBRecord getRecord(DBRowSet table,
                 Object[] keys)

Opens a DBRecord instance with the given multiple primary keys. In contrast of openRecord(DBRowSet, Object[]) this method returns null if no matching record exists.

Parameters:

table - the table to read the record from

keys - the primary keys array

Returns:

the DBRecord instance, can be null

queryForBeanList

public <C extends Collection<T>,T> C queryForBeanList(DBCommand cmd,
                                             C c,
                                             Class<T> t,
                                             int maxCount)

Executes a given DBCommand query and maps each row to Class object using DBReader.getBeanList method.

Parameters:

cmd - the query command

c - the collection to add the objects to

t - the class type of the objects in the list

maxCount - the maximum number of objects

Returns:

the list of T

See Also:

org.apache.empire.db.DBReader.getBeanList(C, Class, int)

queryForBeanList

public <T> List<T> queryForBeanList(DBCommand cmd,
                           Class<T> t,
                           int maxItems)

Executes a given DBCommand query and maps each row to Class object using DBReader.getBeanList method.

Parameters:

cmd - the query command

t - the class type of the objects in the list

maxCount - the maximum number of objects

Returns:

the list of T

See Also:

org.apache.empire.db.DBReader.getBeanList(Class, int)

queryForBeanList

public <T> List<T> queryForBeanList(DBCommand cmd,
                           Class<T> t)

Executes a given DBCommand query and maps each row to Class object using DBReader.getBeanList method.

Parameters:

cmd - the query command

t - the class type of the objects in the list

Returns:

the list of T

See Also:

org.apache.empire.db.DBReader.getBeanList(Class)

queryForBean

public <T> T queryForBean(DBCommand cmd,
                 Class<T> t)

Executes a given DBCommand query and maps a single row to Class object using DBReader.getBeanList method.

Parameters:

cmd - the query command

t - the class type of the object to return

Returns:

the list of T

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if more than one result object has been found

execute

public <K> K execute(org.springframework.jdbc.core.ConnectionCallback<K> connectionCallback)

Executes a ConnectionCallback. Delegates to the underlying JdbcTemplate.

Parameters:

connectionCallback -

Returns:

arbitrary object

See Also:

org.springframework.jdbc.core.JdbcTemplate.execute(ConnectionCallback )