javax.persistence
Annotation Type PrimaryKeyJoinColumn


@Target(value={TYPE,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface PrimaryKeyJoinColumn

The PrimaryKeyJoinColumn annotation specifies a primary key column that is used as a foreign key to join to another table.
The PrimaryKeyJoinColumn annotation 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.

Since:
EJB 3.0 version.
Author:
Florent Benoit
See Also:
EJB 3.0 specification

Optional Element Summary
 java.lang.String columnDefinition
          (Optional) The SQL fragment that is used when generating the DDL for the column.
 java.lang.String name
          The name of the primary key column of the current table.
 java.lang.String referencedColumnName
          (Optional) The name of the primary key column of the table being joined to.
 

name

public abstract java.lang.String name
The name of the primary key column of the current table.

Default:
""

referencedColumnName

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

Default:
""

columnDefinition

public abstract java.lang.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.

Default:
""