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

public abstract class

SqlOperation

extends RdbmsOperation

java.lang.Object
↳	org.springframework.jdbc.object.RdbmsOperation
	↳	org.springframework.jdbc.object.SqlOperation

Known Direct Subclasses

SqlQuery<T>, SqlUpdate

Known Indirect Subclasses

BatchSqlUpdate, GenericSqlQuery, MappingSqlQuery<T>, MappingSqlQueryWithParameters<T>, SqlFunction<T>, UpdatableSqlQuery<T>

Class Overview

Operation object representing a SQL-based operation such as a query or update, as opposed to a stored procedure.

Configures a PreparedStatementCreatorFactory based on the declared parameters.

Summary

[Expand]

Inherited Fields

From class org.springframework.jdbc.object.RdbmsOperation

Public Constructors
	SqlOperation()

Protected Methods
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.

[Expand]

Inherited Methods

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 SqlOperation ()

Protected Methods

protected final void compileInternal ()

Overridden method to configure the PreparedStatementCreatorFactory based on our declared parameters.

protected ParsedSql getParsedSql ()

Obtain a parsed representation of this operation's SQL statement.

Typically used for named parameter parsing.

protected final PreparedStatementCreator newPreparedStatementCreator (Object[] params)

Return a PreparedStatementCreator to perform an operation with the given parameters.

Parameters

params	the parameter array (may be `null`)

protected final PreparedStatementCreator newPreparedStatementCreator (String sqlToUse, Object[] params)

Return a PreparedStatementCreator to perform an operation with the given parameters.

Parameters

sqlToUse	the actual SQL statement to use (if different from the factory's, for example because of named parameter expanding)
params	the parameter array (may be `null`)

protected final PreparedStatementSetter newPreparedStatementSetter (Object[] params)

Return a PreparedStatementSetter to perform an operation with the given parameters.

Parameters

params	the parameter array (may be `null`)

protected void onCompileInternal ()

Hook method that subclasses may override to post-process compilation. This implementation does nothing.

Classes

SqlOperation

Class Overview

Summary

Public Constructors

public SqlOperation ()

Protected Methods

protected final void compileInternal ()

protected ParsedSql getParsedSql ()

protected final PreparedStatementCreator newPreparedStatementCreator (Object[] params)

Parameters

protected final PreparedStatementCreator newPreparedStatementCreator (String sqlToUse, Object[] params)

Parameters

protected final PreparedStatementSetter newPreparedStatementSetter (Object[] params)

Parameters

protected void onCompileInternal ()

See Also