javax.persistence

Annotation Type JoinTable

Contents

  • @Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface JoinTable
    Specifies the mapping of associations. It is applied to 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:
    Java Persistence 1.0
    See Also:
    JoinColumn, JoinColumns

    • Element Detail

      • 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).

        Uses the same defaults as for JoinColumn.

        Default:
        {}

      • foreignKey

        public abstract ForeignKey foreignKey
        (Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the joinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the joinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.
        Since:
        Java Persistence 2.1
        Default:
        @javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_DEFAULT)

      • inverseForeignKey

        public abstract ForeignKey inverseForeignKey
        (Optional) Used to specify or control the generation of a foreign key constraint for the columns corresponding to the inverseJoinColumns element when table generation is in effect. If both this element and the foreignKey element of any of the inverseJoinColumns elements are specified, the behavior is undefined. If no foreign key annotation element is specified in either location, the persistence provider's default foreign key strategy will apply.
        Since:
        Java Persistence 2.1
        Default:
        @javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_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.

        Defaults to no additional constraints.

        Default:
        {}

      • indexes

        public abstract Index[] indexes
        (Optional) Indexes for the table. These are only used if table generation is in effect.
        Since:
        Java Persistence 2.1
        Default:
        {}

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/JoinTable.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, JoinTable (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.