6.5.2 パラメタクラスのインターフェースの種類

ここでは,パラメタクラスのインターフェースの種類について説明します。

パラメタクラスのインターフェースと扱う情報との対応を,次の表に示します。

表6-3 パラメタクラスのインターフェースと扱う情報

インターフェース扱う情報
DbjACEACE
DbjCheckOutInfoチェックアウト情報
DbjContentInfoコンテンツ情報
DbjFetchInfo検索結果取得情報
DbjMappedPropXMLプロパティマッピング結果情報(XMLプロパティマッピング機能を実行して作成される情報)
DbjPropSetプロパティ値集合
DbjPublicACLIdElmパブリックACLのOIID値
DbjQParam
DbjBooleanQParamBOOL型の値を表す?パラメタ
DbjInteger32QParamINT型の値を表す?パラメタ
DbjObjQParamオブジェクトリファレンスの値を表す?パラメタ
DbjOIIDQParamOIID文字列の値を表す?パラメタ
DbjSeedDocQParam種文章を表す?パラメタ
DbjStringQParamSTR型の値を表す?パラメタ
DbjReferenceContentInfoリファレンスファイル文書のコンテンツ情報
DbjReferencePathInfoリファレンスファイル文書のパス情報
DbjReferenceUploadInfoリファレンスファイル文書のアップロード情報
DbjRenditionInfoレンディション情報
DbjRenditionListレンディション情報リスト
DbjResultSet検索結果集合
DbjSetLinkInfo
DbjSetDCRLinkInfo直接型リンク設定情報
DbjSetRelLinkInfo文書間リンク設定情報
DbjSetRCRLinkInfo参照型リンク設定情報
DbjSetVTFixLinkInfo構成管理型(構成管理モードはFIXモード)リンク設定情報
DbjSetVTFloatLinkInfo構成管理型(構成管理モードはFLOATINGモード)リンク設定情報
DbjUploadInfo文書のアップロード情報
DbjVArray可変長配列
(VARRAY型のプロパティの値)
DbjXmlUploadInfoXML文書のアップロード情報

(凡例)

-:ほかのインターフェースのスーパーインターフェースです。


<この項の構成>
(1) DbjACEインターフェース
(2) DbjCheckOutInfoインターフェース
(3) DbjContentInfoインターフェース
(4) DbjFetchInfoインターフェース
(5) DbjMappedPropインターフェース
(6) DbjPropSetインターフェース
(7) DbjPublicACLIdElmインターフェース
(8) DbjQParamインターフェース
(9) DbjReferenceContentInfoインターフェース
(10) DbjReferencePathInfoインターフェース
(11) DbjReferenceUploadInfoインターフェース
(12) DbjRenditionInfoインターフェース
(13) DbjRenditionListインターフェース
(14) DbjResultSetインターフェース
(15) DbjSetLinkInfoインターフェース
(16) DbjUploadInfoインターフェース
(17) DbjVArrayインターフェース
(18) DbjXmlUploadInfoインターフェース

(1) DbjACEインターフェース

ACEの値を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

なお,ACEは,文書空間オブジェクトのVARRAY型のプロパティの要素です。このため,ほかの文書空間オブジェクトのプロパティと同様,DbjPropSetインターフェースを使用して操作することもできます。propSetプロパティは,ACEに対応するDbjPropSetインターフェースが設定されているプロパティです。ACEをプロパティ値集合としてDbjVArrayインターフェースで扱うオブジェクト(可変長配列)に設定する場合に使用します。

このインターフェースの使用方法については,「6.9.2 ローカルACLとACEの操作」を参照してください。

(2) DbjCheckOutInfoインターフェース

チェックアウト情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

(3) DbjContentInfoインターフェース

文書のコンテンツ情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.8.9 文書のコンテンツの操作」を参照してください。

(4) DbjFetchInfoインターフェース

検索結果取得情報を扱うためのインターフェースです。検索結果取得情報は,キャッシュ付き検索実行時に,検索結果の取得方法について指定する情報です。キャッシュ付き検索は,一覧を取得するメソッドでも実行できます。

このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

なお,comparatorプロパティは,検索結果をソートするために使用するjava.util.Comparatorインターフェースです。

このインターフェースの使用方法については,「6.7.4 文書空間オブジェクトの検索」を参照してください。

(5) DbjMappedPropインターフェース

XMLプロパティマッピング結果情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

なお,バージョン付きオブジェクトの場合,classListの要素が二つになり,一つ目の要素がバージョニングオブジェクトを作成するためのDMAクラス,二つ目の要素がバージョンオブジェクトを作成するためのDMAクラスになります。

このインターフェースの使用方法については,「6.10.2 XML文書管理機能を使用する操作」を参照してください。

(6) DbjPropSetインターフェース

プロパティ値集合を扱うインターフェースです。

プロパティ値集合とは,文書空間オブジェクトのプロパティ名とそのプロパティの値のペアを要素とする集合オブジェクトです。次のような特徴があります。

このインターフェースの使用方法については,「6.8.7 文書空間オブジェクトのプロパティの操作」を参照してください。

(7) DbjPublicACLIdElmインターフェース

文書,フォルダまたは独立データがバインドしているパブリックACLを扱うインターフェースです。VARRAY型のプロパティの要素として扱います。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

なお,バインドしているパブリックACLのOIIDは,VARRAY型のプロパティ(文書空間オブジェクトのdbrProp_ACLIdElemプロパティ)の要素です。このため,ほかの文書空間オブジェクトのプロパティと同様,DbjPropSetインターフェースを使用して操作することもできます。propSetプロパティは,バインドしているパブリックACLのOIIDに対応するDbjPropSetインターフェースが設定されているプロパティです。パブリックACLのOIIDをプロパティ値集合としてDbjVArrayインターフェースで扱うオブジェクト(可変長配列)に設定する場合に使用します。

このインターフェースの使用方法については,「6.9.3 パブリックACLの操作」を参照してください。

(8) DbjQParamインターフェース

?パラメタに設定する値を扱うインターフェースのスーパーインターフェースです。このインターフェースを継承して,DocumentBrokerで扱うデータ型ごとにサブインターフェースが定義されています。

このインターフェースのサブインターフェースをデータ型として値を設定する場合,edmSQLの定数表現ではなくJava クラスライブラリで扱うデータ型に従った値を指定してください。

サブインターフェースの使用方法については,「6.7.4 文書空間オブジェクトの検索」を参照してください。

(a) DbjBooleanQParamインターフェース

BOOL型の値を?パラメタに設定するためのインターフェースです。

(b) DbjInteger32QParamインターフェース

INT型の値を?パラメタに設定するためのインターフェースです。

(c) DbjObjQParamインターフェース

オブジェクトリファレンスの値を?パラメタに設定するためのインターフェースです。指定したOIID文字列は,オブジェクトリファレンスの形式に変換されて?パラメタに設定されます。

(d) DbjOIIDQParamインターフェース

OIID文字列を?パラメタに設定するためのインターフェースです。指定したOIID文字列は,dmaProp_OIIDプロパティの格納形式(16バイト)に変換されて?パラメタに設定されます。

(e) DbjSeedDocQParamインターフェース

概念検索で?パラメタに種文章を設定するためのインターフェースです。

(f) DbjStringQParamインターフェース

STR型の値を?パラメタに設定するためのインターフェースです。

(9) DbjReferenceContentInfoインターフェース

リファレンスファイル文書のコンテンツ情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.8.12 リファレンスファイル文書の操作」を参照してください。

(10) DbjReferencePathInfoインターフェース

リファレンスファイル文書のパス情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.8.12 リファレンスファイル文書の操作」を参照してください。

(11) DbjReferenceUploadInfoインターフェース

リファレンスファイル文書のアップロード情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.8.12 リファレンスファイル文書の操作」を参照してください。

(12) DbjRenditionInfoインターフェース

レンディション情報を扱うためのインターフェースです。このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.8.11 マルチレンディション文書のレンディションの操作」を参照してください。

(13) DbjRenditionListインターフェース

レンディション情報のリストを扱うためのインターフェースです。リストの要素は,DbjRenditionInfoインターフェースです。

このインターフェースの使用方法については,「6.8.11 マルチレンディション文書のレンディションの操作」を参照してください。

(14) DbjResultSetインターフェース

検索結果集合を扱うためのインターフェースです。検索結果集合は,文書空間オブジェクトのプロパティ値を要素に持つ,行と列の二次元データにメタデータを付けたものとして表されます。

検索結果集合は,行を要素とするリストとして扱うことができます。また,各行は,文書空間オブジェクトのプロパティ値を要素とするリストとして扱うことができます。

このインターフェースの使用方法については,「6.7.4 文書空間オブジェクトの検索」を参照してください。

(15) DbjSetLinkInfoインターフェース

リンク設定情報を扱うためのスーパーインターフェースです。このインターフェースを継承して,リンク種別ごとにサブインターフェースが定義されています。

このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

サブインターフェースの使用方法については,「6.8.13 リンクの操作」を参照してください。

(a) DbjSetDCRLinkInfoインターフェース

直接型リンクを表すリンク設定情報を扱うインターフェースです。

(b) DbjSetRelLinkInfoインターフェース

文書間リンクを表すリンク設定情報を扱うインターフェースです。

(c) DbjSetRCRLinkInfoインターフェース

参照型リンクを表すリンク設定情報を扱うインターフェースです。

(d) DbjSetVTFixLinkInfoインターフェース

構成管理型リンク(構成管理モードはFIXモード)を表すリンク設定情報を扱うインターフェースです。

(e) DbjSetVTFloatLinkInfoインターフェース

構成管理型リンク(構成管理モードはFLOATINGモード)を表すリンク設定情報を扱うインターフェースです。

(16) DbjUploadInfoインターフェース

文書のアップロード情報を扱うインターフェースです。

このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.8.9 文書のコンテンツの操作」を参照してください。

(17) DbjVArrayインターフェース

VARRAY型のプロパティの値である可変長配列を扱うためのインターフェースです。

可変長配列は,DbjVArrayインターフェースを使用して,追加,削除などの更新処理を実行します。

このインターフェースは,java.util.Listインターフェースを継承しているので,可変長配列の要素はリストの要素としても扱うこともできます。ただし,DbjVArrayインターフェースで可変長配列の要素を扱うことによって,各要素がメタプロパティとして定義されているプロパティを持つことが保証されます。

このインターフェースの使用方法については,「6.8.7 文書空間オブジェクトのプロパティの操作」を参照してください。

(18) DbjXmlUploadInfoインターフェース

XML文書のアップロード情報を扱うインターフェースです。DbjUploadInfoインターフェースを継承しています。

なお,AIXの場合,DbjXmlUploadInfoインターフェースは使用できません。

このインターフェースで扱うオブジェクトは,次に示すプロパティを持っています。

このインターフェースの使用方法については,「6.10.2 XML文書管理機能を使用する操作」を参照してください。