xfy technologyのコンポーネント・アーキテクチャ

新しいXMLボキャブラリをxfyプラットフォーム上で扱うには、そのXMLボキャブラリの表示・編集に対応したコンポーネントを作成します。XMLボキャブラリの表示・編集に対応するコンポーネントは、ボキャブラリコンポーネントと呼ばれます。代表的なボキャブラリコンポーネントの例としては、次のものがあります。

• XHTMLコンポーネント
• SVGコンポーネント

ボキャブラリコンポーネントは、xfy technologyでもっとも特徴的な機能拡張コンポーネントです。このコンポーネントは、ほかのコンポーネントのようにJava言語で作成するだけではなく、後述するXVCDというスクリプト言語を使用して作成することもできます。

xfyプラットフォーム上で利用する機能ライブラリは、コンポーネントを作成すると拡張できます。機能ライブラリを拡張するためには、次のコンポーネントを作成します。

• XPath関数拡張コンポーネント
  XML 文書を処理するときに使用するXPath式関数を追加するコンポーネントです。
• インストラクションコンポーネント
  編集対象のXML文書から作成されたDOMツリーを操作する命令を追加するコンポーネントです。

これらのコンポーネントを作成すると、複雑な数値演算や文字列操作を行う関数やインストラクションを追加できます。

xfyプラットフォームであらかじめ提供されているプロトコル以外の新たなプロトコルやサーバーへのアクセス方法の追加など、xfyプラットフォームのファイル入出力機能を拡張するコンポーネントを作成することができます。このようなコンポーネントは、I/Oコンポーネントと呼ばれます。I/Oコンポーネントが提供する機能には、次のようなものが考えられます。

• サーバーからネットワーク経由でファイルを取得する
• XML形式でないファイルをXMLに変換して読み込む
• XMLファイルの保存方法をカスタマイズする

xfy technologyによるXML文書の編集の仕組みを利用したアプリケーションは、xfyプラットフォーム上でxfyコンポーネントを組み合わせることで実現できます。このときに、アプリケーションウインドウ自体を改造したり、機能を追加したりするようなコンポーネントを作成できます。このようなコンポーネントは、アプリケーションコンポーネントと呼ばれます。xfy Clientは、xfy technology を使用したアプリケーションの一例です。

上記のほかにも、目的に応じてコンポーネントの種類を増やすことができます。また、コンポーネントが利用するxfyプラットフォーム上のインターフェース定義を拡張することもできます。

xfyプラットフォーム上で動作する機能の最小単位がxfyコンポーネントです。通常、xfyコンポーネントはJava言語で作成されます。XMLボキャブラリを表示・編集したり、保存時の書式を指定するコンポーネントを作成するときは、後述するXVCDやXFRなどのXMLスクリプト言語を利用することもできます。

XMLスクリプト言語やJavaで作成したxfyコンポーネントは、所定の手順でアーカイブしてxfyプラグインJARファイルを作成します。作成したxfyプラグインJARファイルは、xfyプラットフォームの実行環境に配置すると使用できるようになります。

xfyプラグインJARファイルとxfyコンポーネントとの関係が１対１になるとは限りません。１つのxfyプラグインJARファイルに複数のxfyコンポーネントが含まれることも、１つのxfyコンポーネントが複数のxfyプラグインJARファイルによって構成されることもあります。

xfyプラットフォームではボキャブラリコネクション（Vocabulary Connection）という機構が提供されています。ボキャブラリコネクションは、新しいXMLボキャブラリを既存のXMLボキャブラリに結びつけて、既存のボキャブラリコンポーネントで提供される表示・編集機能を利用できるようにします。このボキャブラリコネクションを利用するためのXMLスクリプト言語がXVCDです。XVCDを使用すると、新しいXMLボキャブラリに対応したボキャブラリコンポーネントを簡単に作成できます。

ボキャブラリコネクションの技術的概要については、「Vocabulary Connection技術概要」をご覧ください。また、XVCDによるボキャブラリコンポーネント開発の概要は「XVCDによるボキャブラリコンポーネントの開発手順」を、サンプルを元にした開発チュートリアルは「XVCDによるボキャブラリコンポーネントの作成」を、それぞれご覧ください。開発のためのリファレンスの読み方は、「リファレンスの読み方」をご覧ください。

xfyプラットフォームでは、XML文書で使用する要素ごとに保存するときの規則を設定することで、保存するXML文書の体裁を整える、XML文書保存時書式整形コンポーネントを作成できます。このときに使用するXMLスクリプト言語がXFR（XML Formatting Rule）です。書式整形規則を記述したXFRをコンポーネントとして動作させると、XML文書をソース表示したときに見やすい形式で保存できるようになります。

XVCDやXFRなどのXMLスクリプト言語で作成したコンポーネントは、xfyプラグインJARファイル形式にアーカイブして使用する方法のほかに、以下の簡易的な方法で使用できます。

Java言語を用いると、ボキャブラリコンポーネントをはじめとするさまざまなxfyコンポーネントを作成できます。

Javaによるxfyコンポーネント開発の概要については、「Java言語によるxfyコンポーネントの開発の概要」をご覧ください。xfyデベロッパーズガイドでは、xfyコンポーネント開発についてのチュートリアルやサンプルも提供しています。

XMLスクリプト言語やJavaで作成したxfyコンポーネントは、所定の手順に従ってxfyプラグインJARファイル形式にアーカイブし、xfyプラットフォームの実行環境に配置することで使用できるようになります。

xfyプラグインJARファイルを作成するためには、以下の方法があります。

XVCDプラグイン化ツールを利用して作成

XVCDプラグイン化ツールを利用すると、XVCDやXFRなどのXMLスクリプト言語で作成したコンポーネントをxfyプラグインJARファイル形式にアーカイブすることができます。
XVCDプラグイン化ツールの使用方法は、「XVCDプラグイン化ツール操作マニュアル」をご覧ください。

所定のファイルを持つJARファイルとして作成

Java言語で開発されたxfyコンポーネントの場合、クラスファイルをアーカイブしたJAR（Java ARchive）ファイル内に、xfyプラットフォームが必要とする所定のファイルを配置することで、xfyプラグインJARファイルとして取り扱うことができるようになります。

xfyプラグインJARファイルを配置するxfyプラットフォームの実行環境の主なフォルダ構成は、次のとおりです。なお、以下のフォルダ構成の基点は、インストーラーでのインストール先またはzipファイルの展開先のフォルダとなります。

[-] bin                      … xfyプラットフォームの実行ファイル群が配置されるフォルダ
    [+] common               … 複数のxfyコンポーネントから共通で利用されるxfyプラグインJARファイルを配置するフォルダ
    [+] plugins              … 通常のxfyプラグインJARファイルを配置するフォルダ
    [+] temporaryPlugins     … クライアント環境からインポートされたプラグインを配置するフォルダ
        xfyCore.jar          … xfyプラットフォームのコアプラグイン
        xfyClient.jar        … xfyユーザーエージェントの起動や、
                                各xfyプラグインJARファイルの初期化処理を行うJARファイル

xfyプラグインJARファイルの配置先は、配置を行うツールによって決定されます。

commonフォルダおよびpluginsフォルダは、xfyプラットフォームのパッケージ管理機能で管理されるxfyプラグインJARファイルを配置するためのフォルダです。パッケージ管理機能以外がこれらのフォルダ以下にxfyプラグインJARファイルを配置してはいけません。commonフォルダ以下には、複数のxfyコンポーネントから利用される共通のxfyコンポーネントを含むxfyプラグインJARファイルが配置されます。必要なときに利用される通常のxfyコンポーネントのみが含まれるxfyプラグインJARファイルは、pluginsフォルダ以下に配置されます。

commonフォルダに配置されたxfyプラグインJARファイルは、xfyプラットフォームの起動時にロードされます。それに対してpluginsフォルダに配置されたxfyプラグインJARファイルは、xfyプラットフォームの起動時には、JARファイル内に含まれるコンポーネントによる機能拡張の情報だけが読み込まれます。プログラム自体は、コンポーネントが提供する機能が必要とされたときにロードされます。

temporaryPluginsフォルダは、クライアント環境からインポートされたxfyプラグインを配置するためのフォルダです。このフォルダ以下にはxfyユーザーエージェントのプラグインインポート機能などがxfyプラグインJARファイルを配置します。

上記の各フォルダとも、配置先のフォルダ内にはベンダーごとにディレクトリを作成し、その中にxfyプラグインJARファイルを配置します。