| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>OneToMany</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OneToMany"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/persistence/NoResultException.html" title="class in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/persistence/OneToOne.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/persistence/OneToMany.html" target="_top">Frames</a></li> |
| <li><a href="OneToMany.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.persistence</div> |
| <h2 title="Annotation Type OneToMany" class="title">Annotation Type OneToMany</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Target(value={METHOD,FIELD}) |
| @Retention(value=RUNTIME) |
| public @interface <span class="memberNameLabel">OneToMany</span></pre> |
| <div class="block">Specifies a many-valued association with one-to-many multiplicity. |
| |
| <p> If the collection is defined using generics to specify the |
| element type, the associated target entity type need not be |
| specified; otherwise the target entity class must be specified. |
| If the relationship is bidirectional, the |
| <code> mappedBy</code> element must be used to specify the relationship field or |
| property of the entity that is the owner of the relationship. |
| |
| <p> The <code>OneToMany</code> annotation may be used within an embeddable class |
| contained within an entity class to specify a relationship to a |
| collection of entities. If the relationship is bidirectional, the |
| <code> mappedBy</code> element must be used to specify the relationship field or |
| property of the entity that is the owner of the relationship. |
| |
| When the collection is a <code>java.util.Map</code>, the <code>cascade</code> |
| element and the <code>orphanRemoval</code> element apply to the map value. |
| |
| <pre> |
| |
| Example 1: One-to-Many association using generics |
| |
| // In Customer class: |
| |
| @OneToMany(cascade=ALL, mappedBy="customer") |
| public Set<Order> getOrders() { return orders; } |
| |
| In Order class: |
| |
| @ManyToOne |
| @JoinColumn(name="CUST_ID", nullable=false) |
| public Customer getCustomer() { return customer; } |
| |
| |
| Example 2: One-to-Many association without using generics |
| |
| // In Customer class: |
| |
| @OneToMany(targetEntity=com.acme.Order.class, cascade=ALL, |
| mappedBy="customer") |
| public Set getOrders() { return orders; } |
| |
| // In Order class: |
| |
| @ManyToOne |
| @JoinColumn(name="CUST_ID", nullable=false) |
| public Customer getCustomer() { return customer; } |
| |
| |
| Example 3: Unidirectional One-to-Many association using a foreign key mapping |
| |
| // In Customer class: |
| |
| @OneToMany(orphanRemoval=true) |
| @JoinColumn(name="CUST_ID") // join column is in table for Order |
| public Set<Order> getOrders() {return orders;} |
| |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="simpleTagLabel">Examples (en):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/examples/rest-example.html">rest-example</a>, <a href="../../../../../tomee-9.0/examples/polling-parent.html">polling-parent</a>, <a href="../../../../../tomee-9.0/examples/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| <dt><span class="simpleTagLabel">Examples (es):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/es/examples/polling-parent.html">polling-parent</a></dd> |
| <dt><span class="simpleTagLabel">Examples (pt):</span></dt> |
| <dd><a href="../../../../../tomee-9.0/pt/examples/polling-parent.html">polling-parent</a>, <a href="../../../../../tomee-9.0/pt/examples/deltaspike-fullstack.html">deltaspike-fullstack</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/persistence/CascadeType.html" title="enum in jakarta.persistence">CascadeType</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/OneToMany.html#cascade--">cascade</a></span></code> |
| <div class="block">(Optional) The operations that must be cascaded to |
| the target of the association.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/persistence/FetchType.html" title="enum in jakarta.persistence">FetchType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/OneToMany.html#fetch--">fetch</a></span></code> |
| <div class="block">(Optional) Whether the association should be lazily loaded or |
| must be eagerly fetched.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/OneToMany.html#mappedBy--">mappedBy</a></span></code> |
| <div class="block">The field that owns the relationship.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/OneToMany.html#orphanRemoval--">orphanRemoval</a></span></code> |
| <div class="block">(Optional) Whether to apply the remove operation to entities that have |
| been removed from the relationship and to cascade the remove operation to |
| those entities.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>java.lang.Class</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/OneToMany.html#targetEntity--">targetEntity</a></span></code> |
| <div class="block">(Optional) The entity class that is the target |
| of the association.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="targetEntity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>targetEntity</h4> |
| <pre>public abstract java.lang.Class targetEntity</pre> |
| <div class="block">(Optional) The entity class that is the target |
| of the association. Optional only if the collection |
| property is defined using Java generics. |
| Must be specified otherwise. |
| |
| <p> Defaults to the parameterized type of |
| the collection when defined using generics.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>void.class</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="cascade--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascade</h4> |
| <pre>public abstract <a href="../../jakarta/persistence/CascadeType.html" title="enum in jakarta.persistence">CascadeType</a>[] cascade</pre> |
| <div class="block">(Optional) The operations that must be cascaded to |
| the target of the association. |
| <p> Defaults to no operations being cascaded. |
| |
| <p> When the target collection is a <code>java.util.Map</code>, the <code>cascade</code> element applies to the |
| map value.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>{}</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fetch--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetch</h4> |
| <pre>public abstract <a href="../../jakarta/persistence/FetchType.html" title="enum in jakarta.persistence">FetchType</a> fetch</pre> |
| <div class="block">(Optional) Whether the association should be lazily loaded or |
| must be eagerly fetched. The EAGER strategy is a requirement on |
| the persistence provider runtime that the associated entities |
| must be eagerly fetched. The LAZY strategy is a hint to the |
| persistence provider runtime.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>jakarta.persistence.FetchType.LAZY</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="mappedBy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mappedBy</h4> |
| <pre>public abstract java.lang.String mappedBy</pre> |
| <div class="block">The field that owns the relationship. Required unless |
| the relationship is unidirectional.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="orphanRemoval--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>orphanRemoval</h4> |
| <pre>public abstract boolean orphanRemoval</pre> |
| <div class="block">(Optional) Whether to apply the remove operation to entities that have |
| been removed from the relationship and to cascade the remove operation to |
| those entities.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| <dl> |
| <dt>Default:</dt> |
| <dd>false</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/persistence/NoResultException.html" title="class in jakarta.persistence"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/persistence/OneToOne.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/persistence/OneToMany.html" target="_top">Frames</a></li> |
| <li><a href="OneToMany.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |