64 lines
1.9 KiB
Java
64 lines
1.9 KiB
Java
/*******************************************************************************
|
|
* 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 the primary table for the annotated entity. Additional
|
|
* tables may be specified using SecondaryTable or SecondaryTables annotation.
|
|
*
|
|
* <p> If no <code>Table</code> annotation is specified for an entity
|
|
* class, the default values apply.
|
|
*
|
|
* <pre>
|
|
* Example:
|
|
*
|
|
* @Entity
|
|
* @Table(name="CUST", schema="RECORDS")
|
|
* public class Customer { ... }
|
|
* </pre>
|
|
*
|
|
* @since Java Persistence 1.0
|
|
*/
|
|
@Target(TYPE)
|
|
@Retention(RUNTIME)
|
|
public @interface Table {
|
|
|
|
/**
|
|
* (Optional) The name of the table.
|
|
* <p> Defaults to the entity name.
|
|
* @return String
|
|
*/
|
|
String name() default "";
|
|
|
|
/** (Optional) The catalog of the table.
|
|
* <p> Defaults to the default catalog.
|
|
* @return String
|
|
*/
|
|
String catalog() default "";
|
|
|
|
/** (Optional) The schema of the table.
|
|
* <p> Defaults to the default schema for user.
|
|
* @return String
|
|
*/
|
|
String schema() default "";
|
|
|
|
}
|