DbjUploadInfoインターフェース

uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　リファレンス

DbjUploadInfoインターフェースは，文書のアップロード情報を扱うインターフェースです。文書のアップロード情報を取得，設定するメソッドを提供します。

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

java.lang.Cloneable
DbjUploadInfoインターフェースは，java.lang.Cloneableインターフェースを継承します。このインターフェースのcloneメソッドは，ディープコピーを実行します。

プロパティ一覧

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

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

プロパティ名	データ型	getterメソッド	setterメソッド
filePath	String型	getFilePath	setFilePath
indexPath	String型	getIndexPath	setIndexPath
renditionPropSet	DbjPropSet	renditionPropSet	setRenditionPropSet
renditionType	String型	getRenditionType	setRenditionType
retrievalName	String型	getRetrievalName	setRetrievalName

プロパティ詳細

filePathプロパティ
登録する文書のローカルパス名を表します。ファイル名を含むフルパスです。
次に示す場合には，このプロパティの値にnullを指定できます。
・DocumentBroker Rendering Optionのレンディション変換を利用してサブレンディションを登録する場合
・マルチレンディションを使用しない文書（サブレンディションを持たない，マスタレンディションだけの文書）を登録する場合^※
注※
この場合，登録する文書から全文検索インデクスを作成しません。
初期値はnullです。
indexPathプロパティ
登録する文書の全文検索インデクスを作成するファイルのフルパスを表します。登録する文書がマスタレンディションでない場合は，このプロパティの値は無視されます。
filePathプロパティに指定したファイルから全文検索インデクスを作成する場合は，DbjDef.INDEXPATH_SAMEを指定します。全文検索インデクスを作成しない場合は，nullを指定します。
初期値はnullです。
renditionPropSetプロパティ
登録する文書のレンディションプロパティ値集合です。レンディションプロパティ値集合には，次のプロパティが指定できます。
・dbrProp_RetrievalName（レンディションに登録された文書のファイル名）
・dbrProp_RenditionStatus（レンディションの更新状態）
各レンディションプロパティの値に初期値を設定する場合は，nullを指定します。
初期値は空プロパティ値集合です。
renditionTypeプロパティ
登録する文書のレンディションタイプを表します。設定したレンディションタイプは登録文書オブジェクトのdbrProp_RenditionTypeプロパティに設定されます。
このプロパティ値にnullを設定すると，retrievalNameプロパティの値の拡張子に対応するレンディションタイプが設定されます。retrievalNameプロパティの値もnullの場合には，filePathプロパティの値の拡張子に対応するレンディションタイプが設定されます。この時，拡張子に対応するレンディションタイプは，レンディション定義ファイルの定義内容に従って取得されます。拡張子がレンディション定義ファイルに定義されていない場合は，レンディションタイプとしてnullが設定されます。なお，このプロパティ値にnullを指定して，さらにretrievalNameプロパティおよびfilePathプロパティの値もnullの場合には，レンディションタイプにnullが設定されます。
初期値はnullです。
retrievalNameプロパティ
登録する文書のクライアント側でのオリジナルファイル名を表します。設定したファイル名は登録文書オブジェクトのdbrProp_RetrievalNameプロパティに設定されます。
filePathプロパティに指定したフルパス中のファイル名を設定したい場合は，nullを指定します。
初期値はnullです。

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

＜この節の構成＞: 3.28.1　getFilePath（登録する文書のフルパスの取得）; 3.28.2　getIndexPath（全文検索インデクス作成用ファイルのフルパスの取得）; 3.28.3　getRenditionType（登録する文書のレンディションタイプの取得）; 3.28.4　getRetrievalName（登録する文書のファイル名の取得）; 3.28.5　renditionPropSet（レンディションプロパティ値集合の取得）; 3.28.6　setFilePath（登録する文書のフルパスの設定）; 3.28.7　setIndexPath（全文検索インデクス作成用ファイルのフルパスの設定）; 3.28.8　setRenditionPropSet（レンディションプロパティ値集合の設定）; 3.28.9　setRenditionType（登録する文書のレンディションタイプの設定）; 3.28.10　setRetrievalName（登録する文書のファイル名の設定）

3.28 DbjUploadInfoインターフェース

3.28　DbjUploadInfoインターフェース