MappingSqlQueryWithParameters

Class Overview

Reusable RDBMS query in which concrete subclasses must implement the abstract mapRow(ResultSet, int) method to map each row of the JDBC ResultSet into an object.

Such manual mapping is usually preferable to "automatic" mapping using reflection, which can become complex in non-trivial cases. For example, the present class allows different objects to be used for different rows (for example, if a subclass is indicated). It allows computed fields to be set. And there's no need for ResultSet columns to have the same names as bean properties. The Pareto Principle in action: going the extra mile to automate the extraction process makes the framework much more complex and delivers little real benefit.

Subclasses can be constructed providing SQL, parameter types and a DataSource. SQL will often vary between subclasses.

Summary

[Expand] Inherited Fields
From class org.springframework.jdbc.object.RdbmsOperation protected final Log logger Logger available to subclasses

[Expand] Inherited Methods
From class org.springframework.jdbc.object.SqlQuery List<T> execute(String p1) Convenient method to execute with a single String parameter. List<T> execute(long p1) Convenient method to execute with a single long parameter. List<T> execute(int p1, int p2) Convenient method to execute with two int parameters. List<T> execute() Convenient method to execute without parameters nor context. List<T> execute(int p1, Map context) Convenient method to execute with a single int parameter and context. List<T> execute(Map context) Convenient method to execute without parameters. List<T> execute(String p1, Map context) Convenient method to execute with a single String parameter and context. List<T> execute(int p1) Convenient method to execute with a single int parameter. List<T> execute(Object... params) Convenient method to execute without context. List<T> execute(int p1, int p2, Map context) Convenient method to execute with two int parameters and context. List<T> execute(Object[] params, Map context) Central execution method. List<T> execute(long p1, Map context) Convenient method to execute with a single long parameter and context. List<T> executeByNamedParam(Map<String, ?> paramMap) Convenient method to execute without context. List<T> executeByNamedParam(Map<String, ?> paramMap, Map context) Central execution method. T findObject(int p1) Convenient method to find a single object given a single int parameter. T findObject(Object[] params, Map context) Generic object finder method, used by all other findObject methods. T findObject(int p1, Map context) Convenient method to find a single object given a single int parameter and a context. T findObject(String p1, Map context) Convenient method to find a single object given a single String parameter and a context. T findObject(Object... params) Convenient method to find a single object without context. T findObject(long p1, Map context) Convenient method to find a single object given a single long parameter and a context. T findObject(int p1, int p2, Map context) Convenient method to find a single object given two int parameters and a context. T findObject(long p1) Convenient method to find a single object given a single long parameter. T findObject(int p1, int p2) Convenient method to find a single object given two int parameters. T findObject(String p1) Convenient method to find a single object given a single String parameter. T findObjectByNamedParam(Map<String, ?> paramMap, Map context) Generic object finder method for named parameters. T findObjectByNamedParam(Map<String, ?> paramMap) Convenient method to execute without context. int getRowsExpected() Get the number of rows expected. abstract RowMapper<T> newRowMapper(Object[] parameters, Map context) Subclasses must implement this method to extract an object per row, to be returned by the execute method as an aggregated List. void setRowsExpected(int rowsExpected) Set the number of rows expected.
From class org.springframework.jdbc.object.SqlOperation final void compileInternal() Overridden method to configure the PreparedStatementCreatorFactory based on our declared parameters. ParsedSql getParsedSql() Obtain a parsed representation of this operation's SQL statement. final PreparedStatementCreator newPreparedStatementCreator(Object[] params) Return a PreparedStatementCreator to perform an operation with the given parameters. final PreparedStatementCreator newPreparedStatementCreator(String sqlToUse, Object[] params) Return a PreparedStatementCreator to perform an operation with the given parameters. final PreparedStatementSetter newPreparedStatementSetter(Object[] params) Return a PreparedStatementSetter to perform an operation with the given parameters. void onCompileInternal() Hook method that subclasses may override to post-process compilation.
From class org.springframework.jdbc.object.RdbmsOperation void afterPropertiesSet() Ensures compilation if used in a bean factory. boolean allowsUnusedParameters() Return whether this operation accepts additional parameters that are given but not actually used. void checkCompiled() Check whether this operation has been compiled already; lazily compile it if not already compiled. final void compile() Compile this query. abstract void compileInternal() Subclasses must implement this template method to perform their own compilation. void declareParameter(SqlParameter param) Declare a parameter for this operation. List<SqlParameter> getDeclaredParameters() Return a list of the declared SqlParameter objects. String[] getGeneratedKeysColumnNames() Return the column names of the auto generated keys. JdbcTemplate getJdbcTemplate() Return the JdbcTemplate object used by this object. int getResultSetType() Return whether statements will return a specific type of ResultSet. String getSql() Subclasses can override this to supply dynamic SQL if they wish, but SQL is normally set by calling the setSql() method or in a subclass constructor. boolean isCompiled() Is this operation "compiled"? Compilation, as in JDO, means that the operation is fully configured, and ready to use. boolean isReturnGeneratedKeys() Return whether statements should be capable of returning auto-generated keys. boolean isUpdatableResults() Return whether statements will return updatable ResultSets. void setDataSource(DataSource dataSource) Set the JDBC DataSource to obtain connections from. void setFetchSize(int fetchSize) Set the fetch size for this RDBMS operation. void setGeneratedKeysColumnNames(String[] names) Set the column names of the auto-generated keys. void setJdbcTemplate(JdbcTemplate jdbcTemplate) An alternative to the more commonly used setDataSource() when you want to use the same JdbcTemplate in multiple RdbmsOperations. void setMaxRows(int maxRows) Set the maximum number of rows for this RDBMS operation. void setParameters(SqlParameter[] parameters) Add one or more declared parameters. void setQueryTimeout(int queryTimeout) Set the query timeout for statements that this RDBMS operation executes. void setResultSetType(int resultSetType) Set whether to use statements that return a specific type of ResultSet. void setReturnGeneratedKeys(boolean returnGeneratedKeys) Set whether prepared statements should be capable of returning auto-generated keys. void setSql(String sql) Set the SQL executed by this operation. void setTypes(int[] types) Add anonymous parameters, specifying only their SQL types as defined in the java.sql.Types class. void setUpdatableResults(boolean updatableResults) Set whether to use statements that are capable of returning updatable ResultSets. boolean supportsLobParameters() Return whether BLOB/CLOB parameters are supported for this kind of operation. void validateNamedParameters(Map<String, ?> parameters) Validate the named parameters passed to an execute method based on declared parameters. void validateParameters(Object[] parameters) Validate the parameters passed to an execute method based on declared parameters.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).