001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.persistence;
037:
038: import java.lang.annotation.Target;
039: import java.lang.annotation.Retention;
040: import javax.persistence.CascadeType;
041: import static java.lang.annotation.ElementType.METHOD;
042: import static java.lang.annotation.ElementType.FIELD;
043: import static java.lang.annotation.RetentionPolicy.RUNTIME;
044: import static javax.persistence.FetchType.LAZY;
045:
046: /**
047: * Defines a many-valued association with one-to-many multiplicity.
048: *
049: * <p> If the collection is defined using generics to specify the
050: * element type, the associated target entity type need not be
051: * specified; otherwise the target entity class must be specified.
052: *
053: * <pre>
054: *
055: * Example 1: One-to-Many association using generics
056: *
057: * In Customer class:
058: *
059: * @OneToMany(cascade=ALL, mappedBy="customer")
060: * public Set<Order> getOrders() { return orders; }
061: *
062: * In Order class:
063: *
064: * @ManyToOne
065: * @JoinColumn(name="CUST_ID", nullable=false)
066: * public Customer getCustomer() { return customer; }
067: *
068: * Example 2: One-to-Many association without using generics
069: *
070: * In Customer class:
071: *
072: * @OneToMany(targetEntity=com.acme.Order.class, cascade=ALL,
073: * mappedBy="customer")
074: * public Set getOrders() { return orders; }
075: *
076: * In Order class:
077: *
078: * @ManyToOne
079: * @JoinColumn(name="CUST_ID", nullable=false)
080: * public Customer getCustomer() { return customer; }
081: * </pre>
082: *
083: * @since Java Persistence 1.0
084: */
085: @Target({METHOD,FIELD})
086: @Retention(RUNTIME)
087: public @interface OneToMany {
088:
089: /**
090: * (Optional) The entity class that is the target
091: * of the association. Optional only if the collection
092: * property is defined using Java generics.
093: * Must be specified otherwise.
094: *
095: * <p> Defaults to the parameterized type of
096: * the collection when defined using generics.
097: */
098: Class targetEntity() default void.class;
099:
100: /**
101: * (Optional) The operations that must be cascaded to
102: * the target of the association.
103: * <p> Defaults to no operations being cascaded.
104: */
105: CascadeType[] cascade() default {};
106:
107: /** (Optional) Whether the association should be
108: * lazily loaded or must be eagerly fetched. The
109: * {@link FetchType#EAGER EAGER} strategy is a
110: * requirement on the persistenceprovider runtime
111: * that the associatedentities must be eagerly fetched.
112: * The {@link FetchType#LAZY LAZY} strategy is a hint
113: * to the persistence provider runtime.
114: */
115: FetchType fetch() default LAZY;
116:
117: /**
118: * The field that owns the relationship. Required unless
119: * the relationship is unidirectional.
120: */
121: String mappedBy() default "";
122: }
|