Package org.springframework.jdbc.object

Class StoredProcedure

java.lang.Object
org.springframework.jdbc.object.RdbmsOperation
org.springframework.jdbc.object.SqlCall
org.springframework.jdbc.object.StoredProcedure
All Implemented Interfaces:
InitializingBean
Direct Known Subclasses:
GenericStoredProcedure
public abstract class StoredProcedure extends SqlCall
Superclass for object abstractions of RDBMS stored procedures. This class is abstract and it is intended that subclasses will provide a typed method for invocation that delegates to the supplied execute(java.lang.Object...) method.

The inherited sql property is the name of the stored procedure in the RDBMS.

Author:
Rod Johnson, Thomas Risberg

  • Constructor Details

    • StoredProcedure

      protected StoredProcedure()
      Allow use as a bean.

    • StoredProcedure

      protected StoredProcedure(DataSource ds, String name)
      Create a new object wrapper for a stored procedure.
      Parameters:
      ds - the DataSource to use throughout the lifetime of this object to obtain connections
      name - the name of the stored procedure in the database

    • StoredProcedure

      protected StoredProcedure(JdbcTemplate jdbcTemplate, String name)
      Create a new object wrapper for a stored procedure.
      Parameters:
      jdbcTemplate - the JdbcTemplate which wraps DataSource
      name - the name of the stored procedure in the database

  • Method Details

    • allowsUnusedParameters

      protected boolean allowsUnusedParameters()
      StoredProcedure parameter Maps are by default allowed to contain additional entries that are not actually used as parameters.
      Overrides:
      allowsUnusedParameters in class RdbmsOperation
      See Also:

    • declareParameter

      public void declareParameter(SqlParameter param) throws InvalidDataAccessApiUsageException
      Declare a parameter.

      Parameters declared as SqlParameter and SqlInOutParameter will always be used to provide input values. In addition to this, any parameter declared as SqlOutParameter where a non-null input value is provided will also be used as an input parameter. Note: Calls to declareParameter must be made in the same order as they appear in the database's stored procedure parameter list.

      Names are purely used to help mapping.

      Overrides:
      declareParameter in class RdbmsOperation
      Parameters:
      param - the parameter object
      Throws:
      InvalidDataAccessApiUsageException - if the parameter has no name, or if the operation is already compiled, and hence cannot be configured further

    • execute

      public Map<String,Object> execute(Object... inParams)
      Execute the stored procedure with the provided parameter values. This is a convenience method where the order of the passed in parameter values must match the order that the parameters where declared in.
      Parameters:
      inParams - variable number of input parameters. Output parameters should not be included in this map. It is legal for values to be null, and this will produce the correct behavior using a NULL argument to the stored procedure.
      Returns:
      map of output params, keyed by name as in parameter declarations. Output parameters will appear here, with their values after the stored procedure has been called.

    • execute

      public Map<String,Object> execute(Map<String,?> inParams) throws DataAccessException
      Execute the stored procedure. Subclasses should define a strongly typed execute method (with a meaningful name) that invokes this method, populating the input map and extracting typed values from the output map. Subclass execute methods will often take domain objects as arguments and return values. Alternatively, they can return void.
      Parameters:
      inParams - map of input parameters, keyed by name as in parameter declarations. Output parameters need not (but can) be included in this map. It is legal for map entries to be null, and this will produce the correct behavior using a NULL argument to the stored procedure.
      Returns:
      map of output params, keyed by name as in parameter declarations. Output parameters will appear here, with their values after the stored procedure has been called.
      Throws:
      DataAccessException

    • execute

      public Map<String,Object> execute(ParameterMapper inParamMapper) throws DataAccessException
      Execute the stored procedure. Subclasses should define a strongly typed execute method (with a meaningful name) that invokes this method, passing in a ParameterMapper that will populate the input map. This allows mapping database specific features since the ParameterMapper has access to the Connection object. The execute method is also responsible for extracting typed values from the output map. Subclass execute methods will often take domain objects as arguments and return values. Alternatively, they can return void.
      Parameters:
      inParamMapper - map of input parameters, keyed by name as in parameter declarations. Output parameters need not (but can) be included in this map. It is legal for map entries to be null, and this will produce the correct behavior using a NULL argument to the stored procedure.
      Returns:
      map of output params, keyed by name as in parameter declarations. Output parameters will appear here, with their values after the stored procedure has been called.
      Throws:
      DataAccessException