JoinColumn (javax.persistence-api 2.2 API)

@Repeatable(value=JoinColumns.class)
 @Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface JoinColumn

エンティティの関連や要素コレクションを結合するカラムを指定します。 JoinColumnアノテーション自身がデフォルトの場合、単一の結合カラムが想定され、デフォルト値が適用されます。

   Example:

   @ManyToOne
   @JoinColumn(name="ADDR_ID")
   public Address getAddress() { return address; }


   Example: 外部キーマッピングを使用した単方向の1対多の関連
 
   // In Customer class
   @OneToMany
   @JoinColumn(name="CUST_ID") // join column is in table for Order
   public Set<Order> getOrders() {return orders;}

導入されたバージョン:: Java Persistence 1.0
関連項目:: ManyToOne, OneToMany, OneToOne, JoinTable, CollectionTable, ForeignKey

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`java.lang.String`	`columnDefinition` (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。
`ForeignKey`	`foreignKey` (オプション) テーブルの生成が有効なときに外部キー制約の生成を指定または制御するために使用されます。
`boolean`	`insertable` (オプション) 永続化プロバイダによって生成されたSQL INSERTステートメントにカラムが含まれるかどうか。
`java.lang.String`	`name` (オプション) 外部キーのカラムの名前。
`boolean`	`nullable` (オプション) 外部キーのカラムがNULLを許容するかどうか。
`java.lang.String`	`referencedColumnName` (オプション) この外部キーのカラムから参照されるカラムの名前。
`java.lang.String`	`table` (オプション) このカラムを含めるテーブルの名前。
`boolean`	`unique` (オプション) このプロパティがユニークキーかどうか。
`boolean`	`updatable` (オプション) 永続化プロバイダによって生成されたSQL UPDATEステートメントにカラムが含まれるかどうか。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
    (オプション) 外部キーのカラムの名前。見つかるテーブルはコンテキストに依存します。
    - 結合が外部キーマッピング戦略を使用するOneToOneまたはManyToOneマッピングの場合、外部キーのカラムはソースエンティティまたは組み込みクラスのテーブルにあります。
    - 結合が外部キーマッピング方式を使用する単方向OneToManyマッピングの場合、外部キーはターゲットエンティティのテーブルにあります。
    - 結合がManyToManyマッピング、または結合テーブルを使用するOneToOneまたは双方向ManyToOne、OneToManyマッピングの場合、外部キーは結合テーブルにあります。
    - 結合が要素コレクションの場合、外部キーはコレクションテーブルにあります。
    デフォルト(単一の結合カラムが使用された場合のみ適用される): 参照のリレーションシップのプロパティの名前または参照元のエンティティまたは埋め込み可能クラスのフィールド + "_" + 参照される主キーのカラムの名前
    エンティティにそのような参照のリレーションシップのプロパティまたはフィールドがない場合、もしくは要素コレクションの結合である場合、結合カラム名は次のようになります。エンティティの名前 + "_" + 参照される主キーのカラムの名前
    デフォルト:
    
    ""
- - referencedColumnName
```
public abstract java.lang.String referencedColumnName
```
    (オプション) この外部キーのカラムから参照されるカラムの名前。
    - ここで説明するケース以外のエンティティのリレーションシップのマッピングで使用する場合、参照先のカラムはターゲットエンティティのテーブルにあります。
    - 単方向のOneToMany外部キーマッピングとともに使用する場合、参照されるカラムはソースエンティティのテーブル内にあります。
    - JoinTableアノテーション内で使用される場合、参照されるキーのカラムは所有側のエンティティのテーブルにあり、逆側の結合の定義の一部である場合は逆側のエンティティのテーブルにあります。
    - CollectionTableマッピングで使用される場合、参照されるカラムはコレクションを含むエンティティのテーブルにあります。
    デフォルト (単一の結合カラムが使用された場合のみ適用される): 参照先のテーブルの主キーのカラムと同じ名前。
    デフォルト:
    
    ""
- - unique
```
public abstract boolean unique
```
    (オプション) このプロパティがユニークキーかどうか。これはテーブルレベルのUniqueConstraintアノテーションのショートカットであり、ユニークキー制約が単一のフィールドだけである場合に便利です。外部キーの一部である主キーに対応する結合カラムに対して明示的に指定する必要はありません。
    
    デフォルト:
    
    false
- - nullable
```
public abstract boolean nullable
```
    (オプション) 外部キーのカラムがNULLを許容するかどうか。
    
    デフォルト:
    
    true
- - insertable
```
public abstract boolean insertable
```
    (オプション) 永続化プロバイダによって生成されたSQL INSERTステートメントにカラムが含まれるかどうか。
    
    デフォルト:
    
    true
- - updatable
```
public abstract boolean updatable
```
    (オプション) 永続化プロバイダによって生成されたSQL UPDATEステートメントにカラムが含まれるかどうか。
    
    デフォルト:
    
    true
- - columnDefinition
```
public abstract java.lang.String columnDefinition
```
    (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。デフォルトでは型推論されたカラムを作成するSQLを生成します。
    
    デフォルト:
    
    ""
- - table
```
public abstract java.lang.String table
```
    (オプション) このカラムを含めるテーブルの名前。テーブルが指定されない場合、カラムは該当するエンティティのプライマリーテーブルにあるとみなされます。
    デフォルト:
    - 結合が外部キーマッピング戦略を使用するOneToOneまたはManyToOneマッピングの場合、ソースエンティティまたは組み込みクラスのテーブルの名前。
    - 結合が外部キーマッピング方式を使用する単方向OneToManyマッピングの場合、ターゲットエンティティのテーブルの名前。
    - 結合がmanyToManyマッピングの場合や結合テーブルを使用するOneToOneまたは双方向のManyToOneやOneToManyマッピングの場合、結合テーブルの名前。
    - 結合が要素コレクションの場合、コレクションテーブルの名前。
    デフォルト:
    
    ""
- - foreignKey
```
public abstract ForeignKey foreignKey
```
    (オプション) テーブルの生成が有効なときに外部キー制約の生成を指定または制御するために使用されます。この要素が指定されていない場合、永続化プロバイダのデフォルトの外部キー方式が適用されます。
    
    導入されたバージョン:
    
    Java Persistence 2.1
    
    デフォルト:
    
    @javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_DEFAULT)

注釈型 JoinColumn

任意要素のサマリー

要素の詳細

name

referencedColumnName

unique

nullable

insertable

updatable

columnDefinition

table

foreignKey