Revision as of 06:08, 22 December 2009

EclipseLink JPA User's Guide

Development

The EclipseLink JPA User's Guide is being developed within the EclipseLink SVN repository @ https://dev.eclipse.org/svnroot/rt/org.eclipse.persistence/trunk/documentation/guides/jpa

OpenOffice

To edit the content XML files in OTN XSLT transforms are required. These DocBook transforms are available from OpenOffice.org.

To create a new chapter or section of the ELUG documentation, use the DocBookTemplate, available from OpenOffice.org.

Table of Contents

The following is the proposed TOC which is currently under development. Where applicable, show where existing ELUG wiki pages can be mined for initial content.

• Introduction
  • What is EclipseLink
    edit content from http://wiki.eclipse.org/EclipseLink/UserGuide/Overview_of_EclipseLink_Application_Development_(ELUG) and http://wiki.eclipse.org/EclipseLink/UserGuide/Developing_JPA_Projects_(ELUG)
• JPA Development Basics
  edit content from http://wiki.eclipse.org/Introduction_to_Java_Persistence_API_(ELUG)
  • Configuration
    • JPA
      • persistence.xml
        edit content from http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#What_You_May_Need_to_Know_About_Using_EclipseLink_JPA_Persistence_Unit_Properties and http://wiki.eclipse.org/Packaging_and_Deploying_EclipseLink_JPA_Applications_(ELUG)#How_to_Specify_the_Persistence_Unit_Name
      • annotations
      • orm.xml
        edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Using_XML
      • defaults
        edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Defaulting_Properties
      • eclipselink-orm.xml
        edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Overriding_and_Merging_XML
  • Mapping
    • Entity
      edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Configuring_an_Entity
      • Id
        edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#.40Id
    • Basic Mappings
      edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Declaring_Basic_Property_Mappings
      • Column
      • Default conversions & Converters
      • Lazy Basics (default FetchGroup)
    • Relationship Mappings
      edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Mapping_Relationships
      • Common Relationship Config
        • FetchType
      • Collection Mappings
        • Common Collection Config
        • OneToMany
        • ManyToMany
    • Locking
      • Optimistic Locking
  • Caching
    edit content from http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#Using_EclipseLink_JPA_Extensions_for_Entity_Caching
    • Shared and Isolated
    • Type & Size
    • Expiration
    • Coordination
      edit content from http://wiki.eclipse.org and http://wiki.eclipse.org/Configuring_a_Coordinated_Cache_(ELUG)/Introduction_to_Cache_(ELUG)#When_to_Use_Cache_Coordination
  • Querying
    • Overview of approaches: JPQL, Criteria, Native
      edit content from http://wiki.eclipse.org/Using_Basic_Query_API_(ELUG) and http://wiki.eclipse.org/Using_Advanced_Query_API_(ELUG)
  • Transactions
    edit content from http://wiki.eclipse.org/Introduction_to_Java_Persistence_API_(ELUG)#Transaction_Management and http://wiki.eclipse.org/Introduction_to_EclipseLink_Transactions_(ELUG)
    • Handling Concurrency Violations
• Advanced JPA
  • Performance Tuning
    edit content from http://wiki.eclipse.org/Optimizing_the_EclipseLink_Application_(ELUG)
    • Performance Profiling
      edit content from http://wiki.eclipse.org/Optimizing_the_EclipseLink_Application_(ELUG)#Measuring_EclipseLink_Performance_with_the_EclipseLink_Profiler
    • Weaving (What is it and why do I care)
      edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_Application_Development_(ELUG)#Using_Weaving and http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#Using_EclipseLink_JPA_Weaving
      • Understanding Weaving
        • Weaving JPA Entities
        • Weaving POJO Classes
        • Weaving and Java EE Application Servers
      • Configuring Dynamic Weaving
      • Configuring Static Weaving
      • Disabling Weaving with Persistence Unit Properties
    • FetchGroups
      edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG)#How_to_Configure_Fetch_Groups
  • Platform Specific
    edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG)
    • Oracle
    • DB2
    • MySQL
  • Dynamic