| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> |
| <meta http-equiv="Content-Style-Type" content="text/css" /> |
| <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| <title>Using the Embedded Key Class | EclipseLink 2.7 EclipseLink MOXy</title> |
| <meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" /> |
| <meta name="date" content="2014-06-10T10:25:32Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="Using the Embedded Key Class" /> |
| <meta name="relnum" content="Release 2.7" /> |
| <meta name="partnum" content="" /> |
| <link rel="stylesheet" type="text/css" href="../../dcommon/style.css" media="screen" /> |
| <link rel="copyright" href="../../dcommon/html/cpyr.htm" title="Copyright" type="text/html" /> |
| <link rel="start" href="../../index.htm" title="Home" type="text/html" /> |
| <link rel="contents" href="toc.htm" title="Contents" type="text/html" /> |
| <link rel="prev" href="shared_reference_relations002.htm" title="Previous" type="text/html" /> |
| <link rel="next" href="shared_reference_relations004.htm" title="Next" type="text/html" /> |
| <!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head> |
| <body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:1hjujor5_fg', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div> |
| <div class="header"><a id="top" name="top"></a> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td align="left" valign="top"><div class="booktitle">Developing JAXB Applications Using EclipseLink MOXy, |
| <b>Release 2.7</b><br /></font></td> |
| <td valign="bottom" align="right" width="144"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td> </td> |
| <td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br /> |
| </td><td> </td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td> </td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <hr /> |
| <table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center"> |
| <tr> |
| <td align="center"><a href="shared_reference_relations002.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="shared_reference_relations004.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td> |
| <td> </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="header" --> |
| <div class="ind"><!-- End Header --><a id="TLJAX350" name="TLJAX350"></a> |
| <div class="sect1"><!-- infolevel="all" infotype="General" --><a id="sthref132" name="sthref132"></a> |
| <h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Using the Embedded Key Class</font></h1> |
| <p>With JAXB, you can derive an XML representation from a set of JPA entities, when a JPA entity has an embedded ID class.</p> |
| <p>In <a href="#BABIJHJI">Example 7-4</a>, the <code>EmployeeId</code> is the embedded ID of the <strong>Employee</strong> class:</p> |
| <div class="example"><a id="BABIJHJI" name="BABIJHJI"></a><a id="TLJAX351" name="TLJAX351"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 7-4 Sample Embedded ID</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| @Entity |
| public class PhoneNumber { |
| |
| @ManyToOne |
| @JoinColumns({ |
| @JoinColumn(name="E_ID", referencedColumnName = "E_ID"), |
| @JoinColumn(name="E_COUNTRY", referencedColumnName = "COUNTRY") |
| }) |
| private Employee contact; |
| |
| } |
| |
| @Entity |
| @IdClass(EmployeeId.class) |
| public class Employee { |
| |
| <strong>@EmbeddedId</strong> |
| private EmployeeId id; |
| |
| @OneToMany(mappedBy="contact") |
| private List<PhoneNumber> contactNumber; |
| |
| } |
| |
| @Embeddable |
| public class EmployeeId { |
| |
| @Column(name="E_ID") |
| private BigDecimal eId; |
| |
| private String country; |
| |
| } |
| |
| </pre></div> |
| <!-- class="example" --> |
| <p>For the JAXB bindings, the XML accessor type will be set to <strong>FIELD</strong> for all the model classes. This can be set as a package level JAXB annotation, as shown here:</p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| @XmlAccessorType(XmlAccessType.FIELD) |
| package com.example.model; |
| |
| import javax.xml.bind.annotation.XmlAccessType; |
| import javax.xml.bind.annotation.XmlAccessorType; |
| |
| </pre> |
| <p><a href="#BABHCDEJ">Example 7-5</a> uses the EclipseLink extension <code>@XmlCustomizer</code> which extends the JAXB specification. Because the contact attribute is a bidirectional relationship, it includes the EclipseLink extension <code>@XmlInverseReference</code>.</p> |
| <div class="example"><a id="BABHCDEJ" name="BABHCDEJ"></a><a id="TLJAX352" name="TLJAX352"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 7-5 Using the @XmlCustomizer Annotation</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| @Entity |
| @IdClass(EmployeeId.class) |
| <strong>@XmlCustomizer(EmployeeCustomizer.class)</strong> |
| public class Employee { |
| |
| @EmbeddedId |
| private EmployeeId id; |
| |
| @OneToMany(mappedBy="contact") |
| @XmlInverseReference(mappedBy="contact") |
| private List<PhoneNumber> contactNumber; |
| |
| } |
| |
| </pre></div> |
| <!-- class="example" --> |
| <p>To embed the content of the <strong>EmployeeId</strong> class in the complex type corresponding to the <strong>Employee</strong> class, change the XPath on the mapping for the <code>id</code> property to be <em>self</em> or<strong> . </strong>. Then specify the XPath to the XML nodes which represent the ID.</p> |
| <div class="example"><a id="TLJAX353" name="TLJAX353"></a><a id="sthref133" name="sthref133"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 7-6 Changing the XPath</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| 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"); |
| <strong>idMapping.setXPath(".");</strong> |
| |
| descriptor.addPrimaryKeyFieldName("eId/text()"); |
| descriptor.addPrimaryKeyFieldName("country/text()"); |
| } |
| |
| } |
| |
| </pre></div> |
| <!-- class="example" --> |
| <p>If the target object had a single ID then we would use <code>@XmlIDREF</code>. Since the target object has a compound key, we will mark the field <code>@XmlTransient</code>, and use the EclipseLink extension <code>@XmlCustomizer</code> to set up the mapping.</p> |
| <div class="example"><a id="TLJAX354" name="TLJAX354"></a><a id="sthref134" name="sthref134"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 7-7 Using the @XmlTransient Annotation</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| @Entity |
| @XmlCustomizer(PhoneNumberCustomizer.class) |
| public class PhoneNumber { |
| |
| @ManyToOne |
| @JoinColumns({ |
| @JoinColumn(name="E_ID", referencedColumnName = "E_ID"), |
| @JoinColumn(name="E_COUNTRY", referencedColumnName = "COUNTRY") |
| }) |
| <strong>@XmlTransient</strong> |
| private Employee contact; |
| |
| } |
| |
| </pre></div> |
| <!-- class="example" --> |
| <p>An <code>XMLObjectReferenceMapping</code> will be created. The mapping will include multiple key mappings.</p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| 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); |
| } |
| |
| } |
| </pre></div> |
| <!-- class="sect1" --></div> |
| <!-- class="ind" --> |
| <!-- Start Footer --> |
| <div class="footer"> |
| <hr /> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <col width="33%" /> |
| <col width="*" /> |
| <col width="33%" /> |
| <tr> |
| <td valign="bottom"> |
| <table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center"> |
| <col width="*" /> |
| <col width="48%" /> |
| <col width="48%" /> |
| <tr> |
| <td> </td> |
| <td align="center"><a href="shared_reference_relations002.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="shared_reference_relations004.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td> |
| </tr> |
| </table> |
| </td> |
| <td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br /> |
| |
| |
| <td valign="bottom" align="right"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225"> |
| <tr> |
| <td> </td> |
| <td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br /> |
| </td><td> </td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td> </td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="footer" --> |
| <div id="copyright">Copyright © 2013 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body> |
| </html> |