Interstage Application Server J2EE ユーザーズガイド

26.9 Primary Keyクラスを作成する

　Primary Keyクラスは、Entity Beanのインスタンスの識別子となるクラスで、特定のインスタンスを検索するのに使用されます。

　Apworksを使用している場合は、自動的に生成されます。

■ Primary Keyクラスの規約

　Primary Keyクラスは以下の規約を満たしていなければなりません。

• java.io.Serializableインタフェースを実装した非リモートJavaオブジェクトでなければなりません。
• パラメタなしの空コンストラクタを用意しなければなりません。
• ObjectクラスのhashCodeメソッドとequalsメソッドを再定義しなければなりません。

■ 記述する処理

1. プライマリキー値を格納する変数を記述します。複数記述することも可能です。
2. パラメタなしの空コンストラクタを記述します。
3. equalsメソッドを記述します。引数で渡されるPrimary Keyオブジェクトと同じものかどうか判定します。
4. hashcodeメソッドを記述します。プライマリキー値のhashcodeを返却します。

■equalsメソッドとhashcodeメソッド

　equalsメソッドとhashcodeメソッドには以下のような特徴があります。

• equalsメソッド

  コンテナがインスタンスを検索する際に、プライマリキーの値が同一かを判断するために実行します。
  また、EJBObjectクラスのisIdenticalメソッドを実行した際に実行されます。

• hashcodeメソッド

  equalsメソッドを実行する前に、インスタンスの絞り込みを行うためのメソッドです。異なるインスタンスに対してできるだけ異なる値を返却するようにhashcodeメソッドを定義しておくと、コンテナがインスタンスを検索する際の性能を向上させることができます。

メソッド定義時の注意事項

• equalsメソッドで同じインスタンスと判断される場合は、hashcodeメソッドで同じ整数値を返却するように定義してください。
  また、equalsメソッドで同じインスタンスと判断されない場合でも、hashcodeメソッドが異なる整数値を返却する必要はありません。
• メソッド定義を誤った場合、CMFの更新処理が反映されないなどの現象が発生する場合がありますので、基本的にはApworksが出力するひな形を使用してください。
  ただし、プライマリキーに固定長文字列のDBカラムを指定した場合、DBから取得されるデータは文字列長分だけ後方空白が埋め込まれて取得されます。この場合は、後方空白を削除した文字列を比較するなど、equalsメソッドとhashcodeメソッドを定義してください。
  

■ CMPでプライマリキーのフィールドが1つの場合

　CMPでプライマリキーのフィールドが1つの場合で、フィールドが以下の型の場合には、Primary Keyクラスを作成しないことも可能です。

• java.lang.Boolean
• java.lang.Byte
• java.lang.Character
• java.lang.Short
• java.lang.Integer
• java.lang.Long
• java.lang.Float
• java.lang.Double
• java.math.BigDecimal
• java.sql.Date
• java.sql.Time
• java.sql.Timestamp
• java.lang.String

　この場合、通常はPrimary Keyクラスを指定するHomeインタフェースのcreateメソッドやfindByPrimaryKeyメソッドなどの引数には以下のように、プライマリキーのフィールドを指定します。

例)プライマリキーがString型の場合

---------------------------------------------------------------------------------------

public SampleRemote create(String pkField) throws javax.ejb.DuplicateKeyException, javax.ejb.CreateException, java.rmi.RemoteException;

public SampleRemote findByPrimaryKey(String pkValue) throws javax.ejb.FinderException, javax.ejb.ObjectNotFoundException, java.rmi.RemoteException;

---------------------------------------------------------------------------------------

　また、deployment descriptorの“Primary Keyクラス名”にはプライマリキーのフィールドの型（java.lang.Stringなど）を指定し、“Primary Keyフィールド名”にはフィールド名を指定してください。

---

26.9.1 CMPの記述例