XML 構成ファイルを利用したインプリメンテーション・クラスの生成

インターフェースのインプリメンテーションを生成する場合、XML ファイルを使用することによって、そのインターフェース内の SQL アノテーションをオーバーライドできます。 XML ファイルは、対応する Bean の定義もオーバーライドできます。XML ファイルはワークベンチによって生成され、生成された XML ファイルは編集可能です。

このタスクについて

インターフェースのインプリメンテーションを生成するために、ワークベンチは pureQuery ジェネレーターを呼び出します。pureQuery ジェネレーターに XML ファイルを提供することによって、インターフェースで宣言されるメソッドのアノテーション内の SQL ステートメントをオーバーライドできます。

pureQuery ジェネレーターが XML 構成ファイルを調べるときに認識するタイプ、エレメント、および属性は、Java™ Persistence API (JPA) 正式仕様のサブセットです。

XML 構成ファイルはプロジェクトごとに 1 つだけ定義できます。プロジェクトの XML ファイルを作成した後は、そのプロジェクト内のインターフェースまたは Bean に対して作成されるすべてのオーバーライドは、そのファイルに付加されます。

手順

XML 構成ファイルを利用してインプリメンテーション・クラスを再生成するには、 以下のようにします。

  1. オプション: 生成する XML 構成ファイルの名前およびパスを指定します。 このステップを実行しなければ、名前とパスはデフォルトで <path_to_workspace>¥dataAccessFolder¥orm.xml になります。
    1. Java プロジェクトを右クリックし、「プロパティー」を選択します。
    2. 「pureQuery」ページを選択します。
    3. 「pureQuery XML 生成のためのファイル・パス」で、パスとファイル名を入力するか、既存の XML ファイルを参照して選択します。
  2. 以下のステップのいずれかまたは両方を実行して、XML 構成ファイルを生成します。 両方のステップを実行した場合には、ワークベンチによって、最初に実行したステップで作成されたファイルの XML に後のステップのものが追加されます。
    • インターフェースで宣言されるアノテーション内の SQL ステートメントをオーバーライドするための編集が可能な XML を生成するには、次のようにします。
      1. インターフェースを Java エディターで開きます。
      2. インターフェース内の任意の場所を右クリックして、「データ・アクセス開発」>「XML の生成」を選択します。 XML 構成ファイルがまだ存在しない場合には、ワークベンチによって、指定したロケーションにファイルが生成されます。 ファイルが既に存在する場合には、ワークベンチによって、そのファイルの内容に XML が追加されます。

        アノテーション付きメソッド・スタイル・インターフェースを拡張するインターフェースで右クリックすると、 ワークベンチは、アノテーション付きメソッドを宣言していれば、拡張元インターフェースの XML メタデータに加えて、 各拡張インターフェースの XML メタデータを生成します。

    • インターフェースに対応する Bean の定義をオーバーライドするための編集が可能な XML を生成するには、以下のステップを実行します。
      1. Bean を Java エディターで開きます。
      2. Bean 内の任意の場所を右クリックして、「データ・アクセス開発」>「XML の生成」を選択します。 XML 構成ファイルがまだ存在しない場合には、ワークベンチによって、指定したロケーションにファイルが生成されます。 ファイルが既に存在する場合には、ワークベンチによって、そのファイルの内容に XML が追加されます。
  3. 再生成するインプリメンテーション・クラスごとにステップ 2 を繰り返します。
  4. XML 構成ファイルを編集します。
  5. 再生成するインターフェースのインプリメンテーションを削除します。
  6. 「プロジェクト」>「クリーン」を選択してプロジェクトをクリーンすることを指定します。 XML ファイル内のオプションに基づいてインプリメンテーションが再生成されます。

フィードバック