javax.persistence

注釈型 CollectionTable

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

基本型もしくは組み込み型のコレクションのマッピングに使用されるテーブルを指定します。 値がコレクションのフィールドもしくはプロパティに適用します。

デフォルトでは組み込みクラスまたは基本型に対応するコレクションテーブルのカラムは組み込みクラスの属性またはColumnアノテーションのデフォルト値に従って基本型から派生します。 基本型の場合はカラム名は値がコレクションのフィールドまたはプロパティの名前から派生します。 組み込みクラスの場合はカラム名は組み込みクラスのフィールドまたはプロパティ名から派生します。

• 基本型に使用されるカラムでデフォルトの設定を上書きするためには値がコレクションの属性でElementCollectionアノテーションに加えてColumnアノテーションを使用します。
• 組み込みクラスのデフォルト値を上書きするためにはElementCollectionアノテーションに加えてAttributeOverrideやAttributeOverridesアノテーションを使用することができます。 組み込みクラスにほかのエンティティへの参照が含まれている場合、それらの参照に関連するカラムのデフォルト値はAssociationOverrideやAssociationOverridesを使用することで上書きすることができます。

CollectionTableアノテーションがない場合はCollectionTableアノテーションの要素のデフォルト値が適用されます。

    Example:

    @Embeddable public class Address {
       protected String street;
       protected String city;
       protected String state;
       ... 
     }

    @Entity public class Person {
       @Id protected String ssn;
       protected String name;
       protected Address home;
       ...
       @ElementCollection  // デフォルトのテーブルを使用 (PERSON_NICKNAMES)
       @Column(name="name", length=50)
       protected Set<String> nickNames = new HashSet();
       ...
    }

    @Entity public class WealthyPerson extends Person {
       @ElementCollection
       @CollectionTable(name="HOMES") // デフォルトの結合カラム名を使用
       @AttributeOverrides({
          @AttributeOverride(name="street", 
                             column=@Column(name="HOME_STREET")),
          @AttributeOverride(name="city", 
                             column=@Column(name="HOME_CITY")),
          @AttributeOverride(name="state", 
                             column=@Column(name="HOME_STATE"))
        })
       protected Set<Address> vacationHomes = new HashSet();
       ...
    }
 

導入されたバージョン:

Java Persistence 2.0

関連項目:

ElementCollection, AttributeOverride, AssociationOverride, Column

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
java.lang.String	catalog (オプション) テーブルのカタログ。
ForeignKey	foreignKey (オプション) テーブルの生成が有効な場合にjoinColumns要素に関係するカラムのための外部キー制約の生成を指定または制御するために使用されます。
Index[]	indexes (オプション) テーブルのためのインデックス。
JoinColumn[]	joinColumns (オプション)エンティティのプライマリーテーブルを参照するコレクションテーブルの外部キーのカラム。
java.lang.String	name (オプション) コレクションテーブルの名前。
java.lang.String	schema (オプション) テーブルのスキーマ。
UniqueConstraint[]	uniqueConstraints (オプション) テーブルに設置されるユニーク制約。

要素の詳細

name

public abstract java.lang.String name

(オプション) コレクションテーブルの名前。 指定されていない場合はこれが含まれるエンティティの名前とコレクションの属性の名前がアンダースコアで分けられて結合されたものがデフォルトです。

デフォルト:

""

catalog

public abstract java.lang.String catalog

(オプション) テーブルのカタログ。 指定されていない場合はデフォルトカタログが使用されます。

デフォルト:

""

schema

public abstract java.lang.String schema

(オプション) テーブルのスキーマ。 指定されていない場合はユーザーにとっての規定のスキーマが使用されます。

デフォルト:

""

joinColumns

public abstract JoinColumn[] joinColumns

(オプション)エンティティのプライマリーテーブルを参照するコレクションテーブルの外部キーのカラム。 デフォルト値は単一の結合カラムが使用されている場合のみ適用されます。 デフォルト値はJoinColumnと同じです。 (つまり、エンティティの名前 + "_" + 参照された主キーのカラムの名前) しかしながら、複数の結合カラムが存在する場合はJoinColumnsアノテーションを使用して各結合カラムに対して JoinColumnアノテーションを指定する必要があります。 この場合、それぞれのJoinColumnアノテーションのname要素とreferencedColumnName要素の両方を指定する必要があります。

デフォルト:

{}

foreignKey

public abstract ForeignKey foreignKey

(オプション) テーブルの生成が有効な場合にjoinColumns要素に関係するカラムのための外部キー制約の生成を指定または制御するために使用されます。 この要素とjoinColumns要素のいずれかのforeignKey要素の両方が指定されていた場合の挙動は未定義です。 いずれの場所にも外部キーのアノテーション要素が指定されていない場合は、永続化プロバイダのデフォルトの外部キー戦略が適用されます。

導入されたバージョン:

Java Persistence 2.1

デフォルト:

@javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_DEFAULT)

uniqueConstraints

public abstract UniqueConstraint[] uniqueConstraints

(オプション) テーブルに設置されるユニーク制約。 これらはテーブルの生成が有効な場合にのみ使用されます。

デフォルト:

{}

indexes

public abstract Index[] indexes

(オプション) テーブルのためのインデックス。 これらはテーブルの生成が有効な場合にのみ使用されます。

導入されたバージョン:

Java Persistence 2.1

デフォルト:

{}