/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. 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.
 */
package javax.persistence;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Specifies a secondary table for the annotated entity
class. Specifying one or more secondary tables indicates that the
data for the entity class is stored across multiple tables.

 If no SecondaryTable annotation is specified,
it is assumed that all persistent fields or properties of the
entity are mapped to the primary table. If no primary key join
columns are specified, the join columns are assumed to reference
the primary key columns of the primary table, and have the same
names and types as the referenced primary key columns of the
primary table.

   Example 1: Single secondary table with a single primary key column.
   @Entity
   @Table(name="CUSTOMER")
   @SecondaryTable(name="CUST_DETAIL",
       pkJoinColumns=@PrimaryKeyJoinColumn(name="CUST_ID"))
   public class Customer { ... }
   Example 2: Single secondary table with multiple primary key columns.
   @Entity
   @Table(name="CUSTOMER")
   @SecondaryTable(name="CUST_DETAIL",
       pkJoinColumns={
           @PrimaryKeyJoinColumn(name="CUST_ID"),
           @PrimaryKeyJoinColumn(name="CUST_TYPE")})
   public class Customer { ... }

Since:
Java Persistence 1.0/**
 * Specifies a secondary table for the annotated entity
 * class. Specifying one or more secondary tables indicates that the
 * data for the entity class is stored across multiple tables.
 * <p>
 * <p> If no <code>SecondaryTable</code> annotation is specified,
 * it is assumed that all persistent fields or properties of the
 * entity are mapped to the primary table. If no primary key join
 * columns are specified, the join columns are assumed to reference
 * the primary key columns of the primary table, and have the same
 * names and types as the referenced primary key columns of the
 * primary table.
 * <p>
 * <pre>
 *    Example 1: Single secondary table with a single primary key column.
 *
 *    &#064;Entity
 *    &#064;Table(name="CUSTOMER")
 *    &#064;SecondaryTable(name="CUST_DETAIL",
 *        pkJoinColumns=&#064;PrimaryKeyJoinColumn(name="CUST_ID"))
 *    public class Customer { ... }
 *
 *
 *    Example 2: Single secondary table with multiple primary key columns.
 *
 *    &#064;Entity
 *    &#064;Table(name="CUSTOMER")
 *    &#064;SecondaryTable(name="CUST_DETAIL",
 *        pkJoinColumns={
 *            &#064;PrimaryKeyJoinColumn(name="CUST_ID"),
 *            &#064;PrimaryKeyJoinColumn(name="CUST_TYPE")})
 *    public class Customer { ... }
 * </pre>
 *
 * @since Java Persistence 1.0
 */
@Target(TYPE)
@Retention(RUNTIME)
@Repeatable(SecondaryTables.class)
public @interface SecondaryTable {
  
(Required) The name of the table.
Returns:
name/**
   * (Required) The name of the table.
   *
   * @return name
   */
  String name();

  
(Optional) The catalog of the table.

Defaults to the default catalog.
Returns:
catalog/**
   * (Optional) The catalog of the table.
   * <p>
   * Defaults to the default catalog.
   *
   * @return catalog
   */
  String catalog() default "";

  
(Optional) The schema of the table.

Defaults to the default schema for user.
Returns:
schema/**
   * (Optional) The schema of the table.
   * <p>
   * Defaults to the default schema for user.
   *
   * @return schema
   */
  String schema() default "";

  
(Optional) The columns that are used to join with the primary table.

Defaults to the column(s) of the same name(s) as the primary key column(s) in the primary table.
Returns:
pk join cols/**
   * (Optional) The columns that are used to join with the primary table.
   * <p>
   * Defaults to the column(s) of the same name(s) as the primary key column(s) in the primary table.
   *
   * @return pk join cols
   */
  PrimaryKeyJoinColumn[] pkJoinColumns() default {};

  
(Optional) Unique constraints that are to be placed on the table. These are typically only used if
table generation is in effect. These constraints apply in addition to any constraints specified by the
Column and JoinColumn annotations and constraints entailed by primary key
mappings.

Defaults to no additional constraints.
Returns:
unique constraints/**
   * (Optional) Unique constraints that are to be placed on the table. These are typically only used if
   * table generation is in effect. These constraints apply in addition to any constraints specified by the
   * <code>Column</code> and <code>JoinColumn</code> annotations and constraints entailed by primary key
   * mappings.
   * <p>
   * Defaults to no additional constraints.
   *
   * @return unique constraints
   */
  UniqueConstraint[] uniqueConstraints() default {};

  
(Optional) Indexes for the table. These are only used if table generation is in effect.
Returns:
The indexes/**
   * (Optional) Indexes for the table. These are only used if table generation is in effect.
   *
   * @return The indexes
   */
  Index[] indexes() default {};

  
(Optional) Used to specify or control the generation of a foreign key constraint for the columns
corresponding to the pkJoinColumns element when table generation is in effect.
Returns:
fk
Since:
Java Persistence 2.1/**
   * (Optional) Used to specify or control the generation of a foreign key constraint for the columns
   * corresponding to the pkJoinColumns element when table generation is in effect.
   *
   * @return fk
   * @since Java Persistence 2.1
   */
  ForeignKey foreignKey() default @ForeignKey(ConstraintMode.PROVIDER_DEFAULT);
}