Java Doc for TopLinkDaoSupport.java in  » J2EE » spring-framework-2.0.6 » org » springframework » orm » toplink » support » 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.0.6 » org.springframework.orm.toplink.support 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.springframework.dao.support.DaoSupport
      org.springframework.orm.toplink.support.TopLinkDaoSupport

TopLinkDaoSupport
abstract public class TopLinkDaoSupport extends DaoSupport (Code)
Convenient super class for TopLink data access objects.

Requires a SessionFactory to be set, providing a TopLinkTemplate based on it to subclasses. Can alternatively be initialized directly with a TopLinkTemplate, to reuse the latter's settings such as the SessionFactory, exception translator, etc.

This base class is mainly intended for TopLinkTemplate usage but can also be used when working with SessionFactoryUtils directly, for example in combination with TopLinkInterceptor-managed Sessions. Convenience getSession and releaseSession methods are provided for that usage style.
author:
   Juergen Hoeller
since:
   1.2
See Also:   TopLinkDaoSupport.setSessionFactory
See Also:   TopLinkDaoSupport.setTopLinkTemplate
See Also:   TopLinkDaoSupport.getSession
See Also:   TopLinkDaoSupport.releaseSession
See Also:   org.springframework.orm.toplink.TopLinkTemplate
See Also:   org.springframework.orm.toplink.TopLinkInterceptor





Method Summary
final protected  voidcheckDaoConfig()
    
final protected  DataAccessExceptionconvertTopLinkAccessException(TopLinkException ex)
     Convert the given TopLinkException to an appropriate exception from the org.springframework.dao hierarchy.
protected  TopLinkTemplatecreateTopLinkTemplate(SessionFactory sessionFactory)
     Create a TopLinkTemplate for the given SessionFactory.
final protected  SessiongetSession()
     Get a TopLink Session, either from the current transaction or a new one. The latter is only allowed if the "allowCreate" setting of this bean's TopLinkTemplate is true.

Note that this is not meant to be invoked from TopLinkTemplate code but rather just in plain TopLink code. Either rely on a thread-bound Session (via TopLinkInterceptor), or use it in combination with releaseSession.

In general, it is recommended to use TopLinkTemplate, either with the provided convenience operations or with a custom TopLinkCallback that provides you with a Session to work on.

final protected  SessiongetSession(boolean allowCreate)
     Get a TopLink Session, either from the current transaction or a new one. The latter is only allowed if "allowCreate" is true.

Note that this is not meant to be invoked from TopLinkTemplate code but rather just in plain TopLink code. Either rely on a thread-bound Session (via TopLinkInterceptor), or use it in combination with releaseSession.

In general, it is recommended to use TopLinkTemplate, either with the provided convenience operations or with a custom TopLinkCallback that provides you with a Session to work on.

final public  SessionFactorygetSessionFactory()
     Return the TopLink SessionFactory used by this DAO.
final public  TopLinkTemplategetTopLinkTemplate()
     Return the TopLinkTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.
final protected  voidreleaseSession(Session session)
     Close the given TopLink Session, created via this DAO's SessionFactory, if it isn't bound to the thread.
final public  voidsetSessionFactory(SessionFactory sessionFactory)
     Set the TopLink SessionFactory to be used by this DAO.
final public  voidsetTopLinkTemplate(TopLinkTemplate topLinkTemplate)
     Set the TopLinkTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.



Method Detail
checkDaoConfig
final protected void checkDaoConfig()(Code)



convertTopLinkAccessException
final protected DataAccessException convertTopLinkAccessException(TopLinkException ex)(Code)
Convert the given TopLinkException to an appropriate exception from the org.springframework.dao hierarchy. Will automatically detect wrapped SQLExceptions and convert them accordingly.

Delegates to the convertTopLinkAccessException method of this DAO's TopLinkTemplate.
Parameters:
  ex - TopLinkException that occured the corresponding DataAccessException instance
See Also:   TopLinkDaoSupport.setTopLinkTemplate
See Also:   org.springframework.orm.toplink.TopLinkTemplate.convertTopLinkAccessException




createTopLinkTemplate
protected TopLinkTemplate createTopLinkTemplate(SessionFactory sessionFactory)(Code)
Create a TopLinkTemplate for the given SessionFactory. Only invoked if populating the DAO with a SessionFactory reference!

Can be overridden in subclasses to provide a TopLinkTemplate instance with different configuration, or a custom TopLinkTemplate subclass.
Parameters:
  sessionFactory - the TopLink SessionFactory to create a TopLinkTemplate for the new TopLinkTemplate instance
See Also:   TopLinkDaoSupport.setSessionFactory




getSession
final protected Session getSession() throws DataAccessResourceFailureException, IllegalStateException(Code)
Get a TopLink Session, either from the current transaction or a new one. The latter is only allowed if the "allowCreate" setting of this bean's TopLinkTemplate is true.

Note that this is not meant to be invoked from TopLinkTemplate code but rather just in plain TopLink code. Either rely on a thread-bound Session (via TopLinkInterceptor), or use it in combination with releaseSession.

In general, it is recommended to use TopLinkTemplate, either with the provided convenience operations or with a custom TopLinkCallback that provides you with a Session to work on. TopLinkTemplate will care for all resource management and for proper exception conversion. the TopLink Session
throws:
  DataAccessResourceFailureException - if the Session couldn't be created
throws:
  IllegalStateException - if no thread-bound Session found and allowCreate false
See Also:   TopLinkTemplate
See Also:   org.springframework.orm.toplink.SessionFactoryUtils.getSession(SessionFactoryboolean)
See Also:   org.springframework.orm.toplink.TopLinkInterceptor
See Also:   org.springframework.orm.toplink.TopLinkTemplate
See Also:   org.springframework.orm.toplink.TopLinkCallback




getSession
final protected Session getSession(boolean allowCreate) throws DataAccessResourceFailureException, IllegalStateException(Code)
Get a TopLink Session, either from the current transaction or a new one. The latter is only allowed if "allowCreate" is true.

Note that this is not meant to be invoked from TopLinkTemplate code but rather just in plain TopLink code. Either rely on a thread-bound Session (via TopLinkInterceptor), or use it in combination with releaseSession.

In general, it is recommended to use TopLinkTemplate, either with the provided convenience operations or with a custom TopLinkCallback that provides you with a Session to work on. TopLinkTemplate will care for all resource management and for proper exception conversion.
Parameters:
  allowCreate - if a new Session should be created if no thread-bound found the TopLink Session
throws:
  DataAccessResourceFailureException - if the Session couldn't be created
throws:
  IllegalStateException - if no thread-bound Session found and allowCreate false
See Also:   org.springframework.orm.toplink.SessionFactoryUtils.getSession(SessionFactoryboolean)
See Also:   org.springframework.orm.toplink.TopLinkInterceptor
See Also:   org.springframework.orm.toplink.TopLinkTemplate
See Also:   org.springframework.orm.toplink.TopLinkCallback




getSessionFactory
final public SessionFactory getSessionFactory()(Code)
Return the TopLink SessionFactory used by this DAO.



getTopLinkTemplate
final public TopLinkTemplate getTopLinkTemplate()(Code)
Return the TopLinkTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.



releaseSession
final protected void releaseSession(Session session)(Code)
Close the given TopLink Session, created via this DAO's SessionFactory, if it isn't bound to the thread.
Parameters:
  session - the TopLink Session to close
See Also:   org.springframework.orm.toplink.SessionFactoryUtils.releaseSession



setSessionFactory
final public void setSessionFactory(SessionFactory sessionFactory)(Code)
Set the TopLink SessionFactory to be used by this DAO. Will automatically create a TopLinkTemplate for the given SessionFactory.
See Also:   TopLinkDaoSupport.createTopLinkTemplate
See Also:   TopLinkDaoSupport.setTopLinkTemplate



setTopLinkTemplate
final public void setTopLinkTemplate(TopLinkTemplate topLinkTemplate)(Code)
Set the TopLinkTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.
See Also:   TopLinkDaoSupport.setSessionFactory



Fields inherited from org.springframework.dao.support.DaoSupport
final protected Log logger(Code)(Java Doc)

Methods inherited from org.springframework.dao.support.DaoSupport
final public void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException(Code)(Java Doc)
abstract protected void checkDaoConfig() throws IllegalArgumentException(Code)(Java Doc)
protected void initDao() throws Exception(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.