Table (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: REQUIRED | OPTIONAL

DETAIL: ELEMENT

javax.persistence
Annotation Type Table

@Target(value=TYPE) @Retention(value=RUNTIME) public @interface Table

This annotation specifies the primary table for the annotated entity. Additional tables may be specified using SecondaryTable or SecondaryTables annotation.

If no Table annotation is specified for an entity class, the default values apply.

    Example:

    @Entity
    @Table(name="CUST", schema="RECORDS")
    public class Customer { ... }

Since:: Java Persistence 1.0

Optional Element Summary

String catalog
          (Optional) The catalog of the table.

String name
          (Optional) The name of the table.

String schema
          (Optional) The schema of the table.

UniqueConstraint[] uniqueConstraints
          (Optional) Unique constraints that are to be placed on the table.

Optional Element Summary
`String`	`catalog` (Optional) The catalog of the table.
`String`	`name` (Optional) The name of the table.
`String`	`schema` (Optional) The schema of the table.
`UniqueConstraint[]`	`uniqueConstraints` (Optional) Unique constraints that are to be placed on the table.

name

public abstract String name

(Optional) The name of the table.

Defaults to the entity name.

Default:: ""

catalog

public abstract String catalog

(Optional) The catalog of the table.

Defaults to the default catalog.

Default:: ""

schema

public abstract String schema

(Optional) The schema of the table.

Defaults to the default schema for user.

Default:: ""

uniqueConstraints

public abstract UniqueConstraint[] uniqueConstraints

(Optional) Unique constraints that are to be placed on the table. These are 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.

Default:: {}