8.12.6　エンティティでのプライマリキーの指定

(a)　埋め込み型クラスを利用する方法

埋め込み型クラスを利用するには，@Embeddableを付与したクラスを作成し，そのクラスのフィールドとして複合型のプライマリキーを定義します。エンティティクラスでは，@Embeddableを付与したクラスの型のフィールドを定義して，@EmbeddedIdをアノテートします。エンティティクラスの例と埋め込み型クラスの例を次に示します。

• エンティティクラスの例

  @Entity
  public class Employee {
      private EmployeePK employeePK;
   
      public Employee(){
      }
   
      @EmbeddedId
      public EmployeePK getEmployeePK(){
        retrun this.employeePK;
      }
   
      public void setEmployeePK(EmployeePK employeePK){
        this.employeePK = employeePK;
      }
      ・・・
  }

• 埋め込み型クラスの例

  @Embeddable
  public class EmployeePK {
      private String name;
      private int employeeId;
   
      public EmployeePK(){
      }
   
      public boolean equals(Object obj){
        ・・・
      }
   
      public int hashCode(){
        ・・・
      }
      ・・・
  }

埋め込み型クラスについては「(3)　埋め込み型クラス」を参照してください。なお，アノテーションの代わりにO/Rマッピングファイルを利用することもできます。

(b)　@IdClassを利用する方法

@IdClassを利用するには，エンティティクラスでプライマリキーに対応する複数のインスタンス変数を定義して@Idを付与します。また，@IdClassを使用してプライマリキークラスを指定します。プライマリキークラスでは，エンティティで定義したプライマリキーと同じ名前と型を持つフィールドまたはプロパティを定義します。エンティティクラスの例とプライマリキークラスの例を次に示します。

• エンティティクラスの例

  @Entity
  @IdClass(EmployeePK.class)
  public class Employee {
      private String name;
      private int employeeId;
   
      public Employee(){
      }
   
      @Id
      public String getName(){
        retrun this.name;
      }
   
      public void setName(String name){
        this.name = name;
      }
   
      @Id
      public int getEmployeeId(){
        retrun this.employeeId;
      }
   
      public void setName(int employeeId){
        this.employeeId = employeeId;
      }
      ・・・
  }

• プライマリキークラスの例

  public class EmployeePK implements Serializable {
      private String name;
      private int employeeId;
   
      public EmployeePK(){
      }
   
      public boolean equals(Object obj){
        ・・・
      }
   
      public int hashCode(){
        ・・・
      }
      ・・・
  }

埋め込み型クラスの場合と同様に，アノテーションの代わりにO/Rマッピングファイルを利用することもできます。なお，プライマリキークラスのアクセスタイプは，プライマリキーに対応するエンティティクラスのアクセスタイプで決定します。

複合型のプライマリキーを扱うためには，埋め込み型クラスまたは@IdClassのどちらかを使用します。ただし，次に示すルールに従ってください。

• プライマリキークラスは，publicで引数のないコンストラクタを持たなければならなりません。

• 永続化プロパティを使用する場合，プライマリキークラスのプロパティはpublicまたはprotectedにしてください。

• プライマリキークラスは，直列化可能にしてください。

• プライマリキークラスではequalsとhashCodeメソッドを定義します。マップされているデータベース上で主キーが等しい場合にはequalsでtrueを返し，hashCodeの値を等しくする必要があります。

• 複合プライマリキーは，埋め込みクラスとしてマップされているか，エンティティクラスの複数のフィールド／プロパティをマップされている必要があります。

• プライマリキークラスがエンティティクラスの複合フィールド／プロパティにマップされる場合，プライマリキークラスのプライマリキーのフィールド／プロパティの名前と，エンティティクラスの名前を一致させてください。また，型も同じにしてください。

CJPAプロバイダでは，これらの条件を満たさない場合動作は保証しません。また，条件を満たさない場合はアプリケーションの開始時に例外が発生することもあります。