javax.persistence.PrimaryKeyJoinColumns Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation

Hibernate definition of the Java Persistence 2.0 (JSR 317) API.

There is a newer version: 1.0.1.Final

Show newest version

// $Id: PrimaryKeyJoinColumns.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Groups {@link PrimaryKeyJoinColumn} annotations.
 * It is used to map composite foreign keys.
 *
 *  *    Example: ValuedCustomer subclass
 *
 *    @Entity
 *    @Table(name="VCUST")
 *    @DiscriminatorValue("VCUST")
 *    @PrimaryKeyJoinColumns({
 *        @PrimaryKeyJoinColumn(name="CUST_ID",
 *            referencedColumnName="ID"),
 *        @PrimaryKeyJoinColumn(name="CUST_TYPE",
 *            referencedColumnName="TYPE")
 *    })
 *    public class ValuedCustomer extends Customer { ... }
 * 
 *
 * @since Java Persistence 1.0
 */
@Target({ TYPE, METHOD, FIELD })
@Retention(RUNTIME)
public @interface PrimaryKeyJoinColumns {
	/**
	 * One or more PrimaryKeyJoinColumn annotations.
	 */
	PrimaryKeyJoinColumn[] value();
}