public class SqlFunction<T> extends MappingSqlQuery<T>
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.
StoredProcedureMappingSqlQueryWithParameters.RowMapperImpllogger| Constructor and Description |
|---|
SqlFunction()
Constructor 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.
|
| Modifier and Type | Method and Description |
|---|---|
protected T |
mapRow(ResultSet rs,
int rowNum)
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 |
run(Object... parameters)
Analogous to the SqlQuery.execute([]) method.
|
Object |
runGeneric()
Convenient method to run the function without arguments,
returning the value as an object.
|
Object |
runGeneric(int parameter)
Convenient method to run the function with a single int argument.
|
Object |
runGeneric(Object[] parameters)
Analogous to the
SqlQuery.findObject(Object[]) method. |
void |
setResultType(Class<T> resultType)
Specify the type that the result object is required to match.
|
mapRownewRowMapperexecute, 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, setRowsExpectedcompileInternal, getParsedSql, newPreparedStatementCreator, newPreparedStatementCreator, newPreparedStatementSetter, onCompileInternalafterPropertiesSet, 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, validateParameterspublic SqlFunction()
compile method and using this object.public SqlFunction(DataSource ds, String sql)
ds - DataSource to obtain connections fromsql - SQL to executepublic SqlFunction(DataSource ds, String sql, int[] types)
ds - DataSource to obtain connections fromsql - SQL to executetypes - SQL types of the parameters, as defined in the
java.sql.Types classTypespublic SqlFunction(DataSource ds, String sql, int[] types, Class<T> resultType)
ds - DataSource to obtain connections fromsql - SQL to executetypes - SQL types of the parameters, as defined in the
java.sql.Types classresultType - the type that the result object is required to matchsetResultType(Class),
Typespublic void setResultType(Class<T> resultType)
If not specified, the result value will be exposed as returned by the JDBC driver.
@Nullable protected T mapRow(ResultSet rs, int rowNum) throws SQLException
mapRow in class MappingSqlQuery<T>rs - ResultSet we're working throughrowNum - row number (from 0) we're up toSQLException - if there's an error extracting data.
Subclasses can simply not catch SQLExceptions, relying on the
framework to clean up.public int run()
public int run(int parameter)
parameter - single int parameterpublic int run(Object... parameters)
parameters - array of parameters. These will be objects or
object wrapper types for primitives.@Nullable public Object runGeneric()
@Nullable public Object runGeneric(int parameter)
parameter - single int parameter@Nullable public Object runGeneric(Object[] parameters)
SqlQuery.findObject(Object[]) method.
This is a generic method to execute a query, taken a number of arguments.parameters - array of parameters. These will be objects or
object wrapper types for primitives.SqlQuery.execute(Object[])