Jump to: navigation, search

EclipseLink/UserGuide/JPA/Basic JPA Development/Configuration/JPA/orm.xml

< EclipseLink‎ | UserGuide‎ | JPA‎ | Basic JPA Development‎ | Configuration
Revision as of 13:16, 14 June 2011 by James.sutherland.oracle.com (Talk | contribs) (Specifying Object-Relational Mappings Using orm.xml)

EclipseLink JPA

Mailing ListForumsIRCmattermost
OpenHelp WantedBug Day
Browse Source

Specifying Object-Relational Mappings Using orm.xml

Use the orm.xml file to apply the metadata to the persistence unit. This metadata is a union of all the mapping files and the annotations (if there is no xml-mapping-metadata-complete element). If you use one mapping orm.xml file for your metadata and place this file in a META-INF directory on the classpath, then you do not need to explicitly list it. The EclipseLink persistence provider will automatically search for this file (orm.xml) and use it.

The schema for the JPA 2.0 orm.xml is orm_2_0.xsd.

If you use a different name for your mapping files or place them in a different location, you must list them in the mapping-file element of the persistence.xml file, as shown here:

 <persistence-unit name="EmployeeService">

Elug note icon.png

Note: In this example, the orm.xml file is not listed -- the persistence provider finds it by default.

Example of a orm.xml file

<?xml version="1.0" encoding="UTF-8"?>
<entity-mappings version="2.0"
        xsi:schemaLocation="http://java.sun.com/xml/ns/persistence/orm orm_2_0.xsd">
    <description>The minimal mappings for a persistent entity in XML.</description>
    <entity name="Employee" class="org.acme.Employee" access="FIELD">
            <id name="id"/>

Advantages and Disadvantages of Using XML

Some advantages of using XML instead of Annotations include:

  • No coupling between the metadata and the source code
  • Compliance with the existing, pre-EJB 3.0 development process
  • Support in IDEs and source control systems

The main disadvantages of mapping with XML include:

  • Its inherent complexitiy (when compared to annotations)
  • The need for replication of the code context

Version: 2.2.0 DRAFT
Other versions...