XML形式のコンテンツを管理する場合,XML文書管理機能が使用できます。XML文書管理機能は,DbjXmlTranslatorインターフェースとDbjXmlUploadInfoインターフェースの機能として提供されています。
DbjXmlTranslatorインターフェースは,DbjMappedPropインターフェースを取得するgetMappedPropertiesメソッドを提供しています。このメソッドを実行すると,マッピング定義ファイルとXMLファイルを基に,XML文書作成時に指定するDMAクラスのリストが作成できます。また,XML文書のコンテンツ更新時に再度プロパティマッピングをするためのプロパティ値集合が作成できます。
DbjXmlUploadInfoインターフェースは,パラメタクラスのDbjUploadInfoインターフェースのサブインターフェースです。XML文書のコンテンツの新規登録時に,文書のアップロード情報として指定します。このインターフェースを使用すると,指定したコンテンツからマッピングするプロパティ値集合と全文検索インデクス用データが作成されます。
なお,XML文書管理機能は,XML文書の新規作成時と,XML文書のコンテンツの更新時またはXML文書のプロパティの更新時では,使用方法が異なります。
- XML文書の新規作成時
- XML文書の新規作成時は,DbjXmlUploadInfoインターフェースで,マッピングするプロパティ値集合と構造指定検索用インデクスデータが作成できます。使用するDMAクラスがすでに決まっている場合は,DbjXmlTranslatorインターフェースを使用しなくても,XMLプロパティマッピング機能とXMLインデクスデータ作成機能が実行できます。ただし,マッピング定義ファイルからDMAクラスのリストを取得したい場合は,DbjXmlTranslatorインターフェースを使用します。
- なお,マルチレンディション文書を作成する場合にXML文書管理機能を使用したい場合は,XML形式のファイルをマスタレンディションとして登録する必要があります。文書の作成時に指定する文書のアップロード情報のリストの,先頭の要素にXML文書のアップロード情報(DbjXmlUploadInfoインターフェース)を指定します。
- XML文書のコンテンツ更新時
- 既存のXML文書のコンテンツ更新時にXMLプロパティマッピング機能およびXMLインデクスデータ作成機能を使用する場合は,DbjXmlTranslatorインターフェースとDbjXmlUploadInfoインターフェースの両方を使用します。
- XMLプロパティマッピング機能には,DbjXmlTranslatorインターフェースを使用します。DbjXmlTranslator#getMappedPropertiesメソッドを実行して,指定したXML形式のファイルからプロパティ値集合を作成します。作成したプロパティ値集合は,DbjObj#writePropertiesメソッドなどで文書空間オブジェクトに設定します。
- XMLインデクスデータ作成機能には,DbjXmlUploadInfoインターフェースを使用します。DbjObj#uploadContentsメソッドなどの引数に,XML形式のファイルをコンテンツとして指定したDbjXmlUploadInfoインターフェースを指定します。これによって,コンテンツから抽出されたXMLインデクスデータを基に,文書の全文検索インデクスが更新されます。
- なお,XML文書のコンテンツ更新時にXMLインデクスデータ作成機能が使用できるのは,更新するコンテンツがXML形式の場合に,XML文書であるマスタレンディションをDbjXmlUploadInfoインターフェースを使用して更新するときだけです。