JoinTable (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 JoinTable

@Target(value={METHOD,FIELD}) @Retention(value=RUNTIME) public @interface JoinTable

This annotation is used in the mapping of associations. It is specified on the owning side of a many-to-many association, or in a unidirectional one-to-many association.

If the JoinTable annotation is missing, the default values of the annotation elements apply. The name of the join table is assumed to be the table names of the associated primary tables concatenated together (owning side first) using an underscore.


    Example:
    @JoinTable(
    name="CUST_PHONE",
    joinColumns=
        @JoinColumn(name="CUST_ID", referencedColumnName="ID"),
    inverseJoinColumns=
        @JoinColumn(name="PHONE_ID", referencedColumnName="ID")
    )

Since:: Java Persistence 1.0

Optional Element Summary

String catalog
          (Optional) The catalog of the table.

JoinColumn[] inverseJoinColumns
          (Optional) The foreign key columns of the join table which reference the primary table of the entity that does not own the association (i.e. the inverse side of the association).

JoinColumn[] joinColumns
          (Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association (i.e. the owning side of the association).

String name
          (Optional) The name of the join 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.
`JoinColumn[]`	`inverseJoinColumns` (Optional) The foreign key columns of the join table which reference the primary table of the entity that does not own the association (i.e. the inverse side of the association).
`JoinColumn[]`	`joinColumns` (Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association (i.e. the owning side of the association).
`String`	`name` (Optional) The name of the join 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 join table.

Defaults to the concatenated names of the two associated primary entity tables, separated by an underscore.

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:: ""

joinColumns

public abstract JoinColumn[] joinColumns

(Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association (i.e. the owning side of the association).

Uses the same defaults as for JoinColumn.

Default:: {}

inverseJoinColumns

public abstract JoinColumn[] inverseJoinColumns

(Optional) The foreign key columns of the join table which reference the primary table of the entity that does not own the association (i.e. the inverse side of the association).