public abstract class

SqlCall

extends RdbmsOperation

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

Known Direct Subclasses

StoredProcedure

Known Indirect Subclasses

GenericStoredProcedure

Class Overview

RdbmsOperation using a JdbcTemplate and representing a SQL-based call such as a stored procedure or a stored function.

Configures a CallableStatementCreatorFactory based on the declared parameters.

Summary

[Expand]

Inherited Fields

From class org.springframework.jdbc.object.RdbmsOperation

Public Constructors
	SqlCall() Constructor to allow use as a JavaBean.
	SqlCall(DataSource ds, String sql) Create a new SqlCall object with SQL, but without parameters.

Public Methods
String	getCallString() Get the call string.
boolean	isFunction() Return whether this call is for a function.
boolean	isSqlReadyForUse() Return whether the SQL can be used as is.
void	setFunction(boolean function) Set whether this call is for a function.
void	setSqlReadyForUse(boolean sqlReadyForUse) Set whether the SQL can be used as is.

Protected Methods
final void	compileInternal() Overridden method to configure the CallableStatementCreatorFactory based on our declared parameters.
CallableStatementCreator	newCallableStatementCreator(ParameterMapper inParamMapper) Return a CallableStatementCreator to perform an operation with the parameters returned from this ParameterMapper.
CallableStatementCreator	newCallableStatementCreator(Map<String, ?> inParams) Return a CallableStatementCreator to perform an operation with this parameters.
void	onCompileInternal() Hook method that subclasses may override to react to 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 SqlCall ()

Constructor to allow use as a JavaBean. A DataSource, SQL and any parameters must be supplied before invoking the compile method and using this object.

public SqlCall (DataSource ds, String sql)

Create a new SqlCall object with SQL, but without parameters. Must add parameters or settle with none.

Parameters

ds	DataSource to obtain connections from
sql	SQL to execute

Public Methods

public String getCallString ()

Get the call string.

public boolean isFunction ()

Return whether this call is for a function.

public boolean isSqlReadyForUse ()

Return whether the SQL can be used as is.

public void setFunction (boolean function)

Set whether this call is for a function.

public void setSqlReadyForUse (boolean sqlReadyForUse)

Set whether the SQL can be used as is.

Protected Methods

protected final void compileInternal ()

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

protected CallableStatementCreator newCallableStatementCreator (ParameterMapper inParamMapper)

Return a CallableStatementCreator to perform an operation with the parameters returned from this ParameterMapper.

Parameters

inParamMapper	parametermapper. May not be `null`.

protected CallableStatementCreator newCallableStatementCreator (Map<String, ?> inParams)

Return a CallableStatementCreator to perform an operation with this parameters.

Parameters

inParams	parameters. May be `null`.

protected void onCompileInternal ()

Hook method that subclasses may override to react to compilation. This implementation does nothing.

Classes

SqlCall

Class Overview

See Also

Summary

Public Constructors

public SqlCall ()

See Also

public SqlCall (DataSource ds, String sql)

Parameters

Public Methods

public String getCallString ()

public boolean isFunction ()

public boolean isSqlReadyForUse ()

public void setFunction (boolean function)

public void setSqlReadyForUse (boolean sqlReadyForUse)

Protected Methods

protected final void compileInternal ()

See Also

protected CallableStatementCreator newCallableStatementCreator (ParameterMapper inParamMapper)

Parameters

protected CallableStatementCreator newCallableStatementCreator (Map<String, ?> inParams)

Parameters

protected void onCompileInternal ()