-
@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 aSecondaryTable
annotation to join a secondary table to a primary table; and it may be used in aOneToOne
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 theJOINED
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
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description String
columnDefinition
(Optional) The SQL fragment that is used when generating the DDL for the column.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.String
name
(Optional) The name of the primary key column of the current table.String
referencedColumnName
(Optional) The name of the primary key column of the table being joined to.
-
-
-
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 aOneToOne
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)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 18:30:54 Cette version de la page est en cache (à la date du 21/08/2025 18:30:54) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 19/04/2008, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/persistence/PrimaryKeyJoinColumn.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.