|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NamedParameterJdbcOperations
Interface specifying a basic set of JDBC operations allowing the use of named parameters rather than the traditional '?' placeholders.
This is an alternative to the classic
JdbcOperations
interface,
implemented by NamedParameterJdbcTemplate
. This interface is not
often used directly, but provides a useful option to enhance testability,
as it can easily be mocked or stubbed.
NamedParameterJdbcTemplate
,
JdbcOperations
Method Summary | |
---|---|
Object |
execute(String sql,
Map paramMap,
PreparedStatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement. |
Object |
execute(String sql,
SqlParameterSource paramSource,
PreparedStatementCallback action)
Execute a JDBC data access operation, implemented as callback action working on a JDBC PreparedStatement. |
JdbcOperations |
getJdbcOperations()
Expose the classic Spring JdbcTemplate to allow invocation of classic JDBC operations. |
Object |
query(String sql,
Map paramMap,
ResultSetExtractor rse)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor. |
void |
query(String sql,
Map paramMap,
RowCallbackHandler rch)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler. |
List |
query(String sql,
Map paramMap,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper. |
Object |
query(String sql,
SqlParameterSource paramSource,
ResultSetExtractor rse)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor. |
void |
query(String sql,
SqlParameterSource paramSource,
RowCallbackHandler rch)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler. |
List |
query(String sql,
SqlParameterSource paramSource,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper. |
int |
queryForInt(String sql,
Map paramMap)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in an int value. |
int |
queryForInt(String sql,
SqlParameterSource paramSource)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in an int value. |
List |
queryForList(String sql,
Map paramMap)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
List |
queryForList(String sql,
Map paramMap,
Class elementType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
List |
queryForList(String sql,
SqlParameterSource paramSource)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
List |
queryForList(String sql,
SqlParameterSource paramSource,
Class elementType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. |
long |
queryForLong(String sql,
Map paramMap)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in a long value. |
long |
queryForLong(String sql,
SqlParameterSource paramSource)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, resulting in a long value. |
Map |
queryForMap(String sql,
Map paramMap)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result Map. |
Map |
queryForMap(String sql,
SqlParameterSource paramSource)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result Map. |
Object |
queryForObject(String sql,
Map paramMap,
Class requiredType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object. |
Object |
queryForObject(String sql,
Map paramMap,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper. |
Object |
queryForObject(String sql,
SqlParameterSource paramSource,
Class requiredType)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result object. |
Object |
queryForObject(String sql,
SqlParameterSource paramSource,
RowMapper rowMapper)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper. |
SqlRowSet |
queryForRowSet(String sql,
Map paramMap)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a SqlRowSet. |
SqlRowSet |
queryForRowSet(String sql,
SqlParameterSource paramSource)
Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a SqlRowSet. |
int |
update(String sql,
Map paramMap)
Issue an update via a prepared statement, binding the given arguments. |
int |
update(String sql,
SqlParameterSource paramSource)
Issue an update via a prepared statement, binding the given arguments. |
int |
update(String sql,
SqlParameterSource paramSource,
KeyHolder generatedKeyHolder)
Issue an update via a prepared statement, binding the given arguments, returning generated keys. |
int |
update(String sql,
SqlParameterSource paramSource,
KeyHolder generatedKeyHolder,
String[] keyColumnNames)
Issue an update via a prepared statement, binding the given arguments, returning generated keys. |
Method Detail |
---|
JdbcOperations getJdbcOperations()
Object execute(String sql, SqlParameterSource paramSource, PreparedStatementCallback action) throws DataAccessException
The callback action can return a result object, for example a domain object or a collection of domain objects.
sql
- SQL to executeparamSource
- container of arguments to bind to the queryaction
- callback object that specifies the action
null
DataAccessException
- if there is any problemObject execute(String sql, Map paramMap, PreparedStatementCallback action) throws DataAccessException
The callback action can return a result object, for example a domain object or a collection of domain objects.
sql
- SQL to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)action
- callback object that specifies the action
null
DataAccessException
- if there is any problemObject query(String sql, SqlParameterSource paramSource, ResultSetExtractor rse) throws DataAccessException
sql
- SQL query to executeparamSource
- container of arguments to bind to the queryrse
- object that will extract results
DataAccessException
- if the query failsObject query(String sql, Map paramMap, ResultSetExtractor rse) throws DataAccessException
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rse
- object that will extract results
DataAccessException
- if the query failsvoid query(String sql, SqlParameterSource paramSource, RowCallbackHandler rch) throws DataAccessException
sql
- SQL query to executeparamSource
- container of arguments to bind to the queryrch
- object that will extract results, one row at a time
DataAccessException
- if the query failsvoid query(String sql, Map paramMap, RowCallbackHandler rch) throws DataAccessException
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rch
- object that will extract results, one row at a time
DataAccessException
- if the query failsList query(String sql, SqlParameterSource paramSource, RowMapper rowMapper) throws DataAccessException
sql
- SQL query to executeparamSource
- container of arguments to bind to the queryrowMapper
- object that will map one object per row
DataAccessException
- if the query failsList query(String sql, Map paramMap, RowMapper rowMapper) throws DataAccessException
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rowMapper
- object that will map one object per row
DataAccessException
- if the query failsObject queryForObject(String sql, SqlParameterSource paramSource, RowMapper rowMapper) throws DataAccessException
sql
- SQL query to executeparamSource
- container of arguments to bind to the queryrowMapper
- object that will map one object per row
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsObject queryForObject(String sql, Map paramMap, RowMapper rowMapper) throws DataAccessException
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)rowMapper
- object that will map one object per row
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsObject queryForObject(String sql, SqlParameterSource paramSource, Class requiredType) throws DataAccessException
The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.
sql
- SQL query to executeparamSource
- container of arguments to bind to the queryrequiredType
- the type that the result object is expected to match
null
in case of SQL NULL
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForObject(String, Class)
Object queryForObject(String sql, Map paramMap, Class requiredType) throws DataAccessException
The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)requiredType
- the type that the result object is expected to match
null
in case of SQL NULL
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForObject(String, Class)
Map queryForMap(String sql, SqlParameterSource paramSource) throws DataAccessException
The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).
sql
- SQL query to executeparamSource
- container of arguments to bind to the query
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForMap(String)
,
ColumnMapRowMapper
Map queryForMap(String sql, Map paramMap) throws DataAccessException
The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForMap(String)
,
ColumnMapRowMapper
long queryForLong(String sql, SqlParameterSource paramSource) throws DataAccessException
The query is expected to be a single row/single column query that results in a long value.
sql
- SQL query to executeparamSource
- container of arguments to bind to the query
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForLong(String)
long queryForLong(String sql, Map paramMap) throws DataAccessException
The query is expected to be a single row/single column query that results in a long value.
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
IncorrectResultSizeDataAccessException
- if the query does not return exactly one row, or does not return exactly
one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForLong(String)
int queryForInt(String sql, SqlParameterSource paramSource) throws DataAccessException
The query is expected to be a single row/single column query that results in an int value.
sql
- SQL query to executeparamSource
- container of arguments to bind to the query
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForInt(String)
int queryForInt(String sql, Map paramMap) throws DataAccessException
The query is expected to be a single row/single column query that results in an int value.
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
IncorrectResultSizeDataAccessException
- if the query does not return
exactly one row, or does not return exactly one column in that row
DataAccessException
- if the query failsJdbcTemplate.queryForInt(String)
List queryForList(String sql, SqlParameterSource paramSource, Class elementType) throws DataAccessException
The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.
sql
- SQL query to executeparamSource
- container of arguments to bind to the queryelementType
- the required type of element in the result list
(for example, Integer.class
)
DataAccessException
- if the query failsJdbcTemplate.queryForList(String, Class)
,
SingleColumnRowMapper
List queryForList(String sql, Map paramMap, Class elementType) throws DataAccessException
The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)elementType
- the required type of element in the result list
(for example, Integer.class
)
DataAccessException
- if the query failsJdbcTemplate.queryForList(String, Class)
,
SingleColumnRowMapper
List queryForList(String sql, SqlParameterSource paramSource) throws DataAccessException
The results will be mapped to a List (one entry for each row) of Maps (one entry for each column, using the column name as the key). Thus Each element in the list will be of the form returned by this interface's queryForMap() methods.
sql
- SQL query to executeparamSource
- container of arguments to bind to the query
DataAccessException
- if the query failsJdbcTemplate.queryForList(String)
List queryForList(String sql, Map paramMap) throws DataAccessException
The results will be mapped to a List (one entry for each row) of Maps (one entry for each column, using the column name as the key). Each element in the list will be of the form returned by this interface's queryForMap() methods.
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
DataAccessException
- if the query failsJdbcTemplate.queryForList(String)
SqlRowSet queryForRowSet(String sql, SqlParameterSource paramSource) throws DataAccessException
The results will be mapped to an SqlRowSet which holds the data in a disconnected fashion. This wrapper will translate any SQLExceptions thrown.
Note that that, for the default implementation, JDBC RowSet support needs to
be available at runtime: by default, Sun's com.sun.rowset.CachedRowSetImpl
class is used, which is part of JDK 1.5+ and also available separately as part of
Sun's JDBC RowSet Implementations download (rowset.jar).
sql
- SQL query to executeparamSource
- container of arguments to bind to the query
javax.sql.rowset.CachedRowSet
)
DataAccessException
- if there is any problem executing the queryJdbcTemplate.queryForRowSet(String)
,
SqlRowSetResultSetExtractor
,
CachedRowSet
SqlRowSet queryForRowSet(String sql, Map paramMap) throws DataAccessException
The results will be mapped to an SqlRowSet which holds the data in a disconnected fashion. This wrapper will translate any SQLExceptions thrown.
Note that that, for the default implementation, JDBC RowSet support needs to
be available at runtime: by default, Sun's com.sun.rowset.CachedRowSetImpl
class is used, which is part of JDK 1.5+ and also available separately as part of
Sun's JDBC RowSet Implementations download (rowset.jar).
sql
- SQL query to executeparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
javax.sql.rowset.CachedRowSet
)
DataAccessException
- if there is any problem executing the queryJdbcTemplate.queryForRowSet(String)
,
SqlRowSetResultSetExtractor
,
CachedRowSet
int update(String sql, SqlParameterSource paramSource) throws DataAccessException
sql
- SQL containing named parametersparamSource
- container of arguments and SQL types to bind to the query
DataAccessException
- if there is any problem issuing the updateint update(String sql, Map paramMap) throws DataAccessException
sql
- SQL containing named parametersparamMap
- map of parameters to bind to the query
(leaving it to the PreparedStatement to guess the corresponding SQL type)
DataAccessException
- if there is any problem issuing the updateint update(String sql, SqlParameterSource paramSource, KeyHolder generatedKeyHolder) throws DataAccessException
sql
- SQL containing named parametersparamSource
- container of arguments and SQL types to bind to the querygeneratedKeyHolder
- KeyHolder that will hold the generated keys
DataAccessException
- if there is any problem issuing the updateMapSqlParameterSource
,
GeneratedKeyHolder
int update(String sql, SqlParameterSource paramSource, KeyHolder generatedKeyHolder, String[] keyColumnNames) throws DataAccessException
sql
- SQL containing named parametersparamSource
- container of arguments and SQL types to bind to the querygeneratedKeyHolder
- KeyHolder that will hold the generated keyskeyColumnNames
- names of the columns that will have keys generated for them
DataAccessException
- if there is any problem issuing the updateMapSqlParameterSource
,
GeneratedKeyHolder
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |