|
|
| Line 1: |
Line 1: |
| − | {{EclipseLink_UserGuide
| + | '''[[Image:Elug_draft_icon.png|Warning]] This page is obsolete. Please see ''[http://www.eclipse.org/eclipselink/documentation/ Developing JAXB Applications Using EclipseLink MOXy]'' for current information.''' |
| − | |info=y
| + | |
| − | |toc=y
| + | |
| − | |eclipselink=y
| + | |
| − | |eclipselinktype=MOXy
| + | |
| − | }}
| + | |
| − | | + | |
| − | | + | |
| − | This example demonstrates how to derive an XML representation from a set of JPA entities using JAXB, when a JPA entity has an embedded ID class.
| + | |
| − | | + | |
| − | = JPA Entities =
| + | |
| − | The following JPA entities are used in this example:
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Entity
| + | |
| − | public class PhoneNumber {
| + | |
| − | | + | |
| − | @ManyToOne
| + | |
| − | @JoinColumns({
| + | |
| − | @JoinColumn(name="E_ID", referencedColumnName = "E_ID"),
| + | |
| − | @JoinColumn(name="E_COUNTRY", referencedColumnName = "COUNTRY")
| + | |
| − | })
| + | |
| − | private Employee contact;
| + | |
| − | | + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Entity
| + | |
| − | @IdClass(EmployeeId.class)
| + | |
| − | public class Employee {
| + | |
| − | | + | |
| − | @EmbeddedId
| + | |
| − | private EmployeeId id;
| + | |
| − | | + | |
| − | @OneToMany(mappedBy="contact")
| + | |
| − | private List<PhoneNumber> contactNumber;
| + | |
| − | | + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Embeddable
| + | |
| − | public class EmployeeId {
| + | |
| − | | + | |
| − | @Column(name="E_ID")
| + | |
| − | private BigDecimal eId;
| + | |
| − | | + | |
| − | private String country;
| + | |
| − | | + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | == JAXB Bindings ==
| + | |
| − | Here, the XML accessor type type is set to '''FIELD''' for all model classes. This can be set as a package level JAXB annotation.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @XmlAccessorType(XmlAccessType.FIELD)
| + | |
| − | package com.example.model;
| + | |
| − | | + | |
| − | import javax.xml.bind.annotation.XmlAccessType;
| + | |
| − | import javax.xml.bind.annotation.XmlAccessorType;
| + | |
| − | </source>
| + | |
| − | | + | |
| − | === Target Object ===
| + | |
| − | This entity uses the '''@XmLCustomizer''' EclipseLink extension to extend the JAXB specification. Because the relationship is bidirectional, we'll also use the '''@XmlInverseReference''' EclipseLink extension.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Entity
| + | |
| − | @IdClass(EmployeeId.class)
| + | |
| − | @XmlCustomizer(EmployeeCustomizer.class)
| + | |
| − | public class Employee {
| + | |
| − | | + | |
| − | @EmbeddedId
| + | |
| − | private EmployeeId id;
| + | |
| − | | + | |
| − | @OneToMany(mappedBy="contact")
| + | |
| − | @XmlInverseReference(mappedBy="contact")
| + | |
| − | private List<PhoneNumber> contactNumber;
| + | |
| − | | + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | To have the '''EmployeeId''' class be embedded in the complex type corresponding to the '''Employee''' class, change the XPath on the mapping for the '''id''' property to be self or '''.'''.
| + | |
| − | | + | |
| − | Then specify the XPath to the XML nodes which represent the ID.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | import org.eclipse.persistence.config.DescriptorCustomizer;
| + | |
| − | import org.eclipse.persistence.descriptors.ClassDescriptor;
| + | |
| − | import org.eclipse.persistence.oxm.mappings.XMLCompositeObjectMapping;
| + | |
| − | | + | |
| − | public class EmployeeCustomizer implements DescriptorCustomizer {
| + | |
| − | | + | |
| − | public void customize(ClassDescriptor descriptor) throws Exception {
| + | |
| − | XMLCompositeObjectMapping idMapping =
| + | |
| − | (XMLCompositeObjectMapping) descriptor.getMappingForAttributeName("id");
| + | |
| − | idMapping.setXPath(".");
| + | |
| − | | + | |
| − | descriptor.addPrimaryKeyFieldName("eId/text()");
| + | |
| − | descriptor.addPrimaryKeyFieldName("country/text()");
| + | |
| − | }
| + | |
| − | | + | |
| − | }</source>
| + | |
| − | | + | |
| − | === Source Object ===
| + | |
| − | | + | |
| − | If the target object had a single ID then we would use '''@XmlIDREF'''. However, since the target object has a compound key, we will mark the field '''@XmlTransient''', and use the EclipseLink extension '''@XmlCustomizer''' to set up the mapping.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | @Entity
| + | |
| − | @XmlCustomizer(PhoneNumberCustomizer.class)
| + | |
| − | public class PhoneNumber {
| + | |
| − | | + | |
| − | @ManyToOne
| + | |
| − | @JoinColumns({
| + | |
| − | @JoinColumn(name="E_ID", referencedColumnName = "E_ID"),
| + | |
| − | @JoinColumn(name="E_COUNTRY", referencedColumnName = "COUNTRY")
| + | |
| − | })
| + | |
| − | @XmlTransient
| + | |
| − | private Employee contact;
| + | |
| − | | + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | An '''XMLObjectReferenceMapping''' will be created. The mapping will include multiple key mappings.
| + | |
| − | | + | |
| − | <source lang="java">
| + | |
| − | import org.eclipse.persistence.config.DescriptorCustomizer;
| + | |
| − | import org.eclipse.persistence.descriptors.ClassDescriptor;
| + | |
| − | import org.eclipse.persistence.oxm.mappings.XMLObjectReferenceMapping;
| + | |
| − | | + | |
| − | public class PhoneNumberCustomizer implements DescriptorCustomizer {
| + | |
| − | | + | |
| − | public void customize(ClassDescriptor descriptor) throws Exception {
| + | |
| − | XMLObjectReferenceMapping contactMapping = new XMLObjectReferenceMapping();
| + | |
| − | contactMapping.setAttributeName("contact");
| + | |
| − | contactMapping.setReferenceClass(Employee.class);
| + | |
| − | contactMapping.addSourceToTargetKeyFieldAssociation("contact/@eID", "eId/text()");
| + | |
| − | contactMapping.addSourceToTargetKeyFieldAssociation("contact/@country", "country/text()");
| + | |
| − | descriptor.addMapping(contactMapping);
| + | |
| − | }
| + | |
| − | | + | |
| − | }
| + | |
| − | </source>
| + | |
| − | | + | |
| − | | + | |
| − | {{EclipseLink_MOXy
| + | |
| − | |previous= [[EclipseLink/UserGuide/MOXy/Mapping_JPA_Entities_to_XML|Mapping JPA Entities to XML]]
| + | |
| − | |next= [[EclipseLink/UserGuide/MOXy/Mapping JPA Entities to XML/Bidirectional Relationships|Bidirectional Relationships]]
| + | |
| − | |up= [[EclipseLink/UserGuide/MOXy/Mapping_JPA_Entities_to_XML|Mapping JPA Entities to XML]]
| + | |
| − | |version=2.2.0 DRAFT}}
| + | |
This page is obsolete. Please see Developing JAXB Applications Using EclipseLink MOXy for current information.