javax.persistence.SecondaryTables Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.persistence Show documentation

javax.persistence build based upon git transaction cfcdce1

There is a newer version: 2.2.1

/*******************************************************************************
 * Copyright (c) 2008 - 2013 Oracle Corporation. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Linda DeMichiel - Java Persistence 2.1
 *     Linda DeMichiel - Java Persistence 2.0
 *
 ******************************************************************************/ 
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();
}