4.9.3 定義情報ファイルの記述形式

ここでは,定義情報ファイルの記述形式について説明します。

<この項の構成>
(1) 記述規則
(2) 記述形式

(1) 記述規則

定義情報ファイルを記述する場合の規則を次に示します。

(2) 記述形式

定義情報ファイルの記述形式について説明します。

(a) addclass.csvファイル

addclass.csvファイルは次の形式に従って記述します。

クラスID,クラス名,スーパークラス名

各項目について説明します。

クラスID
追加するクラスIDをGUID形式で指定します。GUIDは,「X」を0~9およびa~f(小文字)で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX(8-4-4-4-12)」の形式で表されます。GUID値はシステム内で重複できません。なお,大文字・小文字は区別されません。指定を省略した場合,システムで自動採番されます。
クラス名
追加するクラス名を指定します。
クラス名の規則は,「4.9.2(1) サブクラス名の規則」を参照してください。この項目の指定は省略できません。
スーパークラス名
追加するクラスのスーパークラス名を指定します。なお,この項目の指定は省略できません。
サブクラスを生成できるスーパークラスを次に示します。
  • dmaClass_ConfigurationHistoryクラス
  • dmaClass_Containerクラス
  • dmaClass_DocVersionクラス
  • edmClass_ContainerVersionクラス
  • edmClass_IndependentPersistenceクラス
  • edmClass_Structクラス
  • edmClass_VersionTracedDocVersionクラス
  • edmClass_VersionTracedComponentDocVersionクラス
(b) addprop.csvファイル

addprop.csvファイルは次の形式に従って記述します。

プロパティID,プロパティ名,データ型,プロパティのデフォルト値,文字列の最大長,VariableArrayクラス名,繰り返し列の最大要素数

各項目について説明します。

プロパティID
追加するプロパティIDをGUID形式で指定します。GUIDは,「X」を0~9およびa~f(小文字)で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX(8-4-4-4-12)」の形式で表されます。GUID値はシステム内で重複できません。なお,大文字・小文字は区別されません。指定を省略した場合,システムで自動採番されます。
プロパティ名
追加するプロパティ名を指定します。
プロパティ名の規則は,「4.9.2(2) プロパティ名の規則」を参照してください。この項目の指定は省略できません。
データ型
追加するプロパティのデータ型を指定します。なお,この項目の指定は省略できません。
  • String
  • Integer
  • Boolean
  • VariableArray
  • FreeWordIndex
プロパティのデフォルト値
プロパティにデフォルト値として設定する値を指定します。指定するデータ型によって指定できる値が異なります。
  • データ型が「String」の場合
    0~255バイトの文字列を指定します。NULL値を指定したい場合は「NULL」を指定します。「文字列の最大長」に指定する最大長より大きい文字列を指定した場合,エラーとなります。
    指定を省略した場合,0バイトの文字列が仮定されます。
  • データ型が「Integer」の場合
    -2147483648~2147483647の範囲で指定します。指定を省略した場合,「0」が仮定されます。
  • データ型が「Boolean」の場合
    「0」または「1」を指定します。指定を省略した場合,「0」が仮定されます。
  • データ型が「FreeWordIndex」の場合
    0~255バイトの文字列を指定します。NULL値を指定したい場合は「NULL」を指定します。
    指定を省略した場合,0バイトの文字列が仮定されます。
上記以外のデータ型の指定値は無視されます。
文字列の最大長
文字列の最大長(バイト)を指定します。データ型に「String」,または「FreeWordIndex」を指定した場合に指定が必要です。
指定できる範囲は,データベースのデータ型に依存します。DocumentBrokerでは指定値の妥当性はチェックしません。データ型が「String」の場合はデータベースの「MVARCHAR」に対応します。「FreeWordIndex」の場合は「FREEWORD」に対応します。
VariableArrayクラス名
edmClass_Structクラスのサブクラスの名前を指定します。データ型に「VariableArray」を指定した場合に指定が必要です。
繰り返し列の最大要素数
VariableArray型のプロパティをデータベースの繰り返し列に格納する場合に指定します。データ型に「VariableArray」を指定した場合に指定が必要です。指定できる値の範囲は,2~30000です。別表に格納する場合は「-1」を指定します。
(c) addclassprop.csvファイル

addclassprop.csvファイルは次の形式に従って記述します。

クラス名,プロパティ名,デフォルト値

各項目について説明します。

クラス名
プロパティを追加するクラス名を指定します。なお,この項目の指定は省略できません。
プロパティを追加できるクラスを次に示します。
  • dmaClass_DirectContainmentRelationshipクラス
  • dmaClass_ReferentialContainmentRelationshipクラス
  • edmClass_PublicACLクラス
  • edmClass_Relationshipクラス
  • 追加したサブクラス
VariableArray型のプロパティを追加できるクラスを次に示します。
  • edmClass_IndependentPersistenceクラスのサブクラス
  • dmaClass_ConfigurationHistoryクラスのサブクラス
  • dmaClass_Containerクラスのサブクラス
  • edmClass_ContainerVersionクラスのサブクラス
  • dmaClass_DocVersionクラスのサブクラス
  • edmClass_VersionTracedDocVersionクラスのサブクラス
  • edmClass_VersionTracedComponentDocVersionクラスのサブクラス
FreeWordIndex型のプロパティを追加できるクラスを次に示します。
  • edmClass_IndependentPersistenceクラスのサブクラス
  • dmaClass_ConfigurationHistoryクラスのサブクラス
  • dmaClass_Containerクラスのサブクラス
  • edmClass_ContainerVersionクラスのサブクラス
  • dmaClass_DocVersionクラスのサブクラス
  • edmClass_VersionTracedDocVersionクラスのサブクラス
  • edmClass_VersionTracedComponentDocVersionクラスのサブクラス
全文検索インデクス用プロパティを追加できるクラスを次に示します。
  • dmaClass_DocVersionクラスのサブクラス
  • edmClass_VersionTracedDocVersionクラスのサブクラス
  • dmaClass_ConfigurationHistoryクラスのサブクラス

 

なお,クラスに全文検索インデクス用プロパティを追加した場合,次のシステムプロパティもそのクラスに追加する必要があります。追加しない場合は,エラーとなります。

プロパティ名
追加するプロパティ名を指定します。この項目の指定は省略できません。
デフォルト値
クラス固有のプロパティのデフォルト値を指定します。指定を省略した場合,addprop.csvファイルの内容が仮定されます。また,""だけが指定された場合は,addprop.csvの内容を参照しないで,空値が指定されます。