付録B.2 プロパティの説明

ここでは,それぞれのプロパティについて説明します。

<この項の構成>
(1) dmaProp_Childrenプロパティ
(2) dmaProp_ClassDescriptionプロパティ
(3) dmaProp_Containeesプロパティ
(4) dmaProp_Containersプロパティ
(5) dmaProp_ContentElementsプロパティ
(6) dmaProp_ContentElementsPresentプロパティ
(7) dmaProp_CurrentOfSeriesCountプロパティ
(8) dmaProp_Headプロパティ
(9) dmaProp_OIIDプロパティ
(10) dmaProp_Parentプロパティ
(11) dmaProp_ParentContainerプロパティ
(12) dmaProp_PrimaryVersionSeriesプロパティ
(13) dmaProp_Renditionsプロパティ
(14) dmaProp_RenditionsPresentプロパティ
(15) dmaProp_RenditionTypeプロパティ
(16) dmaProp_Tailプロパティ
(17) dmaProp_Thisプロパティ
(18) dmaProp_VersionDescriptionsプロパティ
(19) dmaProp_VersionedObjectClassプロパティ
(20) edmProp_ConceptStIndexプロパティ
(21) edmProp_ConceptTextIndexプロパティ
(22) edmProp_Contentプロパティ(Version 1との互換用)
(23) edmProp_ContentIndexStatusプロパティ
(24) edmProp_DocLengthプロパティ
(25) edmProp_DocVersionOIIDプロパティ
(26) edmProp_OwnerIdプロパティ
(27) edmProp_RawScoreプロパティ
(28) edmProp_RelationTypeプロパティ
(29) edmProp_RenditionsCountプロパティ
(30) edmProp_Scoreプロパティ
(31) edmProp_StIndexプロパティ
(32) edmProp_TextIndexプロパティ
(33) edmProp_VTContaineesプロパティ
(34) edmProp_VTContainersプロパティ
(35) edmProp_VTConfigurationHistoryプロパティ
(36) edmProp_VTModeプロパティ
(37) edmProp_VTVersionSeriesプロパティ

(1) dmaProp_Childrenプロパティ

ContainerオブジェクトまたはContainerVersionオブジェクトが直接含むContainableオブジェクトとの包含関係を表すDirectContainmentRelationshipオブジェクトのリストです。DirectContainmentRelationshipオブジェクトは,ContainerオブジェクトとそのChildに相当するオブジェクトとの関連を表します。DirectContainmentRelationshipオブジェクトのdmaProp_TailプロパティのReflectiveプロパティです。

(2) dmaProp_ClassDescriptionプロパティ

オブジェクトの基になっているクラスについて定義するClassDescriptionオブジェクトです。

オブジェクトに対して,オブジェクトの基になるクラスについての定義情報へのアクセスを提供します。

(3) dmaProp_Containeesプロパティ

ContainerオブジェクトまたはContainerVersionオブジェクトが参照的に含むContainableオブジェクトとの包含関係を表すReferentialContainmentRelationshipオブジェクトのリストです。ReferentialContainmentRelationshipオブジェクトは,ContainerオブジェクトとContaineeに相当するオブジェクトとの関連を表します。

(4) dmaProp_Containersプロパティ

指定したオブジェクトを参照型で包含しているContainerオブジェクトを識別するReferentialContainmentRelationshipオブジェクトのリストです。

(5) dmaProp_ContentElementsプロパティ

Renditionオブジェクトに含まれるContentTransferオブジェクト,ContentTransfersオブジェクトまたはContentReferenceオブジェクトのリストです。

一つのRenditionオブジェクトに対してコンテントは,一つです。複数のコンテントをリストの要素としようとすると,インデクスが0だけがコンテントになります。

(6) dmaProp_ContentElementsPresentプロパティ

コンテントが属しているDocVersionオブジェクトを最後に永続化した時点でContentTransferオブジェクト,ContentTransfersオブジェクトまたはContentReferenceオブジェクトのdmaProp_ComponentTypeプロパティが保持していた文字列のリストです。

DocumentBrokerが値を設定します。クライアントがこのプロパティの値を操作すると,実際の永続オブジェクトの状態と不一致となるので,操作しないでください。

dmaProp_ContentElementsPresentプロパティは,dmaProp_ContentElementsプロパティのリストの状態を動的に追跡しません。したがって,dmaProp_ContentElementsPresentプロパティとdmaProp_ContentElementsプロパティの値は等しくない場合もあります。

Renditionオブジェクトが属しているDocVersionオブジェクトに再接続した時点またはDocVersionオブジェクトのscratchpadオブジェクトを永続オブジェクトの状態に更新した時点で,dmaProp_ContentElementsPresentプロパティとdmaProp_ContentElementsプロパティは,同期します。

(7) dmaProp_CurrentOfSeriesCountプロパティ

VersionSeriesオブジェクトに最新バージョンとしてチェックインした文書オブジェクト(DocVersionオブジェクト)に対してDocumentBrokerが付与する番号です。

クラスライブラリでは,そのオブジェクトのバージョンの状態を明確にするために,次の値を設定します。

表B-16 クラスライブラリで設定するdmaProp_CurrentOfSeriesCountプロパティの値

DocVersionオブジェクトの状態dmaProp_CurrentOfSeriesCountプロパティに設定される値
CdbrVersionableDocumentオブジェクトのカレントバージョンに対応するDocVersionオブジェクト1
チェックアウト中のDocVersionオブジェクト-2
チェックイン後のDocVersionオブジェクトチェックインによって追加されたDocVersionオブジェクト1
チェックインによって旧バージョンになったDocVersionオブジェクト0
バージョン管理の対象でないCdbrDocumentオブジェクトに包含されるDocVersionオブジェクト-1

クライアントは,このプロパティの値の整合性を維持するために,すでに存在する文書オブジェクト(DocVersionオブジェクト)をチェックインする場合,その文書オブジェクトに編集可能なロック(writeロック)を設定して矛盾が起きないように注意してください。

(8) dmaProp_Headプロパティ

関連づけられた二つのオブジェクトのうち,Head(関連の終点)側のオブジェクトです。例えば,コンテインメントでは,包含される側のオブジェクトです。

このプロパティは,コンテインメントやリレーションのプロパティです。クラスライブラリでは,コンテインメントやリレーションが設定されているオブジェクトのdmaProp_Thisプロパティとこのプロパティを組み合わせて,検索実行時に検索対象クラスを結合する場合に利用できます。

(9) dmaProp_OIIDプロパティ

オブジェクトを識別する識別子です。

(10) dmaProp_Parentプロパティ

このオブジェクトを直接型で包含しているParentに相当するオブジェクトを識別するDirectContainmentRelationshipオブジェクトです。

(11) dmaProp_ParentContainerプロパティ

DirectContainmentRelationshipオブジェクトを介してこのオブジェクトを包含しているContainerオブジェクトです。

クライアントは,このdmaProp_ParentContainerプロパティによって,介在するDirectContainmentRelationshipオブジェクトを参照することなく,直接Parentに相当するContainerオブジェクトを探索できます。

DocumentBrokerでは,このプロパティによる探索を許可します。

(12) dmaProp_PrimaryVersionSeriesプロパティ

バージョン管理する文書に対する最初のVersionSeriesオブジェクトです。

ConfigurationHistoryオブジェクトに,最初にVersionSeriesオブジェクトがバインドされるときに値が設定されます。

(13) dmaProp_Renditionsプロパティ

DocVersionオブジェクトが保持するRenditionオブジェクトのリストです。

(14) dmaProp_RenditionsPresentプロパティ

DocVersionオブジェクトを最後に永続化した時点でDocVersionオブジェクトのdmaProp_RenditionTypeプロパティが保持していた値のリストです。

DocVersionオブジェクトに接続すると,DocumentBrokerが値を設定します。

dmaProp_RenditionsPresentプロパティは,dmaProp_Renditionsプロパティのリストの状態を動的に追跡しません。したがって,dmaProp_RenditionsPresentプロパティとdmaProp_RenditionTypeプロパティの値は等しくない場合があります。

DocVersionオブジェクトに再接続した時点またはDocVersionオブジェクトのscratchpadオブジェクトを永続オブジェクトの状態に更新した時点で,dmaProp_RenditionsPresentプロパティとdmaProp_Renditionsプロパティの値は同期します。

(15) dmaProp_RenditionTypeプロパティ

コンテントの表現形式を表す文字列です。

文字列の形式は次のようになります。

<rendition_type_space>::<typename>

DocumentBrokerでは,rendition_type_spaceにIANAで定義しているMIMEを使用します。表現形式がプレーンテキストの場合,次のように指定します。

MIME::text/plain

クラスライブラリでは,次のオブジェクトのdbrProp_RenditionTypeプロパティとして操作します。

(16) dmaProp_Tailプロパティ

関連づけられた二つのオブジェクトのうち,Tail(関連の始点)側のオブジェクトです。例えば,コンテインメントでは,包含する側のオブジェクトです。

このプロパティは,コンテインメントやリレーションのプロパティです。クラスライブラリでは,コンテインメントやリレーションが設定されているオブジェクトのdmaProp_Thisプロパティとこのプロパティを組み合わせて,検索実行時に検索対象クラスを結合する場合に利用できます。

(17) dmaProp_Thisプロパティ

オブジェクト自身です。

問い合わせの中で,オブジェクト間の関連を表現して,問い合わせの結果の中から候補のオブジェクトを選択するために使用できます。

クラスライブラリでは,コンテインメントやリレーションのdmaProp_HeadプロパティやdmaProp_Tailプロパティとこのプロパティを組み合わせて,検索実行時に検索対象クラスを結合する場合に利用できます。

(18) dmaProp_VersionDescriptionsプロパティ

バージョン管理する文書と特定のVersionSeriesオブジェクトとを結び付けるVersionDescriptionオブジェクトのリストです。

文書をバージョン管理する場合にだけ必要となります。

(19) dmaProp_VersionedObjectClassプロパティ

バージョン管理する文書のベースとなるクラスについて定義するClassDescriptionオブジェクトです。

バージョン管理する文書は,すべてこのプロパティのClassDescriptionオブジェクトが定義するクラスを基に作成される必要があります。

DocumentBrokerでは,このプロパティに設定されたClassDescriptionオブジェクトで,バージョン管理する文書のオブジェクトであるかどうかを確認しません。このプロパティの値は,あらかじめDocumentBrokerサーバのメタ情報ファイル(edms.ini)に設定してください。DocumentBrokerサーバのメタ情報ファイルについては,マニュアル「DocumentBroker Version 3 システム導入・運用ガイド」を参照してください。

(20) edmProp_ConceptStIndexプロパティ

全文検索用に登録した文書の全文データです。

このプロパティは,全文検索エンジンに対して,全文検索用の登録情報を参照することを示すためにあります。したがって,SELECT句に検索結果として取得するプロパティには指定できません。

このプロパティでは,概念検索および構造指定検索を含む全文検索が実行できます。

(21) edmProp_ConceptTextIndexプロパティ

全文検索用に登録した文書の全文データです。

このプロパティは,全文検索エンジンに対して,全文検索用の登録情報を参照することを示すためにあります。したがって,SELECT句に検索結果として取得するプロパティには指定できません。

このプロパティでは,概念検索を含む全文検索が実行できます。

(22) edmProp_Contentプロパティ(Version 1との互換用)

全文検索用に登録した文書の全文データです。

このプロパティは,全文検索エンジンに対して,全文検索用の登録情報を参照することを示すためにあります。したがって,SELECT句に検索結果として取得するプロパティには指定できません。

このプロパティでは,構造指定検索を含む全文検索が実行できます。

(23) edmProp_ContentIndexStatusプロパティ

全文検索インデクスの登録状態を示します。設定される値は次のとおりです。

表B-17 edmProp_ContentIndexStatusプロパティに設定される値

意 味
0文書は未登録です。
1文書は登録されていますが,全文検索インデクスは未登録です。
2文書および全文検索インデクスが登録されています。
3文書が更新されていますが,全文検索インデクスが更新されていないため,文書と全文検索インデクスの内容が一致しません。
100以降DocumentBroker Text Search Index Loader Version 2が使用する値です。

(24) edmProp_DocLengthプロパティ

検索した文書の長さです。

バイト単位で示します。

(25) edmProp_DocVersionOIIDプロパティ

全文検索用に登録したDocVersionオブジェクトのOIIDです。

(26) edmProp_OwnerIdプロパティ

オブジェクトの所有者を表す文字列です。

クラスライブラリでは,dbrProp_OwnerIdプロパティとして扱います。ただし,検索条件に指定する場合は,「edmProp_OwnerId」と指定します。

(27) edmProp_RawScoreプロパティ

ランキング検索した場合のスコアです。

検索する時に算出されて値が設定されます。ランキング検索時のスコアを取得するための形式的なプロパティです。スコアは,検索結果集合内で正規化されずに返されます。

(28) edmProp_RelationTypeプロパティ

Relationshipオブジェクトを使用した関連の種類を定義します。ユーザプログラムで任意に設定できますが,0以下の値は設定できません。

(29) edmProp_RenditionsCountプロパティ

一つの文書中に登録されているレンディションの数を表すカウンタです。マスタレンディションだけが登録されている場合,値は常に1になります。サブレンディションが登録されると,マスタレンディションと登録されたサブレンディションの数を合わせた値になります。

(30) edmProp_Scoreプロパティ

ランキング検索した場合のスコアです。

検索する時に算出されて値が設定されます。ランキング検索時のスコアを取得するための形式的なプロパティです。スコアは,検索結果集合内で正規化されて返されます。

(31) edmProp_StIndexプロパティ

全文検索用に登録した文書の全文データです。

このプロパティは,全文検索エンジンに対して,全文検索用の登録情報を参照することを示すためにあります。したがって,SELECT句に検索結果として取得するプロパティには指定できません。

このプロパティでは,構造指定検索を含む全文検索が実行できます。

(32) edmProp_TextIndexプロパティ

全文検索用に登録した文書の全文データです。

このプロパティは,全文検索エンジンに対して,全文検索用の登録情報を参照することを示すためにあります。したがって,SELECT句に検索結果として取得するプロパティには指定できません。

このプロパティでは,プレーンテキストに対する全文検索が実行できます。

(33) edmProp_VTContaineesプロパティ

ContainerVersionオブジェクトが構成管理の対象として含むContainableオブジェクトとの包含関係を表すVersionTraceableContainmentRelationshipオブジェクトのリストです。

(34) edmProp_VTContainersプロパティ

ContainerVersionオブジェクトが構成管理の対象として含まれる上位のContainerとの包含関係を表すVersionTraceableContainmentRelationshipオブジェクトのリストです。

(35) edmProp_VTConfigurationHistoryプロパティ

VersionTraceableContainmentRelationshipオブジェクトが指している包含される側のオブジェクトのバージョンを統合しているConfigurationHistoryオブジェクトです。

(36) edmProp_VTModeプロパティ

包合するオブジェクトの最新バージョンを追跡するか(FLOATINGモード),バージョンを固定するか(FIXモード)を設定します。

(37) edmProp_VTVersionSeriesプロパティ

VersionTraceableContainmentRelationshipオブジェクトが指している包含される側のオブジェクトのバージョンを管理しているVersionSeriesオブジェクトです。