uCosminexus DocumentBroker Version 5 リファレンス API

[目次][用語][索引][前へ][次へ]

5.5 DbjConvertContentInfoインターフェース

DbjConvertContentInfoインターフェースは,コンテンツ変換機能を使用した文書のコンテンツ種別の変換時に使用するコンテンツ情報を扱うインターフェースです。

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

表5-4 DbjConvertContentInfoインターフェースで扱うプロパティ

プロパティ名 データ型 getterメソッド setterメソッド
convertType int型 getConvertType setConvertType
executeMode int型 getExecuteMode setExecuteMode
sourceScope int型 getSourceScope setSourceScope
renditionType String型 getRenditionType setRenditionType
investMode int型 getInvestMode setInvestMode
renditionComment String型 getRenditionComment setRenditionComment
referenceTargetPath String型 getReferenceTargetPath setReferenceTargetPath
changeMaster boolean型 isChangeMaster setChangeMaster
checkRenditionStatus boolean型 isCheckRenditionStatus setCheckRenditionStatus
investSourceComment boolean型 isInvestSourceComment setInvestSourceComment
プロパティ詳細
  • convertTypeプロパティ
    変換する文書の変換先コンテンツ種別を設定します。
    初期値はDbjDef.CONTENTTYPE_REFERENCE(シングルファイル文書をリファレンス文書に変換する)です。
  • executeModeプロパティ
    変換する文書の変換元レンディションを残すかどうかの変換モードを設定します。
    初期値はDbjConvertDef.EXECUTEMODE_REPLACE(変換元のレンディションを残さない)です。
  • sourceScopeプロパティ
    変換対象とするレンディションの範囲を設定します。
    初期値はDbjConvertDef.SOURCESCOPE_ALL(すべてのレンディションを変換対象とする)です。
  • changeMasterプロパティ
    executeModeプロパティにDbjConvertDef.EXECUTE_VERBOSE(変換する文書の変換元レンディションを残す)を指定した場合で,マスタレンディションを変換するときに,変換後のレンディションをマスタレンディションに変更するかどうかを設定します。
    初期値はtrue(変換後のレンディションをマスタレンディションに変更する)です。
  • renditionTypeプロパティ
    sourceScopeプロパティにDbjConvertDef.SOURCESCOPE_SEPARATE(renditionTypeプロパティで指定したレンディションを変換対象とする)を指定した場合に,変換の対象とするレンディションタイプを設定します。
    sourceScopeプロパティにDbjConvertDef.SOURCESCOPE_SEPARATE以外が指定された場合は,このプロパティの指定は無視されます。
    初期値はnull(マスタレンディション)です。
  • checkRenditionStatusプロパティ
    変換対象のレンディションのステータスをチェックするかどうかを設定します。
    初期値はfalse(レンディションステータスをチェックしません)です。
  • investSourceCommentプロパティ
    renditionCommentプロパティで指定するレンディションコメントを変換前のレンディションに付与するか,変換後のレンディションに付与するかを設定します。初期値はfalse(変換後のレンディションにコメントを付与する)です。
  • investModeプロパティ
    コメントの付与方式を設定します。
    初期値はDbjConvertDef.INVESTMODE_REPLACE(コメント部分を指定したコメントで置き換える)です。
  • renditionCommentプロパティ
    レンディションに付与するレンディションコメントを設定します。
  • referenceTargetPathプロパティ
    コンテンツの登録先となるサーバマシン上のディレクトリのパスを設定します。
    初期値はnullです。
<この節の構成>
5.5.1 getConvertType(変換先コンテンツ種別の取得)
5.5.2 getExecuteMode(変換モードの取得)
5.5.3 getSourceScope(変換対象レンディション範囲の取得)
5.5.4 getRenditionType(変換対象レンディションタイプの取得)
5.5.5 getInvestMode(コメント付与方式の取得)
5.5.6 getRenditionComment(レンディションコメントの取得)
5.5.7 getReferenceTargetPath(コンテンツ登録先ディレクトリパスの取得)
5.5.8 isChangeMaster(変換後のレンディション種別取得)
5.5.9 isCheckRenditionStatus(レンディションステータスのチェックの取得)
5.5.10 isInvestSourceComment(レンディションコメントの付与箇所の取得)
5.5.11 setConvertType(変換先コンテンツ種別の設定)
5.5.12 setExecuteMode(変換モードの設定)
5.5.13 setSourceScope(変換対象レンディション範囲の設定)
5.5.14 setRenditionType(変換対象レンディションタイプの設定)
5.5.15 setInvestMode(コメント付与方式の設定)
5.5.16 setRenditionComment(レンディションコメントの設定)
5.5.17 setReferenceTargetPath(コンテンツ登録先ディレクトリパスの設定)
5.5.18 setChangeMaster(変換後のレンディション種別設定)
5.5.19 setCheckRenditionStatus(レンディションステータスのチェックの設定)
5.5.20 setInvestSourceComment(レンディションコメントの付与箇所の設定)