org.sqlproc.engine.spring
Class SpringQuery

java.lang.Object
  org.sqlproc.engine.spring.SpringQuery

All Implemented Interfaces:

SqlQuery

public class SpringQuery
extends Object
implements SqlQuery

The Spring stack implementation of the SQL Engine query contract. In fact it's an adapter the internal Spring stuff.

For more info please see the Reference Guide or the tutorials.

Author:

Vladimir Hudec

Field Summary

(package private) Integer	firstResult The first row to retrieve.
(package private) List<String>	identities The collection of all (auto-generated) identities.
(package private) Map<String,IdentitySetter>	identitySetters The collection of all identities setters.
(package private) Map<String,Object>	identityTypes The collection of all identities types.
(package private) org.springframework.jdbc.core.JdbcTemplate	jdbcTemplate The Spring JdbcTemplate, the central class for all Spring database operations.
(package private) org.slf4j.Logger	logger The internal slf4j logger.
(package private) Integer	maxResults The maximum number of rows to retrieve.
(package private) List<String>	parameters The collection of all parameters (input value declarations).
(package private) Map<String,Object>	parameterTypes The collection of all parameters types.
(package private) Map<String,Object>	parameterValues The collection of all parameters values.
(package private) String	queryString The SQL query/statement command.
(package private) List<String>	scalars The collection of all scalars (output values declarations).
(package private) Map<String,Object>	scalarTypes The collection of all scalars types.
(package private) Integer	timeout A timeout for the underlying query.

Constructor Summary

SpringQuery(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, String queryString)
Creates a new instance of this adapter.

Method Summary

SqlQuery	addScalar(String columnAlias)
SqlQuery	addScalar(String columnAlias, Object type)
private void	doIdentitySelect(String identityName) Runs the select to obtain the value of auto-generated identity.
int	executeUpdate()
Object	getQuery()
protected List	getResults(ResultSet rs) Gets the value of the designated columns as the objects in the Java programming language.
List	list()
SqlQuery	setFirstResult(int firstResult)
protected int	setLimits(PreparedStatement ps, SqlUtils.LimitType limitType, int ix, boolean afterSql) Sets the limit related parameters.
SqlQuery	setMaxResults(int maxResults)
SqlQuery	setParameter(String name, Object val)
SqlQuery	setParameter(String name, Object val, Object type)
SqlQuery	setParameterList(String name, Object[] vals)
SqlQuery	setParameterList(String name, Object[] vals, Object type)
protected void	setParameters(PreparedStatement ps, SqlUtils.LimitType limitType) Sets the value of the designated parameters.
SqlQuery	setTimeout(int timeout)
Object	uniqueResult()
protected int	update(org.springframework.jdbc.core.PreparedStatementCreator psc, org.springframework.jdbc.core.PreparedStatementSetter pss) This is a workaround, as this method is not visible in JdbcTemplate.

Methods inherited from class java.lang.Object

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

Field Detail

logger

final org.slf4j.Logger logger

The internal slf4j logger.

jdbcTemplate

org.springframework.jdbc.core.JdbcTemplate jdbcTemplate

The Spring JdbcTemplate, the central class for all Spring database operations.

queryString

String queryString

The SQL query/statement command.

scalars

List<String> scalars

The collection of all scalars (output values declarations).

scalarTypes

Map<String,Object> scalarTypes

The collection of all scalars types.

parameters

List<String> parameters

The collection of all parameters (input value declarations).

parameterValues

Map<String,Object> parameterValues

The collection of all parameters values.

parameterTypes

Map<String,Object> parameterTypes

The collection of all parameters types.

identities

List<String> identities

The collection of all (auto-generated) identities.

identitySetters

Map<String,IdentitySetter> identitySetters

The collection of all identities setters.

identityTypes

Map<String,Object> identityTypes

The collection of all identities types.

timeout

Integer timeout

A timeout for the underlying query.

firstResult

Integer firstResult

The first row to retrieve.

maxResults

Integer maxResults

The maximum number of rows to retrieve.

Constructor Detail

SpringQuery

public SpringQuery(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
                   String queryString)

Creates a new instance of this adapter.

Parameters:

jdbcTemplate - the Spring JdbcTemplate instance

queryString - the SQL query/statement command

Method Detail

getQuery

public Object getQuery()

Specified by:

getQuery in interface SqlQuery

setTimeout

public SqlQuery setTimeout(int timeout)

Specified by:

setTimeout in interface SqlQuery

setFirstResult

public SqlQuery setFirstResult(int firstResult)

Specified by:

setFirstResult in interface SqlQuery

setMaxResults

public SqlQuery setMaxResults(int maxResults)

Specified by:

setMaxResults in interface SqlQuery

list

public List list()
          throws SqlProcessorException

Specified by:

list in interface SqlQuery

Throws:

SqlProcessorException

uniqueResult

public Object uniqueResult()
                    throws SqlProcessorException

Specified by:

uniqueResult in interface SqlQuery

Throws:

SqlProcessorException

executeUpdate

public int executeUpdate()
                  throws SqlProcessorException

Specified by:

executeUpdate in interface SqlQuery

Throws:

SqlProcessorException

doIdentitySelect

private void doIdentitySelect(String identityName)

Runs the select to obtain the value of auto-generated identity.

Parameters:

identityName - the identity name from the META SQL statement

update

protected int update(org.springframework.jdbc.core.PreparedStatementCreator psc,
                     org.springframework.jdbc.core.PreparedStatementSetter pss)
              throws org.springframework.dao.DataAccessException

This is a workaround, as this method is not visible in JdbcTemplate.

Throws:

org.springframework.dao.DataAccessException

addScalar

public SqlQuery addScalar(String columnAlias)

Specified by:

addScalar in interface SqlQuery

addScalar

public SqlQuery addScalar(String columnAlias,
                          Object type)

Specified by:

addScalar in interface SqlQuery

setParameter

public SqlQuery setParameter(String name,
                             Object val)
                      throws SqlProcessorException

Specified by:

setParameter in interface SqlQuery

Throws:

SqlProcessorException

setParameter

public SqlQuery setParameter(String name,
                             Object val,
                             Object type)
                      throws SqlProcessorException

Specified by:

setParameter in interface SqlQuery

Throws:

SqlProcessorException

setParameterList

public SqlQuery setParameterList(String name,
                                 Object[] vals)
                          throws SqlProcessorException

Specified by:

setParameterList in interface SqlQuery

Throws:

SqlProcessorException

setParameterList

public SqlQuery setParameterList(String name,
                                 Object[] vals,
                                 Object type)
                          throws SqlProcessorException

Specified by:

setParameterList in interface SqlQuery

Throws:

SqlProcessorException

setParameters

protected void setParameters(PreparedStatement ps,
                             SqlUtils.LimitType limitType)
                      throws SQLException

Sets the value of the designated parameters.

Parameters:

ps - an instance of PreparedStatement

limitType - the limit type to restrict the number of rows in the result set

Throws:

SQLException - if a database access error occurs or this method is called on a closed PreparedStatement

setLimits

protected int setLimits(PreparedStatement ps,
                        SqlUtils.LimitType limitType,
                        int ix,
                        boolean afterSql)
                 throws SQLException

Sets the limit related parameters.

Parameters:

ps - an instance of PreparedStatement

limitType - the limit type to restrict the number of rows in the result set

ix - a column index

afterSql - an indicator it's done after the main SQL statement execution

Returns:

the updated column index

Throws:

SQLException - if a database access error occurs or this method is called on a closed PreparedStatement

getResults

protected List getResults(ResultSet rs)
                   throws SQLException

Gets the value of the designated columns as the objects in the Java programming language.

Parameters:

rs - an instance of ResultSet

Returns:

the result list

Throws:

SQLException - if a database access error occurs or this method is called on a closed ResultSet