「新規 SQLJ ファイル」ウィザード用の Java エミッター・テンプレートの作成と実装

Java™ エミッター・テンプレート (JET) を作成して、「新規 SQLJ ファイル」ウィザードで収集 される情報を使用する SQLJ ファイルを生成できます。

前提条件: ワークベンチで JET プロジェクトを作成してください。
このタスクを実行するには、Java エミッター・テンプレートの作成経験が必要です。 Java エミッター・テンプレートの作成に関する情報については、eclipse.org の Web サイトで以下の記事を参照してください。

このタスク・ステップではスペースを節約するために、...¥com.ibm.datatools.sqlj ディレクトリーへの絶対パスが省略されています。 絶対パスは、install_directory¥eclipse¥plugins¥com.ibm.datatools.sqlj です。

「新規 SQLJ ファイル」ウィザード用の JET テンプレートを作成して実装するには、次のようにします。

  1. 以下のようにして、JET プロジェクトにスケルトンを追加します。
    • SQLJFileSkeleton.skel ファイルを JET プロジェクトにインポートします。 このファイルは、...¥com.ibm.datatools.sqlj¥templates¥skeleton ディレクトリーに入っています。
    • JET プロジェクト内にスケルトンを作成します。 このスケルトンでは、ISQLTemplate インターフェースを実装するクラスを定義する必要があり、このインターフェースは、IBeanData をパラメーターとして受け入れる generate() メソッドを備えている必要があります。
  2. JET プロジェクト内にテンプレートを作成します。 ファイルを新規作成することもできますし、ワークベンチに付属しているテンプレートの 1 つをインポートして、必要に応じてその内容を変更することもできます。 テンプレート・ファイルは、...¥com.ibm.datatools.sqlj¥templates ディレクトリーに入っています。
    テンプレート内の JET ディレクティブには、以下のものが含まれている必要があります。
    • ...¥com.ibm.datatools.sqlj¥templates ディレクトリー内のすべてのテンプレートで固有なクラス名。 テンプレート名と同じクラス名を使用することをお勧めします。
    • 使用しているスケルトンを参照する skeleton 属性。
  3. SQLJ プラグイン用のランタイム JAR ファイルをプロジェクトの Java のビルド・パスに追加します。 プロジェクトの「プロパティー」ウィンドウで「Java のビルド・パス」をクリックし、「ライブラリー」ページで以下のいずれかのアクションを実行します。
    • 「新規 SQLJ ファイル」ウィザードで SQLJ ファイルを作成した場合は、「変数の追加」をクリックし、「新規変数クラスパス・エントリー」ウィンドウで「SQLJPLUGIN」をダブルクリックします。
    • 「新規 SQLJ ファイル」ウィザードを使用しなかった場合は、「外部 JAR の追加」をクリックし、「JAR 選択」ウィンドウで ...¥com.ibm.datatools.sqlj ディレクトリーへ進み、sqlj.jar ファイルをダブルクリックします。
    SQLJ プラグイン用のランタイム JAR ファイルは、テンプレート内で、SQLJ プラグイン内のクラスへの参照を解決します。
  4. テンプレートのコンパイルが正常に完了した後、その .sqljjet ファイルを ...¥com.ibm.datatools.sqlj¥templates ディレクトリーにコピーします。 新規スケルトン・ファイルを作成した場合は、JET ディレクティブ内の参照に一致する ...¥com.ibm.datatools.sqlj の下のサブディレクトリーに、そのスケルトン・ファイルをコピーします。
  5. テンプレートの説明を、...¥com.ibm.datatools.sqlj¥template¥properties ディレクトリー内の user.properties ファイルに追加します。 そのファイルをテキスト・エディターでオープンし、コメント行の後に以下の 2 行を追加します。
    template_file_name.label=Template name
    template_file_name.desc=Template description
    ラベルの中で指定したテンプレート名は、「新規 SQLJ ファイル」ウィザードの「テンプレート」リストに組み込まれます。 このテンプレートがリスト内で選択された場合は、このテンプレートの説明がリストの隣にある表示ボックスに表示されます。
  6. ウィザードを使用して SQLJ ファイルを作成し、テンプレートを選択した後、生成された SQLJ ファイル内の結果コードを検討します。
テンプレートに変更を加える必要がある場合は、次のいずれかの方法を使用できます。 次回に「新規 SQLJ ファイル」ウィザードを使用して新規 SQLJ ファイルを作成するときに、SQLJ プラグインはテンプレート・ファイルが変更されたことを検出し、更新されたテンプレートを使用します。

フィードバック