PrimaryKeyJoinColumn (javax.persistence-api 2.2 API)

```
@Repeatable(value=PrimaryKeyJoinColumns.class)
 @Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface PrimaryKeyJoinColumn
```
他のテーブルに結合するための外部キーとして使用される主キーのカラムを指定します。
これはJOINEDマッピングストラテジーのエンティティのサブクラスのプライマリテーブルを、そのスーパークラスのプライマリテーブルに結合するために使用されます。もしくはセカンダリテーブルをプライマリテーブルに結合するためにSecondaryTableアノテーション内で使用されます。もしくは参照元エンティティの主キーが参照先エンティティへの外部キーとして使用されるOneToOneマッピングで使用できます。
JOINEDマッピングストラテジーのエンティティのサブクラスにPrimaryKeyJoinColumnアノテーションが指定されていない場合、サブクラスの外部キー列はスーパークラスのプライマリテーブルの主キー列と同じ名前を持つとみなされます。
```
    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 { ... }
 
```
導入されたバージョン:

Java Persistence 1.0

関連項目:

SecondaryTable, Inheritance, OneToOne, ForeignKey

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`java.lang.String`	`columnDefinition` (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。
`ForeignKey`	`foreignKey` (オプション) テーブルの生成が有効な場合に主キー結合カラムの外部キー制約の生成を指定または制御するために使用されます。
`java.lang.String`	`name` (オプション) 現在のテーブルの主キー列の名前。
`java.lang.String`	`referencedColumnName` (オプション) 結合先のテーブルの主キー列の名前。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
    (オプション) 現在のテーブルの主キー列の名前。
    デフォルトでは(JOINEDマッピングストラテジーの場合は)スーパークラスのプライマリテーブルの主キー列と同じ名前になります。または(SecondaryTableマッピングの場合は)プライマリテーブルの主キー列と同じ名前になります。または(OneToOneマッピングの場合は)参照元エンティティのテーブルの主キー列と同じ名前になります。
    
    デフォルト:
    
    ""
- - referencedColumnName
```
public abstract java.lang.String referencedColumnName
```
    (オプション) 結合先のテーブルの主キー列の名前。
    デフォルトでは(JOINEDマッピングストラテジーの場合は)スーパークラスのプライマリテーブルの主キー列と同じ名前になります。または(SecondaryTableマッピングの場合は)プライマリテーブルの主キー列と同じ名前になります。または(OneToOneマッピングの場合は)参照元エンティティのテーブルの主キー列と同じ名前になります。
    
    デフォルト:
    
    ""
- - columnDefinition
```
public abstract java.lang.String columnDefinition
```
    (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。これはOneToOneの主キーの関連付けでは使用しないでください。
    デフォルトではカラムを推測された型で作成するために生成されたSQLです。
    
    デフォルト:
    
    ""
- - foreignKey
```
public abstract ForeignKey foreignKey
```
    (オプション) テーブルの生成が有効な場合に主キー結合カラムの外部キー制約の生成を指定または制御するために使用されます。この要素が指定されていない場合は永続化プロバイダのデフォルトの外部キー方式が適用されます。
    
    導入されたバージョン:
    
    Java Persistence 2.1
    
    デフォルト:
    
    @javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_DEFAULT)

注釈型 PrimaryKeyJoinColumn

任意要素のサマリー

要素の詳細

name

referencedColumnName

columnDefinition

foreignKey