javax.persistence.SecondaryTables 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: SecondaryTables.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.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Specifies multiple secondary tables for an entity.
 *
 *  *    Example 1: Multiple secondary tables assuming primary key columns are named the same in all tables.
 *
 *    @Entity
 *    @Table(name="EMPLOYEE")
 *    @SecondaryTables({
 *        @SecondaryTable(name="EMP_DETAIL"),
 *        @SecondaryTable(name="EMP_HIST")
 *    })
 *    public class Employee { ... }
 *
 *
 *    Example 2: Multiple secondary tables with differently named primary key columns.
 *
 *    @Entity
 *    @Table(name="EMPLOYEE")
 *    @SecondaryTables({
 *        @SecondaryTable(name="EMP_DETAIL",
 *            pkJoinColumns=@PrimaryKeyJoinColumn(name="EMPL_ID")),
 *        @SecondaryTable(name="EMP_HIST",
 *            pkJoinColumns=@PrimaryKeyJoinColumn(name="EMPLOYEE_ID"))
 *    })
 *    public class Employee { ... }
 * 
 *
 * @since Java Persistence 1.0
 */
@Target(TYPE)
@Retention(RUNTIME)

public @interface SecondaryTables {
	/**
	 * (Required) The secondary tables for an entity.
	 */
	SecondaryTable[] value();
}