DbjXmlUploadInfoインターフェースは，XML文書のアップロード情報を扱うインターフェースです。登録するXML文書の情報およびXMLプロパティマッピングについての情報を取得，設定するメソッドなどを提供します。

XML文書のアップロード情報は，次のメソッドの引数に指定できます。

• DbjObj#uploadContentsメソッド
• DbjDocSpace#createDocumentメソッド
• DbjDocSpace#createVrDocumentメソッド

これらのメソッドを実行すると，filePathプロパティに指定したフルパスのコンテンツを基に，XMLプロパティマッピング機能およびXMLインデクスデータ作成機能が実行されます。このとき，XML文書の構文解析結果がparseMessageプロパティに設定されます。

なお，登録するXML文書がサブレンディションの場合，このインターフェースで扱う情報は無視され，スーパーインターフェースであるDbjUploadInfoインターフェースで扱う情報だけが有効となります。

また，XML文書のアップロード情報はDbjObj#addRenditionメソッドの引数にも指定できますが，この場合も，スーパーインターフェースであるDbjUploadInfoインターフェースで扱う情報だけが有効となります。

直接のスーパーインターフェース

• DbjUploadInfo

プロパティ一覧

DbjXmlUploadInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-13に示します。

表3-13　DbjXmlUploadInfoインターフェースで扱うプロパティ

プロパティ名	データ型	getterメソッド	setterメソッド
filterFilePath	String型	getFilterFilePath	setFilterFilePath
indexType	int型	getIndexType	setIndexType
mappingId	String型	getMappingId	setMappingId
parseLevel	int型	getParseLevel	setParseLevel
parseMessage	String型	getParseMessage	clearParseMessage※

注※　構文解析結果メッセージをクリアするメソッドです。

プロパティ詳細

• filterFilePathプロパティ
  全文検索インデクス作成時に使用するフィルタリング定義ファイルのフルパスです。
  このプロパティ値にnullを設定した場合で，かつデフォルトのファイルが存在しないときは，フィルタリング定義ファイルを使用しないで処理を実行します。
  初期値はnullです。
  なお，このプロパティ値は，登録するXML文書がマスタレンディションの場合にだけ有効です。
  
• indexTypeプロパティ
  XML文書から作成する全文検索インデクスの種別です。
  初期値はDbjDef.INDEXTYPE_NOTHING（全文検索インデクスを作成しない）です。
  なお，このプロパティ値は，登録するXML文書がマスタレンディションの場合にだけ有効です。
  
• mappingIdプロパティ
  XMLプロパティマッピングのマッピング定義名です。
  XMLプロパティマッピング機能を実行しない場合は，nullを指定します。
  初期値はnullです。
  
• parseLevelプロパティ
  XML文書の構文解析レベルです。
  初期値はDbjDef.XMLPARSE_NO_EXTERNAL_ENTITIES（DTDの解析をしないで外部エンティティを無視）です。
  
• parseMessageプロパティ
  XML文書の構文解析結果メッセージが設定されます。解析エラーの場合は例外がスローされるので，このプロパティに設定されるメッセージはワーニング（警告）メッセージだけです。ワーニングがなかった場合，このプロパティ値はnullとなります。
  初期値はnullです。
  

DbjUploadInfoインターフェースから継承するプロパティ詳細

• filePathプロパティ
  登録するXML文書のローカルパス名を表します。ファイル名を含むフルパス名です。
  プロパティマッピング機能を実行しない場合，または全文検索インデクスを作成しない場合は，このプロパティ値にnullを指定できます。
  
• indexPathプロパティ
  XML文書のアップロード情報オブジェクト（DbjXmlUploadInfoオブジェクト）では，このプロパティは無効です。常にnullが設定されます。
  
• renditionPropSetプロパティ
  登録するXML文書のレンディションプロパティ値集合です。
  
• renditionTypeプロパティ
  登録するXML文書のレンディションタイプを表します。
  
• retrievalNameプロパティ
  登録するXML文書のクライアント側でのオリジナルファイル名を表します。
  

以降，DbjXmlUploadInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.30.1　clearParseMessage（構文解析結果メッセージのクリア）

3.30.2　getFilterFilePath（フィルタリング定義ファイルのフルパスの取得）

3.30.3　getIndexType（全文検索インデクスの種別の取得）

3.30.4　getMappingId（マッピング定義名の取得）

3.30.5　getParseLevel（構文解析レベルの取得）

3.30.6　getParseMessage（構文解析結果メッセージの取得）

3.30.7　setFilterFilePath（フィルタリング定義ファイルのフルパスの設定）

3.30.8　setIndexType（全文検索インデクスの種別の設定）

3.30.9　setMappingId（マッピング定義名の設定）

3.30.10　setParseLevel（構文解析レベルの設定）