付録A.2 DMAのクラスのプロパティ一覧

ここでは,プロパティの定義元になるDMAのクラスのプロパティのうち,Java クラスライブラリで使用できる主なプロパティの一覧を示します。

クラスごとに,次に示す項目を説明しています。

対応する文書空間オブジェクトクラス
説明するDMAのクラスと対応する文書空間オブジェクトクラスについて説明しています。
クラスの説明
クラスの特徴と機能,注意事項などについて説明しています。
スーパークラス
クラスの直上のスーパークラスを記述しています。
プロパティ一覧
プロパティの一覧表の各項目について説明します。
プロパティ名
プロパティの名前です。
データ型
プロパティ値のデータ型について記述しています。
なお,「オブジェクトリファレンス」は,DMAオブジェクトへのリファレンスを表すデータ型のプロパティです。このプロパティは,edmSQL文の中だけで使用できます。Java クラスライブラリのメソッドで扱うことはできません。

なお,DMAクラスに定義されたdmaProp_またはedmProp_で始まるプロパティには,Java クラスライブラリのメソッドで直接編集するプロパティはありません。

<この項の構成>
(1) dmaClass_ConfigurationHistoryクラスのプロパティ
(2) dmaClass_Containerクラスのプロパティ
(3) dmaClass_DirectContainmentRelationshipクラスのプロパティ
(4) dmaClass_DocVersionクラスのプロパティ
(5) dmaClass_ReferentialContainmentRelationshipクラスのプロパティ
(6) edmClass_ContainerVersionクラスのプロパティ
(7) edmClass_ContentSearchクラスのプロパティ
(8) edmClass_IndependentPersistenceクラスのプロパティ
(9) edmClass_PublicACLクラスのプロパティ
(10) edmClass_Relationshipクラスのプロパティ
(11) edmClass_VersionTraceableContainmentRelationshipクラス
(12) edmClass_VersionTracedDocVersionクラスのプロパティ

(1) dmaClass_ConfigurationHistoryクラスのプロパティ

dmaClass_ConfigurationHistoryクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
  • バージョン付きフォルダクラス
  • バージョン付き文書クラス
クラスの説明
dmaClass_ConfigurationHistoryクラスは,バージョン管理する文書のバージョン構成を保持するためのDMAクラスです。文書をバージョン管理するときの最上位に位置します。
スーパークラス
dmaClass_Containableクラス

dmaClass_ConfigurationHistoryクラスのプロパティ一覧を,次の表に示します。

表A-10 dmaClass_ConfigurationHistoryクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Parentオブジェクトリファレンス
dmaProp_ParentContainerオブジェクトリファレンス
dmaProp_VersionedDmaObjectClassオブジェクトリファレンス
dmaProp_PrimaryVersionSeriesオブジェクトリファレンス

(2) dmaClass_Containerクラスのプロパティ

dmaClass_Containerクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
バージョンなしフォルダクラス
クラスの説明
dmaClass_Containerクラスは,ほかのオブジェクトをDirectContainmentRelationshipオブジェクトまたはReferentialContainmentRelationshipオブジェクトを介して包含するためのDMAクラスです。Containerオブジェクトは直接コンテンツを持ちません。
スーパークラス
dmaClass_Containableクラス

dmaClass_Containerクラスのプロパティ一覧を,次の表に示します。

表A-11 dmaClass_Containerクラスのプロパティ一覧

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Parentオブジェクトリファレンス
dmaProp_ParentContainerオブジェクトリファレンス

(3) dmaClass_DirectContainmentRelationshipクラスのプロパティ

dmaClass_DirectContainmentRelationshipクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
リンクオブジェクトクラス
クラスの説明
dmaClass_DirectContainmentRelationshipクラスは,一つの文書空間内でのオブジェクト間の直接型リンクを規定するDMAクラスで,dmaClass_ContainmentRelationshipクラスのサブクラスです。
直接型リンクでは,Parent対Childは1:nの関係にあるため,包含されるChildに相当するオブジェクトは,dmaClass_DirectContainmentRelationshipクラスを介さないで,dmaProp_ParentContainerプロパティから,自身を包含するContainerオブジェクトを探索できます。
DocumentBrokerでは,このDMAクラスは検索できません。
スーパークラス
dmaClass_ContainmentRelationshipクラス

dmaClass_DirectContainmentRelationshipクラスのプロパティ一覧を,次の表に示します。

表A-12 dmaClass_DirectContainmentRelationshipクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Headオブジェクトリファレンス
dmaProp_Tailオブジェクトリファレンス

(4) dmaClass_DocVersionクラスのプロパティ

dmaClass_DocVersionクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
バージョンなし文書クラス
クラスの説明
dmaClass_DocVersionクラスは,文書を表現するオブジェクトのルートとなるDMAクラスです。dmaClass_VersionableクラスおよびdmaClass_Containableクラスのプロパティを継承します。したがって,文書空間では,dmaClass_DocVersionクラスまたはそのサブクラスのインスタンスをバージョン管理したり,ほかの文書と関連付けて管理したりできます。
スーパークラス
dmaClass_Versionableクラス

dmaClass_DocVersionクラスのプロパティ一覧を,次の表に示します。

表A-13 dmaClass_DocVersionクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Parentオブジェクトリファレンス
dmaProp_ParentContainerオブジェクトリファレンス
dmaProp_CurrentOfSeriesCountINT型
edmProp_RenditionsCountINT型

(5) dmaClass_ReferentialContainmentRelationshipクラスのプロパティ

dmaClass_ReferentialContainmentRelationshipクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
リンクオブジェクトクラス
クラスの説明
dmaClass_ReferentialContainmentRelationshipクラスは,文書空間内でのオブジェクト間の参照型リンクを規定するDMAクラスで,dmaClass_ContainmentRelationshipクラスのサブクラスです。
DocumentBrokerでは,このクラスは検索できません。
スーパークラス
dmaClass_ContainmentRelationshipクラス

dmaClass_ReferentialContainmentRelationshipクラスのプロパティ一覧を,次の表に示します。

表A-14 dmaClass_ReferentialContainmentRelationshipクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Headオブジェクトリファレンス
dmaProp_Tailオブジェクトリファレンス

(6) edmClass_ContainerVersionクラスのプロパティ

edmClass_ContainerVersionクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
バージョン付きフォルダクラス(バージョン付きフォルダのバージョン)
クラスの説明
edmClass_ContainerVersionクラスは,バージョン付きフォルダの機能を持ち,格納しているオブジェクトの集合全体としてのバージョンを管理するためのDMAクラスです。また,edmProp_VTContainersプロパティを保持し,ほかのバージョン付きフォルダの機能を持つオブジェクトの構成要素にもなれます。
スーパークラス
dmaClass_Versionableクラス

edmClass_ContainerVersionクラスのプロパティ一覧を,次の表に示します。

表A-15 edmClass_ContainerVersionクラス

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Parentオブジェクトリファレンス
dmaProp_ParentContainerオブジェクトリファレンス
dmaProp_CurrentOfSeriesCountINT型

(7) edmClass_ContentSearchクラスのプロパティ

edmClass_ContentSearchクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
なし。
クラスの説明
edmClass_ContentSearchクラスは,dmaClass_DocVersionクラスのサブクラスに仮想的に継承させて全文検索の対象にする文書を登録するためのDMAクラスです。edmClass_ContentSearchクラスのプロパティを仮想的に継承したdmaClass_DocVersionクラスのサブクラスでは,edmClass_ContentSearchクラスの選択可能なプロパティを検索に使用するプロパティとして指定できます。また,検索可能なプロパティであるedmProp_TextIndexプロパティ,edmProp_StIndexプロパティ,edmProp_ConceptTextIndexプロパティおよびedmProp_ConceptStIndexプロパティを指定して全文検索ができます。
スーパークラス
dmaClass_DMAクラス

edmClass_ContentSearchクラスのプロパティ一覧を,次の表に示します。

表A-16 edmClass_ContentSearchクラスのプロパティの一覧

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
edmProp_TextIndexSTR型
edmProp_StIndexSTR型
edmProp_ConceptTextIndexSTR型
edmProp_ConceptStIndexSTR型
edmProp_ScoreINT型
edmProp_RawScoreINT型
edmProp_DocLengthINT型
edmProp_ContentIndexStatusINT型

(8) edmClass_IndependentPersistenceクラスのプロパティ

edmClass_IndependentPersistenceクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
独立データクラス
クラスの説明
edmClass_IndependentPersistenceクラスは,独立して存在するオブジェクトを新たに作成するためのクラスです。DocumentBrokerでは,このクラスを継承しているサブクラスを基にして作成したオブジェクトをDMAのオブジェクトとして扱います。
DocumentBrokerで,このDMAクラスを基にサブクラスを定義する場合は,次の規則に従ってください。
クラス,プロパティの定義に関する規則
  • クラスまたはプロパティのGUIDは,DocumentBrokerが予約している値以外の値で定義します。なお,複数のクラスに同じGUIDを定義することはできません。
  • 複数のプロパティに同じGUIDを定義する場合は,プロパティ名およびプロパティの型を同じにします。
  • edmClass_IndependentPersistenceクラスで定義しているプロパティは,すべて継承します。削除はできません。
プロパティのデータ型に関する規則
定義できるプロパティのデータ型は次のとおりです。
BOOL型
INT型
STR型
VARRAY型
プロパティ値の設定および取得に関する規則
DocumentBrokerまたはユーザアプリケーションプログラムが定義するGUIDかインデクスを使用して,プロパティ値の設定または取得ができます。
スーパークラス
dmaClass_DMAクラス

edmClass_IndependentPersistenceクラスのプロパティ一覧を,次の表に示します。

表A-17 edmClass_IndependentPersistenceクラスのプロパティの一覧

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス

(9) edmClass_PublicACLクラスのプロパティ

edmClass_PublicACLクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
パブリックACLクラス
クラスの説明
edmClass_PublicACLクラスは,パブリックACLを表すオブジェクトの構成要素になるクラスです。
スーパークラス
dmaClass_DMAクラス

edmClass_PublicACLクラスのプロパティ一覧を,次の表に示します。

表A-18 edmClass_PublicACLクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_Thisオブジェクトリファレンス
edmProp_OwnerIdSTR型

(10) edmClass_Relationshipクラスのプロパティ

edmClass_Relationshipクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
リンクオブジェクトクラス
クラスの説明
edmClass_Relationshipクラスは,文書間リンクによってオブジェクト間の関連付けを設定するためのDMAクラスで,dmaClass_Relationshipクラスのサブクラスです。
スーパークラス
dmaClass_Relationshipクラス

edmClass_Relationshipクラスのプロパティ一覧を,次の表に示します。

表A-19 edmClass_Relationshipクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Headオブジェクトリファレンス
dmaProp_Tailオブジェクトリファレンス
edmProp_RelationTypeINT型

(11) edmClass_VersionTraceableContainmentRelationshipクラス

edmClass_VersionTraceableContainmentRelationshipクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
リンクオブジェクトクラス
クラスの説明
edmClass_VersionTraceableContainmentRelationshipクラスは,文書空間内でのオブジェクト間の構成管理型リンクを規定するDMAクラスで,dmaClass_ContainmentRelationshipクラスのサブクラスです。フォルダの構成要素の最新バージョンを追跡してリンクを規定したり,任意のバージョンを固定してリンクを規定したりできるプロパティを保持します。
DocumentBrokerでは,このDMAクラスは検索できません。
スーパークラス
dmaClass_ContainmentRelationshipクラス

edmClass_VersionTraceableContainmentRelationshipクラスのプロパティ一覧を,次の表に示します。

表A-20 edmClass_VersionTraceableContainmentRelationshipクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Headオブジェクトリファレンス
dmaProp_Tailオブジェクトリファレンス
edmProp_VTModeINT型
edmProp_VTVersionSeriesオブジェクトリファレンス
edmProp_VTConfigurationHistoryオブジェクトリファレンス

(12) edmClass_VersionTracedDocVersionクラスのプロパティ

edmClass_VersionTracedDocVersionクラスのプロパティについて説明します。

対応する文書空間オブジェクトクラス
バージョンなし文書クラス
クラスの説明
edmClass_VersionTracedDocVersionクラスは,構成管理型リンクで包含される文書を表現するためのDMAクラスで,dmaClass_DocVersionクラスのサブクラスです。構成管理型リンクで包含されるためのedmProp_VTContainersプロパティを保持します。
スーパークラス
dmaClass_DocVersionクラス

edmClass_VersionTracedDocVersionクラスのプロパティ一覧を,次の表に示します。

表A-21 edmClass_VersionTracedDocVersionクラスのプロパティ

プロパティ名データ型
dmaProp_OIIDSTR型
dmaProp_ClassDescriptionオブジェクトリファレンス
dmaProp_Thisオブジェクトリファレンス
dmaProp_Parentオブジェクトリファレンス
dmaProp_ParentContainerオブジェクトリファレンス
dmaProp_CurrentOfSeriesCountINT型
edmProp_RenditionsCountINT型