Summary: Inherited Fields | Ctors | Protected Methods | Inherited Methods | [Expand All]

public abstract class

MappingSqlQuery

extends MappingSqlQueryWithParameters<T>

java.lang.Object
↳	org.springframework.jdbc.object.RdbmsOperation
	↳	org.springframework.jdbc.object.SqlOperation
		↳	org.springframework.jdbc.object.SqlQuery<T>
			↳	org.springframework.jdbc.object.MappingSqlQueryWithParameters<T>
				↳	org.springframework.jdbc.object.MappingSqlQuery<T>

Known Direct Subclasses

SqlFunction<T>

Class Overview

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

Simplifies MappingSqlQueryWithParameters API by dropping parameters and context. Most subclasses won't care about parameters. If you don't use contextual information, subclass this instead of MappingSqlQueryWithParameters.

Summary

[Expand]

Inherited Fields

From class org.springframework.jdbc.object.RdbmsOperation

Public Constructors
	MappingSqlQuery() Constructor that allows use as a JavaBean.
	MappingSqlQuery(DataSource ds, String sql) Convenient constructor with DataSource and SQL string.

Protected Methods
abstract T	mapRow(ResultSet rs, int rowNum) Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.
final T	mapRow(ResultSet rs, int rowNum, Object[] parameters, Map context) This method is implemented to invoke the simpler mapRow template method, ignoring parameters.

[Expand]

Inherited Methods

From class org.springframework.jdbc.object.MappingSqlQueryWithParameters

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

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

From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public MappingSqlQuery ()

Constructor that allows use as a JavaBean.

public MappingSqlQuery (DataSource ds, String sql)

Convenient constructor with DataSource and SQL string.

Parameters

ds	DataSource to use to obtain connections
sql	SQL to run

Protected Methods

protected abstract T mapRow (ResultSet rs, int rowNum)

Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.

Subclasses of this class, as opposed to direct subclasses of MappingSqlQueryWithParameters, don't need to concern themselves with the parameters to the execute method of the query object.

Parameters

rs	ResultSet we're working through
rowNum	row number (from 0) we're up to

Returns

an object of the result type

Throws

SQLException	if there's an error extracting data. Subclasses can simply not catch SQLExceptions, relying on the framework to clean up.

protected final T mapRow (ResultSet rs, int rowNum, Object[] parameters, Map context)

This method is implemented to invoke the simpler mapRow template method, ignoring parameters.

Parameters

rs	ResultSet we're working through
rowNum	row number (from 0) we're up to
parameters	to the query (passed to the execute() method). Subclasses are rarely interested in these. It can be `null` if there are no parameters.
context	passed to the execute() method. It can be `null` if no contextual information is need.

Returns

an object of the result type

Throws

SQLException

Classes

MappingSqlQuery

Class Overview

See Also

Summary

Public Constructors

public MappingSqlQuery ()

public MappingSqlQuery (DataSource ds, String sql)

Parameters

Protected Methods

protected abstract T mapRow (ResultSet rs, int rowNum)

Parameters

Returns

Throws

protected final T mapRow (ResultSet rs, int rowNum, Object[] parameters, Map context)

Parameters

Returns

Throws

See Also