Note: This ORM/SQL annotation is silently ignored by ObjectDB

432 words

javax.persistence.JoinTable - JPA annotation

javax.persistence
Annotation JoinTable

Target:
Fields (including property get methods)
Used in the mapping of associations. It is specified on the owning side of an association.

A join table is typically used in the mapping of many-to-many and unidirectional one-to-many associations. It may also be used to map bidirectional many-to-one/one-to-many associations, unidirectional many-to-one relationships, and one-to-one associations (both bidirectional and unidirectional).

When a join table is used in mapping a relationship with an embeddable class on the owning side of the relationship, the containing entity rather than the embeddable class is considered the owner of the relationship.

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:
JPA 1.0
See Also:
JoinColumn
JoinColumns
String catalog
(Optional) The catalog of the table.
(Optional) The catalog of the table.

Defaults to the default catalog.

Default value:
""
Since:
JPA 1.0
(Optional) The foreign key columns of the join table which reference the primary table of the entity that does not own the association.
(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).

Uses the same defaults as for JoinColumn.

Default value:
{}
Since:
JPA 1.0
(Optional) The foreign key columns of the join table which reference the primary table of the entity owning the association.
(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 value:
{}
Since:
JPA 1.0
String name
(Optional) The name of the join table.
(Optional) The name of the join table.

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

Default value:
""
Since:
JPA 1.0
String schema
(Optional) The schema of the table.
(Optional) The schema of the table.

Defaults to the default schema for user.

Default value:
""
Since:
JPA 1.0
(Optional) Unique constraints that are to be placed on the table.
(Optional) Unique constraints that are to be placed on the table. These are only used if table generation is in effect.

Defaults to no additional constraints.

Default value:
{}
Since:
JPA 1.0

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.