| java.lang.Object | |
| ↳ | org.springframework.jdbc.object.RdbmsOperation |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
An "RDBMS operation" is a multi-threaded, reusable object representing a query, update, or stored procedure call. An RDBMS operation is not a command, as a command is not reusable. However, execute methods may take commands as arguments. Subclasses should be JavaBeans, allowing easy configuration.
This class and subclasses throw runtime exceptions, defined in the
Subclasses should set SQL and add parameters before invoking the
org.springframework.jdbc.core package, which the classes
in this package use under the hood to perform raw JDBC operations).
compile() method. The order in which parameters are added is
significant. The appropriate execute or update
method can then be invoked.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| logger | Logger available to subclasses | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Ensures compilation if used in a bean factory.
| |||||||||||
Compile this query.
| |||||||||||
Declare a parameter for this operation.
| |||||||||||
Return the column names of the auto generated keys.
| |||||||||||
Return the JdbcTemplate object used by this object.
| |||||||||||
Return whether statements will return a specific type of ResultSet.
| |||||||||||
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.
| |||||||||||
Is this operation "compiled"? Compilation, as in JDO,
means that the operation is fully configured, and ready to use.
| |||||||||||
Return whether statements should be capable of returning
auto-generated keys.
| |||||||||||
Return whether statements will return updatable ResultSets.
| |||||||||||
Set the JDBC DataSource to obtain connections from.
| |||||||||||
Set the fetch size for this RDBMS operation.
| |||||||||||
Set the column names of the auto-generated keys.
| |||||||||||
An alternative to the more commonly used setDataSource() when you want to
use the same JdbcTemplate in multiple RdbmsOperations.
| |||||||||||
Set the maximum number of rows for this RDBMS operation.
| |||||||||||
Add one or more declared parameters.
| |||||||||||
Set the query timeout for statements that this RDBMS operation executes.
| |||||||||||
Set whether to use statements that return a specific type of ResultSet.
| |||||||||||
Set whether prepared statements should be capable of returning
auto-generated keys.
| |||||||||||
Set the SQL executed by this operation.
| |||||||||||
Add anonymous parameters, specifying only their SQL types
as defined in the
java.sql.Types class. | |||||||||||
Set whether to use statements that are capable of returning
updatable ResultSets.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Return whether this operation accepts additional parameters that are
given but not actually used.
| |||||||||||
Check whether this operation has been compiled already;
lazily compile it if not already compiled.
| |||||||||||
Subclasses must implement this template method to perform their own compilation.
| |||||||||||
Return a list of the declared
SqlParameter objects. | |||||||||||
Return whether BLOB/CLOB parameters are supported for this kind of operation.
| |||||||||||
Validate the named parameters passed to an execute method based on declared parameters.
| |||||||||||
Validate the parameters passed to an execute method based on declared parameters.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
org.springframework.beans.factory.InitializingBean
| |||||||||||
Fields
protected final Log logger
Logger available to subclasses
Public Constructors
public RdbmsOperation ()
Public Methods
public void afterPropertiesSet ()
Ensures compilation if used in a bean factory.
public final void compile ()
Compile this query. Ignores subsequent attempts to compile.
Throws
| InvalidDataAccessApiUsageException | if the object hasn't been correctly initialized, for example if no DataSource has been provided |
|---|
public void declareParameter (SqlParameter param)
Declare a parameter for this operation.
The order in which this method is called is significant when using positional parameters. It is not significant when using named parameters with named SqlParameter objects here; it remains significant when using named parameters in combination with unnamed SqlParameter objects here.
Parameters
| param | the SqlParameter to add. This will specify SQL type and (optionally)
the parameter's name. Note that you typically use the SqlParameter class
itself here, not any of its subclasses. |
|---|
Throws
| InvalidDataAccessApiUsageException | if the operation is already compiled, and hence cannot be configured further |
|---|
public int getResultSetType ()
Return whether statements will return a specific type of ResultSet.
public 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.
public boolean isCompiled ()
Is this operation "compiled"? Compilation, as in JDO, means that the operation is fully configured, and ready to use. The exact meaning of compilation will vary between subclasses.
Returns
- whether this operation is compiled, and ready to use.
public boolean isReturnGeneratedKeys ()
Return whether statements should be capable of returning auto-generated keys.
public boolean isUpdatableResults ()
Return whether statements will return updatable ResultSets.
public void setDataSource (DataSource dataSource)
Set the JDBC DataSource to obtain connections from.
See Also
public void setFetchSize (int fetchSize)
Set the fetch size for this RDBMS operation. This is important for processing large result sets: Setting this higher than the default value will increase processing speed at the cost of memory consumption; setting this lower can avoid transferring row data that will never be read by the application.
Default is 0, indicating to use the driver's default.
See Also
public void setGeneratedKeysColumnNames (String[] names)
Set the column names of the auto-generated keys.
See Also
public void setJdbcTemplate (JdbcTemplate jdbcTemplate)
An alternative to the more commonly used setDataSource() when you want to use the same JdbcTemplate in multiple RdbmsOperations. This is appropriate if the JdbcTemplate has special configuration such as a SQLExceptionTranslator that should apply to multiple RdbmsOperation objects.
public void setMaxRows (int maxRows)
Set the maximum number of rows for this RDBMS operation. This is important for processing subsets of large result sets, avoiding to read and hold the entire result set in the database or in the JDBC driver.
Default is 0, indicating to use the driver's default.
See Also
public void setParameters (SqlParameter[] parameters)
Add one or more declared parameters. Used for configuring this operation when used in a bean factory. Each parameter will specify SQL type and (optionally) the parameter's name.
Parameters
| parameters | Array containing the declared SqlParameter objects |
|---|
See Also
- #declaredParameters
public void setQueryTimeout (int queryTimeout)
Set the query timeout for statements that this RDBMS operation executes.
Default is 0, indicating to use the JDBC driver's default.
Note: Any timeout specified here will be overridden by the remaining transaction timeout when executing within a transaction that has a timeout specified at the transaction level.
public void setResultSetType (int resultSetType)
Set whether to use statements that return a specific type of ResultSet.
Parameters
| resultSetType | the ResultSet type |
|---|
public void setReturnGeneratedKeys (boolean returnGeneratedKeys)
Set whether prepared statements should be capable of returning auto-generated keys.
See Also
public void setTypes (int[] types)
Add anonymous parameters, specifying only their SQL types
as defined in the java.sql.Types class.
Parameter ordering is significant. This method is an alternative
to the declareParameter(SqlParameter) method, which should normally be preferred.
Parameters
| types | array of SQL types as defined in the
java.sql.Types class |
|---|
Throws
| InvalidDataAccessApiUsageException | if the operation is already compiled |
|---|
public void setUpdatableResults (boolean updatableResults)
Set whether to use statements that are capable of returning updatable ResultSets.
See Also
Protected Methods
protected boolean allowsUnusedParameters ()
Return whether this operation accepts additional parameters that are given but not actually used. Applies in particular to parameter Maps.
The default is false.
See Also
protected void checkCompiled ()
Check whether this operation has been compiled already; lazily compile it if not already compiled.
Automatically called by validateParameters.
See Also
protected abstract void compileInternal ()
Subclasses must implement this template method to perform their own compilation. Invoked after this base class's compilation is complete.
Subclasses can assume that SQL and a DataSource have been supplied.
Throws
| InvalidDataAccessApiUsageException | if the subclass hasn't been properly configured |
|---|
protected List<SqlParameter> getDeclaredParameters ()
Return a list of the declared SqlParameter objects.
protected boolean supportsLobParameters ()
Return whether BLOB/CLOB parameters are supported for this kind of operation.
The default is true.
protected void validateNamedParameters (Map<String, ?> parameters)
Validate the named parameters passed to an execute method based on declared parameters.
Subclasses should invoke this method before every executeQuery() or
update() method.
Parameters
| parameters | parameter Map supplied. May be null. |
|---|
Throws
| InvalidDataAccessApiUsageException | if the parameters are invalid |
|---|
protected void validateParameters (Object[] parameters)
Validate the parameters passed to an execute method based on declared parameters.
Subclasses should invoke this method before every executeQuery()
or update() method.
Parameters
| parameters | parameters supplied (may be null) |
|---|
Throws
| InvalidDataAccessApiUsageException | if the parameters are invalid |
|---|