ボキャブラリコンポーネントのプロパティ

ボキャブラリコンポーネントのプロパティを設定する方法を説明します。

1. はじめに

この文書ではボキャブラリコンポーネントのプロパティを設定する方法を説明します。

2. プロパティの設定方法

ボキャブラリコンポーネントのプロパティは、それぞれのボキャブラリコンポーネント自体の情報を示すために使用されます。プロパティの値は、次の操作で参照できます。

ボキャブラリコンポーネントのプロパティは、国際化を考慮して対象とする言語ごとに切り替えられるようにする必要があります。そのため、ボキャブラリコンポーネントのプロパティはリソースファイルで提供します。リソースファイルについて、詳しくは「リソースファイルリファレンス」をご覧ください。

コンポーネントのプロパティはリソースファイルの予約済みのリソースを利用して指定します。[コンポーネントプロパティ・切り替え]ダイアログボックスの[情報]に表示される項目と、リソース名の対応は次のとおりです。

項目名 リソース名 内容の説明
コンポーネント名 xfy-name ボキャブラリコンポーネントの名前
バージョン xfy-version ボキャブラリコンポーネントのバージョン
説明 xfy-description ボキャブラリコンポーネントの簡単な説明
著作権情報 xfy-copyright 著作権に関する情報
詳細URL xfy-description-ref ボキャブラリコンポーネントの説明があるURL

表示されている項目のほかに、次のプロパティが存在します。

リソース名 内容の説明
xfy-short-name ボキャブラリコンポーネントの省略名、コンポーネント一覧などに表示される名前
xfy-vendor ボキャブラリコンポーネントを作成したベンダーの名前

ボキャブラリコンポーネントを実装するときは、上記の項目を設定したリソースファイルを作成します。作成したリソースファイルは、ボキャブラリコンポーネントを公開するときに一緒に提供します。

ボキャブラリコンポーネントを作成するには、Javaで作成する方法と、XVCDで作成する方法があります。それぞれの方法でリソースファイルを指定するには、次のようにします。

Javaで作成したボキャブラリコンポーネントの場合
Javaでボキャブラリコンポーネントを作成した場合、com.xfy.common.framework.vocabularyパッケージに含まれるVocabularyServiceインターフェイスを実装したクラスが、ボキャブラリコンポーネントのパッケージに存在します。このクラスと同じファイル名で、拡張子が".resource"のリソースファイルを作成します。作成したリソースファイルは、クラスと同じパッケージへ配置します。
XVCDで作成したボキャブラリコンポーネントの場合
ボキャブラリコンポーネントのXVCDファイルに、 xvcd:resource要素を使用してリソースファイルへのURIを記述します。そのため、作成したリソースファイルは任意の場所へ配置できます。