FileDocCategorySizeDatePackage
PrimaryKeyJoinColumn.javaAPI DocGlassfish v2 API5132Fri May 04 22:34:08 BST 2007javax.persistence

PrimaryKeyJoinColumn

public class PrimaryKeyJoinColumn
This annotation 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 {@link InheritanceType#JOINED JOINED} mapping strategy to the primary table of its superclass; it is used within a {@link SecondaryTable} annotation to join a secondary table to a primary table; and it may be used in a {@link 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 {@link InheritanceType#JOINED 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

Fields Summary
Constructors Summary
Methods Summary
java.lang.StringcolumnDefinition()
(Optional) The SQL fragment that is used when generating the DDL for the column. This should not be specified for a {@link OneToOne} primary key association.

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

java.lang.Stringname()
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 ({@link InheritanceType#JOINED JOINED} mapping strategy); the same name as the primary key column of the primary table ({@link SecondaryTable} mapping); or the same name as the primary key column for the table for the referencing entity ({@link OneToOne} mapping)

java.lang.StringreferencedColumnName()
(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 ({@link InheritanceType#JOINED JOINED} mapping strategy); the same name as the primary key column of the primary table ({@link SecondaryTable} mapping); or the same name as the primary key column for the table for the referencing entity ({@link OneToOne} mapping)