public class

SqlFunction

extends MappingSqlQuery<T>

java.lang.Object
↳	org.springframework.jdbc.object.RdbmsOperation
	↳	org.springframework.jdbc.object.SqlOperation
		↳	org.springframework.jdbc.object.SqlQuery<T>
			↳	org.springframework.jdbc.object.MappingSqlQueryWithParameters<T>
				↳	org.springframework.jdbc.object.MappingSqlQuery<T>
					↳	org.springframework.jdbc.object.SqlFunction<T>

Class Overview

SQL "function" wrapper for a query that returns a single row of results. The default behavior is to return an int, but that can be overridden by using the constructor with an extra return type parameter.

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.

Summary

[Expand]

Inherited Fields

From class org.springframework.jdbc.object.RdbmsOperation

Public Constructors
	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.

Public Methods
int	run(Object... parameters) Analogous to the SqlQuery.execute([]) method.
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.
Object	runGeneric(Object[] parameters) Analogous to the `SqlQuery.findObject(Object[])` method.
Object	runGeneric(int parameter) Convenient method to run the function with a single int argument.
Object	runGeneric() Convenient method to run the function without arguments, returning the value as an object.
void	setResultType(Class<T> resultType) Specify the type that the result object is required to match.

Protected Methods
T	mapRow(ResultSet rs, int rowNum) This implementation of this method extracts a single value from the single row returned by the function.

[Expand]

Inherited Methods

From class org.springframework.jdbc.object.MappingSqlQuery

From class org.springframework.jdbc.object.MappingSqlQueryWithParameters

From class org.springframework.jdbc.object.SqlQuery

List<T>	execute(String p1) Convenient method to execute with a single String parameter.
List<T>	execute(long p1) Convenient method to execute with a single long parameter.
List<T>	execute(int p1, int p2) Convenient method to execute with two int parameters.
List<T>	execute() Convenient method to execute without parameters nor context.
List<T>	execute(int p1, Map context) Convenient method to execute with a single int parameter and context.
List<T>	execute(Map context) Convenient method to execute without parameters.
List<T>	execute(String p1, Map context) Convenient method to execute with a single String parameter and context.
List<T>	execute(int p1) Convenient method to execute with a single int parameter.
List<T>	execute(Object... params) Convenient method to execute without context.
List<T>	execute(int p1, int p2, Map context) Convenient method to execute with two int parameters and context.
List<T>	execute(Object[] params, Map context) Central execution method.
List<T>	execute(long p1, Map context) Convenient method to execute with a single long parameter and context.
List<T>	executeByNamedParam(Map<String, ?> paramMap) Convenient method to execute without context.
List<T>	executeByNamedParam(Map<String, ?> paramMap, Map context) Central execution method.
T	findObject(int p1) Convenient method to find a single object given a single int parameter.
T	findObject(Object[] params, Map context) Generic object finder method, used by all other `findObject` methods.
T	findObject(int p1, Map context) Convenient method to find a single object given a single int parameter and a context.
T	findObject(String p1, Map context) Convenient method to find a single object given a single String parameter and a context.
T	findObject(Object... params) Convenient method to find a single object without context.
T	findObject(long p1, Map context) Convenient method to find a single object given a single long parameter and a context.
T	findObject(int p1, int p2, Map context) Convenient method to find a single object given two int parameters and a context.
T	findObject(long p1) Convenient method to find a single object given a single long parameter.
T	findObject(int p1, int p2) Convenient method to find a single object given two int parameters.
T	findObject(String p1) Convenient method to find a single object given a single String parameter.
T	findObjectByNamedParam(Map<String, ?> paramMap, Map context) Generic object finder method for named parameters.
T	findObjectByNamedParam(Map<String, ?> paramMap) Convenient method to execute without context.
int	getRowsExpected() Get the number of rows expected.
abstract RowMapper<T>	newRowMapper(Object[] parameters, Map context) Subclasses must implement this method to extract an object per row, to be returned by the execute method as an aggregated `List`.
void	setRowsExpected(int rowsExpected) Set the number of rows expected.

From class org.springframework.jdbc.object.SqlOperation

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 SqlFunction ()

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 SqlFunction (DataSource ds, String sql)

Create a new SqlFunction 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 SqlFunction (DataSource ds, String sql, int[] types)

Create a new SqlFunction object with SQL and parameters.

Parameters

ds	DataSource to obtain connections from
sql	SQL to execute
types	SQL types of the parameters, as defined in the `java.sql.Types` class

public SqlFunction (DataSource ds, String sql, int[] types, Class<T> resultType)

Create a new SqlFunction object with SQL, parameters and a result type.

Parameters

ds	DataSource to obtain connections from
sql	SQL to execute
types	SQL types of the parameters, as defined in the `java.sql.Types` class
resultType	the type that the result object is required to match

Public Methods

public int run (Object... parameters)

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

public int run ()

Convenient method to run the function without arguments.

Returns

the value of the function

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

public Object runGeneric (Object[] parameters)

Analogous to the SqlQuery.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

public Object runGeneric (int parameter)

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

public Object runGeneric ()

Convenient method to run the function without arguments, returning the value as an object.

Returns

the value of the function

public void setResultType (Class<T> resultType)

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.

Protected Methods

protected T mapRow (ResultSet rs, int rowNum)

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.

Parameters

rs	ResultSet we're working through
rowNum	row number (from 0) we're up to

Returns

an object of the result type

Throws

SQLException

Classes

SqlFunction

Class Overview

See Also

Summary

Public Constructors

public SqlFunction ()

See Also

public SqlFunction (DataSource ds, String sql)

Parameters

public SqlFunction (DataSource ds, String sql, int[] types)

Parameters

See Also

public SqlFunction (DataSource ds, String sql, int[] types, Class<T> resultType)

Parameters

See Also

Public Methods

public int run (Object... parameters)

Parameters

Returns

public int run ()

Returns

public int run (int parameter)

Parameters

Returns

public Object runGeneric (Object[] parameters)

Parameters

Returns

See Also

public Object runGeneric (int parameter)

Parameters

Returns

public Object runGeneric ()

Returns

public void setResultType (Class<T> resultType)

Protected Methods

protected T mapRow (ResultSet rs, int rowNum)

Parameters

Returns

Throws