javax.persistence

Annotation Type PrimaryKeyJoinColumn

Contents

  • @Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface PrimaryKeyJoinColumn
    Specifies a primary key column that is used as a foreign key to join to another table.

    It is used to join the primary table of an entity subclass in the JOINED mapping strategy to the primary table of its superclass; it is used within a SecondaryTable annotation to join a secondary table to a primary table; and it may be used in a OneToOne mapping in which the primary key of the referencing entity is used as a foreign key to the referenced entity.

    If no PrimaryKeyJoinColumn annotation is specified for a subclass in the JOINED mapping strategy, the foreign key columns are assumed to have the same names as the primary key columns of the primary table of the superclass. 

    
    Example: Customer and ValuedCustomer subclass

    @Entity
    @Table(name="CUST")
    @Inheritance(strategy=JOINED)
    @DiscriminatorValue("CUST")
    public class Customer { ... }
    
    @Entity
    @Table(name="VCUST")
    @DiscriminatorValue("VCUST")
    @PrimaryKeyJoinColumn(name="CUST_ID")
    public class ValuedCustomer extends Customer { ... }
    Since:
    Java Persistence 1.0
    See Also:
    SecondaryTable, Inheritance, OneToOne, ForeignKey

    • Element Detail

      • name

        public abstract String name
        (Optional) The name of the primary key column of the current table.

        Defaults to the same name as the primary key column of the primary table of the superclass (JOINED mapping strategy); the same name as the primary key column of the primary table (SecondaryTable mapping); or the same name as the primary key column for the table for the referencing entity (OneToOne mapping).

        Default:
        ""

      • referencedColumnName

        public abstract String referencedColumnName
        (Optional) The name of the primary key column of the table being joined to.

        Defaults to the same name as the primary key column of the primary table of the superclass (JOINED mapping strategy); the same name as the primary key column of the primary table (SecondaryTable mapping); or the same name as the primary key column for the table for the referencing entity (OneToOne mapping).

        Default:
        ""

      • columnDefinition

        public abstract String columnDefinition
        (Optional) The SQL fragment that is used when generating the DDL for the column. This should not be specified for a OneToOne primary key association.

        Defaults to the generated SQL to create a column of the inferred type.

        Default:
        ""

      • foreignKey

        public abstract ForeignKey foreignKey
        (Optional) Used to specify or control the generation of a foreign key constraint for the primary key join column when table generation is in effect. If this element is not specified, the persistence provider's default foreign key strategy will apply.
        Since:
        Java Persistence 2.1
        Default:
        @javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_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/PrimaryKeyJoinColumn.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, PrimaryKeyJoinColumn (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.