| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 --> |
| <title>XmlIDREF (EclipseLink 3.0.0, API Reference)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-04-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XmlIDREF (EclipseLink 3.0.0, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Element</li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.xml.bind.annotation</a></div> |
| <h2 title="Annotation Type XmlIDREF" class="title">Annotation Type XmlIDREF</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation" class="externalLink">RUNTIME</a>) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Target</a>({<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation" class="externalLink">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation" class="externalLink">METHOD</a>}) |
| public @interface <span class="memberNameLabel">XmlIDREF</span></pre> |
| <div class="block"><p> |
| Maps a JavaBean property to XML IDREF. |
| |
| <p> |
| To preserve referential integrity of an object graph across XML |
| serialization followed by a XML deserialization, requires an object |
| reference to be marshaled by reference or containment |
| appropriately. Annotations <code>@XmlID</code> and <code>@XmlIDREF</code> |
| together allow a customized mapping of a JavaBean property's |
| type by containment or reference. |
| |
| <p><b>Usage</b> </p> |
| The <code>@XmlIDREF</code> annotation can be used with the following |
| program elements: |
| <ul> |
| <li> a JavaBean property </li> |
| <li> non static, non transient field </li> |
| </ul> |
| |
| <p>See "Package Specification" in jakarta.xml.bind.package javadoc for |
| additional common information.</p> |
| |
| <p> The usage is subject to the following constraints: |
| <ul> |
| |
| <li> If the type of the field or property is a collection type, |
| then the collection item type must contain a property or |
| field annotated with <code>@XmlID</code>. </li> |
| <li> If the field or property is single valued, then the type of |
| the property or field must contain a property or field |
| annotated with <code>@XmlID</code>. |
| <p>Note: If the collection item type or the type of the |
| property (for non collection type) is java.lang.Object, then |
| the instance must contain a property/field annotated with |
| <code>@XmlID</code> attribute. |
| </li> |
| <li> This annotation can be used with the following annotations: |
| <a href="XmlElement.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlElement</code></a>, <a href="XmlAttribute.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlAttribute</code></a>, <a href="XmlList.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlList</code></a>, |
| and <a href="XmlElements.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlElements</code></a>.</li> |
| |
| </ul> |
| <p><b>Example:</b> Map a JavaBean property to <code>xs:IDREF</code> |
| (i.e. by reference rather than by containment)</p> |
| <pre> |
| |
| //EXAMPLE: Code fragment |
| public class Shipping { |
| @XmlIDREF public Customer getCustomer(); |
| public void setCustomer(Customer customer); |
| .... |
| } |
| <code> |
| |
| <!-- Example: XML Schema fragment --> |
| <xs:complexType name="Shipping"> |
| <xs:complexContent> |
| <xs:sequence> |
| <xs:element name="customer" type="xs:IDREF"/> |
| .... |
| </xs:sequence> |
| </xs:complexContent> |
| </xs:complexType> |
| |
| </code></pre> |
| |
| |
| <p><b>Example 2: </b> The following is a complete example of |
| containment versus reference. |
| |
| <pre> |
| // By default, Customer maps to complex type <code>xs:Customer</code> |
| public class Customer { |
| |
| // map JavaBean property type to <code>xs:ID</code> |
| @XmlID public String getCustomerID(); |
| public void setCustomerID(String id); |
| |
| // .... other properties not shown |
| } |
| |
| |
| // By default, Invoice maps to a complex type <code>xs:Invoice</code> |
| public class Invoice { |
| |
| // map by reference |
| @XmlIDREF public Customer getCustomer(); |
| public void setCustomer(Customer customer); |
| |
| // .... other properties not shown here |
| } |
| |
| // By default, Shipping maps to complex type <code>xs:Shipping</code> |
| public class Shipping { |
| |
| // map by reference |
| @XmlIDREF public Customer getCustomer(); |
| public void setCustomer(Customer customer); |
| } |
| |
| // at least one class must reference Customer by containment; |
| // Customer instances won't be marshalled. |
| @XmlElement(name="CustomerData") |
| public class CustomerData { |
| // map reference to Customer by containment by default. |
| public Customer getCustomer(); |
| |
| // maps reference to Shipping by containment by default. |
| public Shipping getShipping(); |
| |
| // maps reference to Invoice by containment by default. |
| public Invoice getInvoice(); |
| } |
| <code> |
| |
| <!-- XML Schema mapping for above code frament --> |
| |
| <xs:complexType name="Invoice"> |
| <xs:complexContent> |
| <xs:sequence> |
| <xs:element name="customer" type="xs:IDREF"/> |
| .... |
| </xs:sequence> |
| </xs:complexContent> |
| </xs:complexType> |
| |
| <xs:complexType name="Shipping"> |
| <xs:complexContent> |
| <xs:sequence> |
| <xs:element name="customer" type="xs:IDREF"/> |
| .... |
| </xs:sequence> |
| </xs:complexContent> |
| </xs:complexType> |
| |
| <xs:complexType name="Customer"> |
| <xs:complexContent> |
| <xs:sequence> |
| .... |
| </xs:sequence> |
| <xs:attribute name="CustomerID" type="xs:ID"/> |
| </xs:complexContent> |
| </xs:complexType> |
| |
| <xs:complexType name="CustomerData"> |
| <xs:complexContent> |
| <xs:sequence> |
| <xs:element name="customer" type="xs:Customer"/> |
| <xs:element name="shipping" type="xs:Shipping"/> |
| <xs:element name="invoice" type="xs:Invoice"/> |
| </xs:sequence> |
| </xs:complexContent> |
| </xs:complexType> |
| |
| <xs:element name"customerData" type="xs:CustomerData"/> |
| |
| <!-- Instance document conforming to the above XML Schema --> |
| <customerData> |
| <customer customerID="Alice"> |
| .... |
| </customer> |
| |
| <shipping customer="Alice"> |
| .... |
| </shipping> |
| |
| <invoice customer="Alice"> |
| .... |
| </invoice> |
| </customerData> |
| |
| </code></pre> |
| |
| <p><b>Example 3: </b> Mapping List to repeating element of type IDREF |
| <pre> |
| // Code fragment |
| public class Shipping { |
| @XmlIDREF |
| @XmlElement(name="Alice") |
| public List customers; |
| } |
| <code> |
| |
| <!-- XML schema fragment --> |
| <xs:complexType name="Shipping"> |
| <xs:sequence> |
| <xs:choice minOccurs="0" maxOccurs="unbounded"> |
| <xs:element name="Alice" type="xs:IDREF"/> |
| </xs:choice> |
| </xs:sequence> |
| </xs:complexType> |
| </code></pre> |
| |
| <p><b>Example 4: </b> Mapping a List to a list of elements of type IDREF. |
| <pre> |
| //Code fragment |
| public class Shipping { |
| @XmlIDREF |
| @XmlElements( |
| @XmlElement(name="Alice", type="Customer.class") |
| @XmlElement(name="John", type="InternationalCustomer.class") |
| public List customers; |
| } |
| <code> |
| |
| <!-- XML Schema fragment --> |
| <xs:complexType name="Shipping"> |
| <xs:sequence> |
| <xs:choice minOccurs="0" maxOccurs="unbounded"> |
| <xs:element name="Alice" type="xs:IDREF"/> |
| <xs:element name="John" type="xs:IDREF"/> |
| </xs:choice> |
| </xs:sequence> |
| </xs:complexType> |
| </code></pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="XmlID.html" title="annotation in jakarta.xml.bind.annotation"><code>XmlID</code></a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Sekhar Vajjhala, Sun Microsystems, Inc.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAXB 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Element</li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2017–2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
