MapKeyJoinColumn (javax.persistence-api 2.2 API)

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

マップキーのエンティティのマッピングを指定します。マップキー結合カラムはマップで表される結合が使用されるターゲットエンティティのコレクションテーブルや、結合テーブル、テーブル内にあります。 MapKeyJoinColumnが指定されていない場合は単一の結合カラムが使用され、デフォルト値が適用されます。


    Example 1:

    @Entity
    public class Company {
       @Id int id;
       ...
       @OneToMany   // 単方向
       @JoinTable(name="COMPANY_ORGANIZATION",
                  joinColumns=@JoinColumn(name="COMPANY"),
                  inverseJoinColumns=@JoinColumn(name="VICEPRESIDENT"))
       @MapKeyJoinColumn(name="DIVISION")
       Map<Division, VicePresident> organization;
    }

    Example 2:

    @Entity
    public class VideoStore {
       @Id int id;
       String name;
       Address location;
       ...
       @ElementCollection
       @CollectionTable(name="INVENTORY",
                        joinColumns=@JoinColumn(name="STORE"))
       @Column(name="COPIES_IN_STOCK")
       @MapKeyJoinColumn(name="MOVIE", referencedColumnName="ID")
       Map<Movie, Integer> videoInventory;
       ...
     }

     @Entity
     public class Movie {
        @Id long id;
        String title;
        ...
     }

     Example 3:

     @Entity
     public class Student {
        @Id int studentId;
        ...
        @ManyToMany  // studentsとcoursesはそれぞれmany-many
        @JoinTable(name="ENROLLMENTS",
                   joinColumns=@JoinColumn(name="STUDENT"),
                   inverseJoinColumns=@JoinColumn(name="SEMESTER"))
        @MapKeyJoinColumn(name="COURSE")
        Map<Course, Semester>  enrollment;
        ...
     }

導入されたバージョン:: Java Persistence 2.0
関連項目:: 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
```
    (オプション) マップキーのための外部キーのカラムの名前。どのテーブルで見つけるかはコンテキストに依存します。
    - 要素コレクションのためのマップキーによる結合の場合、外部キーのカラムはマップの値のコレクションテーブルに存在します。
    - ManyToManyのエンティティのリレーションシップや結合テーブルを使用したOneToManyのエンティティのリレーションシップの結合の場合、外部キーのカラムは結合テーブルに存在します。
    - 外部キーマッピング戦略を使用したOneToManyのエンティティのリレーションシップの結合の場合、マップキーのための外部キーのカラムは(Mapの)値がマッピングされたテーブルに存在します。
    (単一の結合カラムが使用された場合のみ適用される)デフォルトのカラム名は次のものを連結します。：参照するエンティティや組み込みクラスの参照するリレーションシップのプロパティやフィールド + "_" + "KEY"
    デフォルト:
    
    ""
- - referencedColumnName
```
public abstract java.lang.String referencedColumnName
```
    (オプション) この外部キーのカラムによって参照されるカラムの名前。参照先のカラムは、ターゲットエンティティのテーブルにあります。 (単一の結合カラムが使用された場合のみ適用される)デフォルトは参照先テーブルの主キーのカラムと同じ名前です。
    
    デフォルト:
    
    ""
- - unique
```
public abstract boolean unique
```
    (オプション) このプロパティがユニークキーかどうか。これはテーブルレベルのUniqueConstraintアノテーションのショートカットであり、ユニークキー制約が単一のフィールドだけである場合に便利です。
    
    デフォルト:
    
    false
- - nullable
```
public abstract boolean nullable
```
    (オプション) 外部キーのカラムにnullを入れられるかどうか。
    
    デフォルト:
    
    false
- - 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
```
    (オプション) 外部キーのカラムが含まれるテーブルの名前。
    - 要素コレクションのためのマップキーによる結合の場合、外部キーのカラムはマップの値のコレクションテーブルに存在します。
    - ManyToManyのエンティティのリレーションシップや結合テーブルを使用したOneToManyのエンティティのリレーションシップの結合の場合、外部キーのカラムは結合テーブルに存在します。
    - 外部キーマッピング戦略を使用したOneToManyのエンティティのリレーションシップの結合の場合、マップキーのための外部キーのカラムは(Mapの)値がマッピングされたテーブルに存在します。
    デフォルト:
    - 要素コレクションのためのマップの場合、マップの値のためのコレクションテーブルの名前。
    - マップが結合テーブルが使用されるOneToManyやManyToManyのエンティティのリレーションシップの場合、マップのための結合テーブルの名前。
    - 外部キーマッピング戦略を使用したOneToManyのエンティティのリレーションシップのマップの場合、マップの値のエンティティのプライマリーテーブルの名前。
    デフォルト:
    
    ""
- - foreignKey
```
public abstract ForeignKey foreignKey
```
    (オプション) テーブルの生成が有効な場合に主キー結合カラムの外部キー制約の生成を指定または制御するために使用されます。この要素が指定されていない場合は永続化プロバイダのデフォルトの外部キー方式が適用されます。
    
    導入されたバージョン:
    
    Java Persistence 2.1
    
    デフォルト:
    
    @javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_DEFAULT)

注釈型 MapKeyJoinColumn

任意要素のサマリー

要素の詳細

name

referencedColumnName

unique

nullable

insertable

updatable

columnDefinition

table

foreignKey