XVCDプラグイン化ツールを使ったxfyプラグインの作成

このチュートリアルでは、XVCDプラグイン化ツールを使ったxfyプラグインの作成方法を、非常に簡単な例題を使い、順を追って見ていきます。必要なものは、XVCDファイルとその関連ファイルです。このチュートリアルを実践することで、XVCDファイルなどを元に、xfyユーザーエージェントで使用可能なxfyプラグインJARファイルを作成することができます。

このチュートリアルを実践するための開発環境の準備については、「XVCDで開発する環境の準備」をご覧ください。

このチュートリアル内のサンプルコードは、xfy Developer's Toolkit 配布パッケージ内のdoc/samples/developers/tutorial/xvcd_archive_toolに収録されています。xfy Developer's Toolkitには、このチュートリアルのほかにも豊富なXVCDサンプルが用意されています。ぜひ、それらのサンプルもご覧ください。

なお、このチュートリアルでは、xfyユーザーエージェントとして、xfy Basic Editionに含まれるxfy Clientを使用します。

まずは、xfyプラグインJARファイルを作成する元となるXVCDファイルなどを準備しましょう。

XVCDプラグイン化ツールは、指定したフォルダ以下をまるごとxfyプラグインJARファイルとしてアーカイブします。従って、準備するXVCDファイルは、そのXVCDファイルが存在するフォルダ以下で参照関係が完結している必要があります。参照関係が生じるのは、元となるXVCDファイルが実行されるときに利用されるファイルです。種類としては、XVCDファイルやユーザーインターフェイス設定ファイル、リソースファイルなどが挙げられます。

このチュートリアルでは、xfy Developer's Toolkit 配布パッケージ内のdoc/samples/developers/tutorial/xvcd_archive_toolに収録されているサンプルを使用します。このフォルダには、lite-document2.xvcdというXVCDファイルのほか、lite-document2.xvcdが参照しているlite-document2.resource、lite-document2.uiの各ファイルと、それらとは独立しているlite-document2.xfrが含まれています。これらのファイルの内容や、使用されている要素や属性について、詳しくはそれぞれ次のリファレンスをご覧ください。

• lite-document2.resource
  「リソースファイルリファレンス」
• lite-document2.ui
  「ユーザーインターフェイス記述リファレンス」
• lite-document2.xfr
  「XFR（XML Formatting Rule）リファレンス」

それでは、準備したXVCDファイルを元に、XVCDプラグイン化ツールを使ってxfyプラグインJARファイルを作成しましょう。

なお、XVCDプラグイン化ツールの操作方法は、「XVCDプラグイン化ツール操作マニュアル」を参照してください。

1. XVCDプラグイン化ツールを起動する

   xfy Clientで、［ツール - xfy Developer's Toolkit - XVCDプラグイン化ツール］を選択します。
   XVCDプラグイン化ツールが起動し、アーカイブファイルの設定画面が表示されます。

   
   XVCDプラグイン化ツールを起動
2. xfyプラグインのプロパティを設定する

   アーカイブファイルの設定画面では、作成するxfyプラグインのプロパティを設定します。

   ファイルの種類

   XVCDを元にしたxfyプラグインを作成するので、［xfyプラグインJARファイル（JAR）］を選択します。

   ベンダー名

   ベンダー名には、xfyプラグインを作成したベンダーが所持するドメイン名を逆順に記述した文字列を使用します。この例では、あなたがexample.comという組織に所属しているとします。この場合、「com.example」と入力します。

   プラグイン名

   ここで入力した名前を元にして、xfyプラグインJARファイルのファイル名が決定されます。そのため、同一ベンダー内で重複しないようにします。この例では、「tutorial」と入力します。

   バージョン

   作成するアーカイブファイルのバージョンを設定します。４つある入力欄には、左から順に、メジャーバージョン、マイナーバージョン、ビルドナンバー、リビジョンを設定します。この例では、左から順に、「1」・「0」・「1」・「0」を入力します。

   表示名

   作成するxfyプラグインの表示用の名前を入力します。表示名は省略できます。この例では、「sample plug-in」と入力します。

   説明

   作成するxfyプラグインについての説明を入力します。説明文は省略できます。この例では、「This is sample xfy plug-in JAR file.」と入力します。

   著作権

   作成するxfyプラグインについての著作権情報を入力します。著作権情報は省略できます。この例では、「(C)2006 example.com」と入力します。

   作成元フォルダ

   xfyプラグインJARファイルを作成する元となるXVCDファイルなどが存在するフォルダを指定します。ここでは、さきほど準備したxfy Developer's Toolkit 配布パッケージ内のdoc/samples/developers/tutorial/xvcd_archive_toolフォルダを指定します。

   
   設定を入力

   すべての設定が完了したら、［次へ］をクリックします。
   システムに登録するファイルの選択画面が表示されます。

3. システムに登録するファイルを選択する

   システムに登録するファイルの選択画面には、作成元フォルダ以下に存在するXVCDファイルとXFRファイルが、それぞれの一覧に表示されます。

   
   システムに登録するファイルを選択

   システムに登録するファイルとして選択されたXVCDファイルとXFRファイルは、xfyプラットフォームが起動してxfyプラグインJARファイルをロードするときに参照されます。そして、ファイル内に記述されている xvcd:vocabulary要素や xfr:xfr要素の設定に基づいて、各コンポーネントがxfyプラットフォームに登録されます。

   ここではすべてのファイルを選択した状態で、［次へ］をクリックします。
   保存先の選択画面が表示されます。

4. xfyプラグインJARファイルの保存先を指定する

   保存先の選択画面では、xfyプラグインJARファイルを保存するフォルダを指定します。この例では、保存先フォルダを「C:\Documents and Settings\xfyuser\My Documents」とします。

   
   保存先の指定

   ここで指定した保存先フォルダ内に、アーカイブファイルの設定画面の［ベンダー名］に入力した名前のサブフォルダが作成されます。その作成されたフォルダの中にxfyプラグインJARファイルが作成されます。作成されるxfyプラグインJARファイルの名前は、アーカイブファイルの設定画面の［プラグイン名］に入力した名前に拡張子「.jar」が付加されたものとなります。この例で作成されるファイル名は、「C:\Documents and Settings\xfyuser\My Documents\com.example\tutorial.jar」です。

5. xfyプラグインJARファイルを作成する

   保存先を指定したら［作成］をクリックして、xfyプラグインJARファイルを作成します。作成できたときは、保存されたファイルへのパスが書かれたメッセージボックスが表示されます。表示されたファイルへのパスをたどって、xfyプラグインJARファイルが保存されていることを確認します。

   
   作成できたときに表示されるメッセージ

作成したxfyプラグインを実際に使用してみましょう。作成したxfyプラグインJARファイルは、xfyユーザーエージェントの実行環境にインポートして、xfyユーザーエージェントを再起動することで使用できるようになります。

以下の手順に進む前に、xfy Client以外のxfyユーザーエージェントやアプリケーションが起動している場合は、すべて終了します。

ここで学んだことをまとめておきます。

• XVCDファイルの準備
  XVCDプラグイン化ツールでxfyプラグインJARファイルを作成する場合、作成元のXVCDファイルは、そのXVCDファイルが存在するフォルダ以下で参照関係が完結している必要があります。参照関係が生じるのは、元となるXVCDファイルが実行されるときに利用されるファイルです。種類としては、XVCDファイルやユーザーインターフェイス設定ファイル、リソースファイルなどが挙げられます。
• XVCDプラグイン化ツールを使用してxfyプラグインJARファイルを作成
  プロパティを適切に設定して作成すると、「保存先フォルダ/ベンダー名/プラグイン名.jar」というファイル名でxfyプラグインJARファイルが作成されます。
• xfyプラグインJARファイルのインポートと使用
  xfyプラグインをクライアント環境からインポートして、xfyユーザーエージェントを再起動すると、インポートしたxfyプラグインを使用することができます。