Java Doc for SqlFunction.java in  » J2EE » spring-framework-2.5 » org » springframework » jdbc » object » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.5 » org.springframework.jdbc.object 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.jdbc.object.RdbmsOperation
      org.springframework.jdbc.object.SqlOperation
         org.springframework.jdbc.object.SqlQuery
            org.springframework.jdbc.object.MappingSqlQueryWithParameters
               org.springframework.jdbc.object.MappingSqlQuery
                  org.springframework.jdbc.object.SqlFunction

SqlFunction
public class SqlFunction extends MappingSqlQuery (Code)
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.
author:
   Rod Johnson
author:
   Juergen Hoeller
author:
   Jean-Pierre Pawlak
See Also:   org.springframework.jdbc.object.StoredProcedure




Constructor Summary
public  SqlFunction()
     Constructor to allow use as a JavaBean.
public  SqlFunction(DataSource ds, String sql)
     Create a new SqlFunction object with SQL, but without parameters.
public  SqlFunction(DataSource ds, String sql, int[] types)
     Create a new SqlFunction object with SQL and parameters.
public  SqlFunction(DataSource ds, String sql, int[] types, Class resultType)
     Create a new SqlFunction object with SQL, parameters and a result type.

Method Summary
protected  ObjectmapRow(ResultSet rs, int rowNum)
     This implementation of this method extracts a single value from the single row returned by the function.
public  intrun()
     Convenient method to run the function without arguments.
public  intrun(int parameter)
     Convenient method to run the function with a single int argument.
public  intrun(Object[] parameters)
     Analogous to the SqlQuery.execute([]) method.
public  ObjectrunGeneric()
     Convenient method to run the function without arguments, returning the value as an object.
public  ObjectrunGeneric(int parameter)
     Convenient method to run the function with a single int argument.
public  ObjectrunGeneric(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.
public  voidsetResultType(Class resultType)
     Specify the type that the result object is required to match.


Constructor Detail
SqlFunction
public SqlFunction()(Code)
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.
See Also:   SqlFunction.setDataSource
See Also:   SqlFunction.setSql
See Also:   SqlFunction.compile



SqlFunction
public SqlFunction(DataSource ds, String sql)(Code)
Create a new SqlFunction object with SQL, but without parameters. Must add parameters or settle with none.
Parameters:
  ds - DataSource to obtain connections from
Parameters:
  sql - SQL to execute



SqlFunction
public SqlFunction(DataSource ds, String sql, int[] types)(Code)
Create a new SqlFunction object with SQL and parameters.
Parameters:
  ds - DataSource to obtain connections from
Parameters:
  sql - SQL to execute
Parameters:
  types - SQL types of the parameters, as defined in thejava.sql.Types class
See Also:   java.sql.Types



SqlFunction
public SqlFunction(DataSource ds, String sql, int[] types, Class resultType)(Code)
Create a new SqlFunction object with SQL, parameters and a result type.
Parameters:
  ds - DataSource to obtain connections from
Parameters:
  sql - SQL to execute
Parameters:
  types - SQL types of the parameters, as defined in thejava.sql.Types class
Parameters:
  resultType - the type that the result object is required to match
See Also:   SqlFunction.setResultType(Class)
See Also:   java.sql.Types




Method Detail
mapRow
protected Object mapRow(ResultSet rs, int rowNum) throws SQLException(Code)
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.



run
public int run()(Code)
Convenient method to run the function without arguments. the value of the function



run
public int run(int parameter)(Code)
Convenient method to run the function with a single int argument.
Parameters:
  parameter - single int parameter the value of the function



run
public int run(Object[] parameters)(Code)
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 orobject wrapper types for primitives. the value of the function



runGeneric
public Object runGeneric()(Code)
Convenient method to run the function without arguments, returning the value as an object. the value of the function



runGeneric
public Object runGeneric(int parameter)(Code)
Convenient method to run the function with a single int argument.
Parameters:
  parameter - single int parameter the value of the function as an Object



runGeneric
public Object runGeneric(Object[] parameters)(Code)
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 orobject wrapper types for primitives. the value of the function, as an Object
See Also:   SqlFunction.execute(Object[])



setResultType
public void setResultType(Class resultType)(Code)
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.




Methods inherited from org.springframework.jdbc.object.MappingSqlQuery
final protected Object mapRow(ResultSet rs, int rowNum, Object[] parameters, Map context) throws SQLException(Code)(Java Doc)
abstract protected Object mapRow(ResultSet rs, int rowNum) throws SQLException(Code)(Java Doc)

Methods inherited from org.springframework.jdbc.object.MappingSqlQueryWithParameters
abstract protected Object mapRow(ResultSet rs, int rowNum, Object[] parameters, Map context) throws SQLException(Code)(Java Doc)
protected RowMapper newRowMapper(Object[] parameters, Map context)(Code)(Java Doc)

Methods inherited from org.springframework.jdbc.object.SqlQuery
public List execute(Object[] params, Map context) throws DataAccessException(Code)(Java Doc)
public List execute(Object[] params) throws DataAccessException(Code)(Java Doc)
public List execute(Map context) throws DataAccessException(Code)(Java Doc)
public List execute() throws DataAccessException(Code)(Java Doc)
public List execute(int p1, Map context) throws DataAccessException(Code)(Java Doc)
public List execute(int p1) throws DataAccessException(Code)(Java Doc)
public List execute(int p1, int p2, Map context) throws DataAccessException(Code)(Java Doc)
public List execute(int p1, int p2) throws DataAccessException(Code)(Java Doc)
public List execute(long p1, Map context) throws DataAccessException(Code)(Java Doc)
public List execute(long p1) throws DataAccessException(Code)(Java Doc)
public List execute(String p1, Map context) throws DataAccessException(Code)(Java Doc)
public List execute(String p1) throws DataAccessException(Code)(Java Doc)
public List executeByNamedParam(Map paramMap, Map context) throws DataAccessException(Code)(Java Doc)
public List executeByNamedParam(Map paramMap) throws DataAccessException(Code)(Java Doc)
public Object findObject(Object[] params, Map context) throws DataAccessException(Code)(Java Doc)
public Object findObject(Object[] params) throws DataAccessException(Code)(Java Doc)
public Object findObject(int p1, Map context) throws DataAccessException(Code)(Java Doc)
public Object findObject(int p1) throws DataAccessException(Code)(Java Doc)
public Object findObject(int p1, int p2, Map context) throws DataAccessException(Code)(Java Doc)
public Object findObject(int p1, int p2) throws DataAccessException(Code)(Java Doc)
public Object findObject(long p1, Map context) throws DataAccessException(Code)(Java Doc)
public Object findObject(long p1) throws DataAccessException(Code)(Java Doc)
public Object findObject(String p1, Map context) throws DataAccessException(Code)(Java Doc)
public Object findObject(String p1) throws DataAccessException(Code)(Java Doc)
public Object findObjectByNamedParam(Map paramMap, Map context) throws DataAccessException(Code)(Java Doc)
public Object findObjectByNamedParam(Map paramMap) throws DataAccessException(Code)(Java Doc)
public int getRowsExpected()(Code)(Java Doc)
abstract protected RowMapper newRowMapper(Object[] parameters, Map context)(Code)(Java Doc)
public void setRowsExpected(int rowsExpected)(Code)(Java Doc)

Methods inherited from org.springframework.jdbc.object.SqlOperation
final protected void compileInternal()(Code)(Java Doc)
protected ParsedSql getParsedSql()(Code)(Java Doc)
final protected PreparedStatementCreator newPreparedStatementCreator(Object[] params)(Code)(Java Doc)
final protected PreparedStatementCreator newPreparedStatementCreator(String sqlToUse, Object[] params)(Code)(Java Doc)
final protected PreparedStatementSetter newPreparedStatementSetter(Object[] params)(Code)(Java Doc)
protected void onCompileInternal()(Code)(Java Doc)

Fields inherited from org.springframework.jdbc.object.RdbmsOperation
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.jdbc.object.RdbmsOperation
public void afterPropertiesSet()(Code)(Java Doc)
protected boolean allowsUnusedParameters()(Code)(Java Doc)
protected void checkCompiled()(Code)(Java Doc)
final public void compile() throws InvalidDataAccessApiUsageException(Code)(Java Doc)
abstract protected void compileInternal() throws InvalidDataAccessApiUsageException(Code)(Java Doc)
public void declareParameter(SqlParameter param) throws InvalidDataAccessApiUsageException(Code)(Java Doc)
protected List getDeclaredParameters()(Code)(Java Doc)
public String[] getGeneratedKeysColumnNames()(Code)(Java Doc)
public JdbcTemplate getJdbcTemplate()(Code)(Java Doc)
public int getResultSetType()(Code)(Java Doc)
public String getSql()(Code)(Java Doc)
public boolean isCompiled()(Code)(Java Doc)
public boolean isReturnGeneratedKeys()(Code)(Java Doc)
public boolean isUpdatableResults()(Code)(Java Doc)
public void setDataSource(DataSource dataSource)(Code)(Java Doc)
public void setFetchSize(int fetchSize)(Code)(Java Doc)
public void setGeneratedKeysColumnNames(String[] names)(Code)(Java Doc)
public void setJdbcTemplate(JdbcTemplate jdbcTemplate)(Code)(Java Doc)
public void setMaxRows(int maxRows)(Code)(Java Doc)
public void setParameters(SqlParameter[] parameters)(Code)(Java Doc)
public void setQueryTimeout(int queryTimeout)(Code)(Java Doc)
public void setResultSetType(int resultSetType)(Code)(Java Doc)
public void setReturnGeneratedKeys(boolean returnGeneratedKeys)(Code)(Java Doc)
public void setSql(String sql)(Code)(Java Doc)
public void setTypes(int[] types) throws InvalidDataAccessApiUsageException(Code)(Java Doc)
public void setUpdatableResults(boolean updatableResults)(Code)(Java Doc)
protected boolean supportsLobParameters()(Code)(Java Doc)
protected void validateNamedParameters(Map parameters) throws InvalidDataAccessApiUsageException(Code)(Java Doc)
protected void validateParameters(Object[] parameters) throws InvalidDataAccessApiUsageException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.