Top Description Methods
org.springframework.jdbc.core.simple

public Interface SimpleJdbcCallOperations

Known Direct Implementers
org.springframework.jdbc.core.simple.SimpleJdbcCall
Imports
java.util.Map, org.springframework.jdbc.core.RowMapper, .SqlParameter, org.springframework.jdbc.core.namedparam.SqlParameterSource
Interface specifying the API for a Simple JDBC Call implemented by SimpleJdbcCall. This interface is not often used directly, but provides the option to enhance testability, as it can easily be mocked or stubbed.
Authors
Thomas Risberg, Stephane Nicoll
Since
2.5

Method Summary

Modifier and TypeMethod and Description
public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
declareParameters(SqlParameter...
the parameters to use
sqlParameters)

Specify one or more parameters if desired.

public Map<String, Object>

Returns:

a Map of output params
execute(Object...
optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.
args)

Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.

public Map<String, Object>

Returns:

a Map of output params
execute(Map<String, ?>
a Map containing the parameter values to be used in the call
args)

Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.

public Map<String, Object>

Returns:

a Map of output params
execute(SqlParameterSource
the SqlParameterSource containing the parameter values to be used in the call
args)

Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.

public <T> T
executeFunction(Class<T>
the type of the value to return
returnType, Object...
optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.
args)

Execute the stored function and return the results obtained as an Object of the specified return type.

public <T> T
executeFunction(Class<T>
the type of the value to return
returnType, Map<String, ?>
a Map containing the parameter values to be used in the call
args)

Execute the stored function and return the results obtained as an Object of the specified return type.

public <T> T
executeFunction(Class<T>
the type of the value to return
returnType, SqlParameterSource
the MapSqlParameterSource containing the parameter values to be used in the call
args)

Execute the stored function and return the results obtained as an Object of the specified return type.

public <T> T
executeObject(Class<T>
the type of the value to return
returnType, Object...
optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.
args)

Execute the stored procedure and return the single out parameter as an Object of the specified return type.

public <T> T
executeObject(Class<T>
the type of the value to return
returnType, Map<String, ?>
a Map containing the parameter values to be used in the call
args)

Execute the stored procedure and return the single out parameter as an Object of the specified return type.

public <T> T
executeObject(Class<T>
the type of the value to return
returnType, SqlParameterSource
the MapSqlParameterSource containing the parameter values to be used in the call
args)

Execute the stored procedure and return the single out parameter as an Object of the specified return type.

public SimpleJdbcCallOperations
returningResultSet(String
the name of the returned results and/or the name of the ref cursor parameter
parameterName, RowMapper<?>
the RowMapper implementation that will map the data returned for each row
rowMapper)

Used to specify when a ResultSet is returned by the stored procedure and you want it mapped by a RowMapper.

public SimpleJdbcCallOperations
useInParameterNames(String... inParameterNames)

Not used yet.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withCatalogName(String
the catalog or package name
catalogName)

Optionally, specify the name of the catalog that contins the stored procedure.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withFunctionName(String
the name of the stored function
functionName)

Specify the procedure name to be used - this implies that we will be calling a stored function.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withNamedBinding()

Indicates that parameters should be bound by name.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withoutProcedureColumnMetaDataAccess()

Turn off any processing of parameter meta-data information obtained via JDBC.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withProcedureName(String
the name of the stored procedure
procedureName)

Specify the procedure name to be used - this implies that we will be calling a stored procedure.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withReturnValue()

Indicates the procedure's return value should be included in the results returned.

public SimpleJdbcCallOperations

Returns:

the instance of this SimpleJdbcCall
withSchemaName(String
the name of the schema
schemaName)

Optionally, specify the name of the schema that contins the stored procedure.

Method Detail

declareParametersback to summary
public SimpleJdbcCallOperations declareParameters(SqlParameter... sqlParameters)

Specify one or more parameters if desired. These parameters will be supplemented with any parameter information retrieved from the database meta-data.

Note that only parameters declared as SqlParameter and SqlInOutParameter will be used to provide input values. This is different from the StoredProcedure class which - for backwards compatibility reasons - allows input values to be provided for parameters declared as SqlOutParameter.

Parameters
sqlParameters:SqlParameter[]

the parameters to use

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

executeback to summary
public Map<String, Object> execute(Object... args)

Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.

Parameters
args:Object[]

optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.

Returns:Map<String, Object>

a Map of output params

executeback to summary
public Map<String, Object> execute(Map<String, ?> args)

Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.

Parameters
args:Map<String, ?>

a Map containing the parameter values to be used in the call

Returns:Map<String, Object>

a Map of output params

executeback to summary
public Map<String, Object> execute(SqlParameterSource args)

Execute the stored procedure and return a map of output params, keyed by name as in parameter declarations.

Parameters
args:SqlParameterSource

the SqlParameterSource containing the parameter values to be used in the call

Returns:Map<String, Object>

a Map of output params

executeFunctionback to summary
public <T> T executeFunction(Class<T> returnType, Object... args)

Execute the stored function and return the results obtained as an Object of the specified return type.

Parameters
returnType:Class<T>

the type of the value to return

args:Object[]

optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.

executeFunctionback to summary
public <T> T executeFunction(Class<T> returnType, Map<String, ?> args)

Execute the stored function and return the results obtained as an Object of the specified return type.

Parameters
returnType:Class<T>

the type of the value to return

args:Map<String, ?>

a Map containing the parameter values to be used in the call

executeFunctionback to summary
public <T> T executeFunction(Class<T> returnType, SqlParameterSource args)

Execute the stored function and return the results obtained as an Object of the specified return type.

Parameters
returnType:Class<T>

the type of the value to return

args:SqlParameterSource

the MapSqlParameterSource containing the parameter values to be used in the call

executeObjectback to summary
public <T> T executeObject(Class<T> returnType, Object... args)

Execute the stored procedure and return the single out parameter as an Object of the specified return type. In the case where there are multiple out parameters, the first one is returned and additional out parameters are ignored.

Parameters
returnType:Class<T>

the type of the value to return

args:Object[]

optional array containing the in parameter values to be used in the call. Parameter values must be provided in the same order as the parameters are defined for the stored procedure.

executeObjectback to summary
public <T> T executeObject(Class<T> returnType, Map<String, ?> args)

Execute the stored procedure and return the single out parameter as an Object of the specified return type. In the case where there are multiple out parameters, the first one is returned and additional out parameters are ignored.

Parameters
returnType:Class<T>

the type of the value to return

args:Map<String, ?>

a Map containing the parameter values to be used in the call

executeObjectback to summary
public <T> T executeObject(Class<T> returnType, SqlParameterSource args)

Execute the stored procedure and return the single out parameter as an Object of the specified return type. In the case where there are multiple out parameters, the first one is returned and additional out parameters are ignored.

Parameters
returnType:Class<T>

the type of the value to return

args:SqlParameterSource

the MapSqlParameterSource containing the parameter values to be used in the call

returningResultSetback to summary
public SimpleJdbcCallOperations returningResultSet(String parameterName, RowMapper<?> rowMapper)

Used to specify when a ResultSet is returned by the stored procedure and you want it mapped by a RowMapper. The results will be returned using the parameter name specified. Multiple ResultSets must be declared in the correct order.

If the database you are using uses ref cursors then the name specified must match the name of the parameter declared for the procedure in the database.

Parameters
parameterName:String

the name of the returned results and/or the name of the ref cursor parameter

rowMapper:RowMapper<?>

the RowMapper implementation that will map the data returned for each row

useInParameterNamesback to summary
public SimpleJdbcCallOperations useInParameterNames(String... inParameterNames)

Not used yet.

withCatalogNameback to summary
public SimpleJdbcCallOperations withCatalogName(String catalogName)

Optionally, specify the name of the catalog that contins the stored procedure.

To provide consistency with the Oracle DatabaseMetaData, this is used to specify the package name if the procedure is declared as part of a package.

Parameters
catalogName:String

the catalog or package name

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

withFunctionNameback to summary
public SimpleJdbcCallOperations withFunctionName(String functionName)

Specify the procedure name to be used - this implies that we will be calling a stored function.

Parameters
functionName:String

the name of the stored function

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

withNamedBindingback to summary
public SimpleJdbcCallOperations withNamedBinding()

Indicates that parameters should be bound by name.

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

Since
4.2
withoutProcedureColumnMetaDataAccessback to summary
public SimpleJdbcCallOperations withoutProcedureColumnMetaDataAccess()

Turn off any processing of parameter meta-data information obtained via JDBC.

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

withProcedureNameback to summary
public SimpleJdbcCallOperations withProcedureName(String procedureName)

Specify the procedure name to be used - this implies that we will be calling a stored procedure.

Parameters
procedureName:String

the name of the stored procedure

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

withReturnValueback to summary
public SimpleJdbcCallOperations withReturnValue()

Indicates the procedure's return value should be included in the results returned.

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall

withSchemaNameback to summary
public SimpleJdbcCallOperations withSchemaName(String schemaName)

Optionally, specify the name of the schema that contins the stored procedure.

Parameters
schemaName:String

the name of the schema

Returns:SimpleJdbcCallOperations

the instance of this SimpleJdbcCall