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.FIELD;
042: import static java.lang.annotation.ElementType.METHOD;
043: import static java.lang.annotation.RetentionPolicy.RUNTIME;
044: import static javax.persistence.FetchType.LAZY;
045:
046: /**
047: * Defines a many-valued association with many-to-many multiplicity.
048: * If the Collection is defined using generics to specify the element
049: * type, the associated target entity class does not need to be
050: * specified; otherwise it must be specified.
051: *
052: * <p> Every many-to-many association has two sides, the owning
053: * side and the non-owning, or inverse, side. The join table is
054: * specified on the owning side. If the association is bidirectional,
055: * either side may be designated as the owning side.
056: *
057: * <p> The same annotation elements for the {@link OneToMany}
058: * annotation apply to the <code>ManyToMany</code> annotation.
059: *
060: * <pre>
061: *
062: * Example 1:
063: *
064: * In Customer class:
065: *
066: * @ManyToMany
067: * @JoinTable(name="CUST_PHONES")
068: * public Set<PhoneNumber> getPhones() { return phones; }
069: *
070: * In PhoneNumber class:
071: *
072: * @ManyToMany(mappedBy="phones")
073: * public Set<Customer> getCustomers() { return customers; }
074: *
075: * Example 2:
076: *
077: * In Customer class:
078: *
079: * @ManyToMany(targetEntity=com.acme.PhoneNumber.class)
080: * public Set getPhones() { return phones; }
081: *
082: * In PhoneNumber class:
083: *
084: * @ManyToMany(targetEntity=com.acme.Customer.class, mappedBy="phones")
085: * public Set getCustomers() { return customers; }
086: *
087: * Example 3:
088: *
089: * In Customer class:
090: *
091: * @ManyToMany
092: * @JoinTable(name="CUST_PHONE",
093: * joinColumns=
094: * @JoinColumn(name="CUST_ID", referencedColumnName="ID"),
095: * inverseJoinColumns=
096: * @JoinColumn(name="PHONE_ID", referencedColumnName="ID")
097: * )
098: * public Set<PhoneNumber> getPhones() { return phones; }
099: *
100: * In PhoneNumberClass:
101: *
102: * @ManyToMany(mappedBy="phones")
103: * public Set<Customer> getCustomers() { return customers; }
104: * </pre>
105: *
106: * @since Java Persistence 1.0
107: */
108: @Target({METHOD,FIELD})
109: @Retention(RUNTIME)
110: public @interface ManyToMany {
111:
112: /**
113: * (Optional) The entity class that is the target
114: * of the association. Optional only if the collection
115: * property is defined using Java generics.
116: * Must be specified otherwise.
117: *
118: * <p> Defaults to the parameterized type of
119: * the collection when defined using generics.
120: */
121: Class targetEntity() default void.class;
122:
123: /**
124: * (Optional) The operations that must be cascaded to
125: * the target of the association.
126: * <p> Defaults to no operations being cascaded.
127: */
128: CascadeType[] cascade() default {};
129:
130: /** (Optional) Whether the association should be
131: * lazily loaded or must be eagerly fetched. The
132: * {@link FetchType#EAGER EAGER} strategy is a
133: * requirement on the persistenceprovider runtime
134: * that the associatedentities must be eagerly fetched.
135: * The {@link FetchType#LAZY LAZY} strategy is a hint
136: * to the persistence provider runtime.
137: */
138: FetchType fetch() default LAZY;
139:
140: /**
141: * The field that owns the relationship. Required unless
142: * the relationship is unidirectional.
143: */
144: String mappedBy() default "";
145: }
|