Class SqlFunction<T>
- Type Parameters:
T
- the result type
- All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
Intended to use to call SQL functions that return a single result using a query like "select user()" or "select sysdate from dual". It is not intended for calling more complex stored functions or for using a CallableStatement to invoke a stored procedure or stored function. Use StoredProcedure or SqlCall for this type of processing.
This is a concrete class, which there is often no need to subclass.
Code using this package can create an object of this type, declaring SQL
and parameters, and then invoke the appropriate run
method
repeatedly to execute the function. Subclasses are only supposed to add
specialized run
methods for specific parameter and return types.
Like all RdbmsOperation objects, SqlFunction objects are thread-safe.
- Author:
- Rod Johnson, Juergen Hoeller, Jean-Pierre Pawlak
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.jdbc.object.MappingSqlQueryWithParameters
MappingSqlQueryWithParameters.RowMapperImpl
-
Field Summary
Fields inherited from class org.springframework.jdbc.object.RdbmsOperation
logger
-
Constructor Summary
ConstructorDescriptionConstructor to allow use as a JavaBean.SqlFunction
(DataSource ds, String sql) Create a new SqlFunction object with SQL, but without parameters.SqlFunction
(DataSource ds, String sql, int[] types) Create a new SqlFunction object with SQL and parameters.SqlFunction
(DataSource ds, String sql, int[] types, Class<T> resultType) Create a new SqlFunction object with SQL, parameters and a result type. -
Method Summary
Modifier and TypeMethodDescriptionprotected T
This implementation of this method extracts a single value from the single row returned by the function.int
run()
Convenient method to run the function without arguments.int
run
(int parameter) Convenient method to run the function with a single int argument.int
Analogous to the SqlQuery.execute([]) method.Convenient method to run the function without arguments, returning the value as an object.runGeneric
(int parameter) Convenient method to run the function with a single int argument.runGeneric
(Object[] parameters) Analogous to theSqlQuery.findObject(Object[])
method.void
setResultType
(Class<T> resultType) Specify the type that the result object is required to match.Methods inherited from class org.springframework.jdbc.object.MappingSqlQuery
mapRow
Methods inherited from class org.springframework.jdbc.object.MappingSqlQueryWithParameters
newRowMapper
Methods inherited from class org.springframework.jdbc.object.SqlQuery
execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, executeByNamedParam, executeByNamedParam, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObjectByNamedParam, findObjectByNamedParam, getRowsExpected, setRowsExpected
Methods inherited from class org.springframework.jdbc.object.SqlOperation
compileInternal, getParsedSql, newPreparedStatementCreator, newPreparedStatementCreator, newPreparedStatementSetter, onCompileInternal
Methods inherited from class org.springframework.jdbc.object.RdbmsOperation
afterPropertiesSet, allowsUnusedParameters, checkCompiled, compile, declareParameter, getDeclaredParameters, getGeneratedKeysColumnNames, getJdbcTemplate, getResultSetType, getSql, isCompiled, isReturnGeneratedKeys, isUpdatableResults, resolveSql, setDataSource, setFetchSize, setGeneratedKeysColumnNames, setJdbcTemplate, setMaxRows, setParameters, setQueryTimeout, setResultSetType, setReturnGeneratedKeys, setSql, setTypes, setUpdatableResults, supportsLobParameters, validateNamedParameters, validateParameters
-
Constructor Details
-
SqlFunction
public SqlFunction()Constructor to allow use as a JavaBean. A DataSource, SQL and any parameters must be supplied before invoking thecompile
method and using this object. -
SqlFunction
Create a new SqlFunction object with SQL, but without parameters. Must add parameters or settle with none.- Parameters:
ds
- the DataSource to obtain connections fromsql
- the SQL to execute
-
SqlFunction
Create a new SqlFunction object with SQL and parameters.- Parameters:
ds
- the DataSource to obtain connections fromsql
- the SQL to executetypes
- the SQL types of the parameters, as defined in thejava.sql.Types
class- See Also:
-
SqlFunction
Create a new SqlFunction object with SQL, parameters and a result type.- Parameters:
ds
- the DataSource to obtain connections fromsql
- the SQL to executetypes
- the SQL types of the parameters, as defined in thejava.sql.Types
classresultType
- the type that the result object is required to match- See Also:
-
-
Method Details
-
setResultType
Specify the type that the result object is required to match.If not specified, the result value will be exposed as returned by the JDBC driver.
-
mapRow
This implementation of this method extracts a single value from the single row returned by the function. If there are a different number of rows returned, this is treated as an error.- Specified by:
mapRow
in classMappingSqlQuery<T>
- Parameters:
rs
- the ResultSet we're working throughrowNum
- row number (from 0) we're up to- Returns:
- an object of the result type
- Throws:
SQLException
- if there's an error extracting data. Subclasses can simply not catch SQLExceptions, relying on the framework to clean up.
-
run
public int run()Convenient method to run the function without arguments.- Returns:
- the value of the function
-
run
public int run(int parameter) Convenient method to run the function with a single int argument.- Parameters:
parameter
- single int parameter- Returns:
- the value of the function
-
run
Analogous to the SqlQuery.execute([]) method. This is a generic method to execute a query, taken a number of arguments.- Parameters:
parameters
- array of parameters. These will be objects or object wrapper types for primitives.- Returns:
- the value of the function
-
runGeneric
Convenient method to run the function without arguments, returning the value as an object.- Returns:
- the value of the function
-
runGeneric
Convenient method to run the function with a single int argument.- Parameters:
parameter
- single int parameter- Returns:
- the value of the function as an Object
-
runGeneric
Analogous to theSqlQuery.findObject(Object[])
method. This is a generic method to execute a query, taken a number of arguments.- Parameters:
parameters
- array of parameters. These will be objects or object wrapper types for primitives.- Returns:
- the value of the function, as an Object
- See Also:
-