MapKeyColumn (javax.persistence-api 2.2 API)

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

マップキーが基本形であるマップキーのカラムのマッピングを指定します。 name要素が指定されていない場合、デフォルトでは次のものが連結されます。：参照元のリレーションシップのフィールドまたはプロパティの名前 + "_" + "キー"

    Example:

    @Entity
    public class Item {
       @Id int id;
       ...
       @ElementCollection
       @MapKeyColumn(name="IMAGE_NAME")
       @Column(name="IMAGE_FILENAME")
       @CollectionTable(name="IMAGE_MAPPING")
       Map<String, String> images;  // map from image name to filename
       ...
    }

導入されたバージョン:: Java Persistence 2.0

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`java.lang.String`	`columnDefinition` (オプション) カラムのDDLを生成するときに使用されるSQLフラグメント。
`boolean`	`insertable` (オプション) 永続化プロバイダによって生成されたSQL INSERTステートメントにカラムが含まれるかどうか。
`int`	`length` (オプション) カラムの長さ。
`java.lang.String`	`name` (オプション) マップキーのカラムの名前。
`boolean`	`nullable` (オプション) データベースのカラムがNULLを許容するかどうか。
`int`	`precision` (オプション) 10進数(正確な数値)のカラムの精度。
`int`	`scale` (オプション) 10進数(正確な数値)のカラムの位取り。
`java.lang.String`	`table` (オプション) このカラムが含まれるテーブルの名前。
`boolean`	`unique` (オプション) このプロパティがユニークキーかどうか。
`boolean`	`updatable` (オプション) 永続化プロバイダによって生成されたSQL UPDATEステートメントにカラムが含まれるかどうか。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
    (オプション) マップキーのカラムの名前。どのテーブルで見つけるかはコンテキストに依存します。要素コレクションのためのマップキーの場合、マップキーのカラムはマップの値のコレクションテーブルに存在します。 ManyToManyのエンティティのリレーションシップや結合テーブルを使用したOneToManyのエンティティのリレーションシップのためのマップキーの場合、マップキーのカラムは結合テーブルに存在します。外部キーマッピング戦略を使用したOneToManyのエンティティのリレーションシップのためのマップキーの場合、マップキーのカラムは値がマッピングされたテーブルに存在します。
    デフォルトでは次のものが連結されます。：参照元のリレーションシップのフィールドまたはプロパティの名前 + "_" + "キー"
    
    デフォルト:
    
    ""
- - 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
```
    (オプション) このカラムが含まれるテーブルの名前。
    デフォルト：マップキーが要素コレクションの場合はマップ値のコレクションテーブルの名前。結合テーブルを使用してマップキーがOneToManyまたはManyToManyエンティティのリレーションシップにある場合はマップの結合テーブルの名前。外部キーマッピング戦略を使用してマップキーがOneToManyエンティティのリレーションシップ用である場合はマップの値のエンティティのプライマリテーブルの名前。
    
    デフォルト:
    
    ""
- - length
```
public abstract int length
```
    (オプション) カラムの長さ。(文字列値のカラムが使用されている場合のみ適用されます。)
    
    デフォルト:
    
    255
- - precision
```
public abstract int precision
```
    (オプション) 10進数(正確な数値)のカラムの精度。 (10進数のカラムが使用されている場合にのみ適用されます。)
    デフォルト: 0。 (値は開発者によって設定される必要があります。)
    
    デフォルト:
    
    0
- - scale
```
public abstract int scale
```
    (オプション) 10進数(正確な数値)のカラムの位取り。 (10進数のカラムが使用されている場合にのみ適用されます。)
    
    デフォルト:
    
    0

注釈型 MapKeyColumn

任意要素のサマリー

要素の詳細

name

unique

nullable

insertable

updatable

columnDefinition

table

length

precision

scale