%Dictionary クラスの使用

クラス定義クラスの概要

クラス定義クラスは、Caché 統合ディクショナリにオブジェクト・アクセスと SQL アクセスを提供します。これらのクラスを使用して、クラス定義の調査、クラス定義の修正、新規クラスの生成をプログラムでできます。ドキュメントを自動生成するプログラムを記述することもできます。これらのクラスは、%Dictionary パッケージに含まれます。

クラス定義クラスには、定義クラスとコンパイル・クラスの 2 つの並列セットがあります。

定義クラス定義は、特定のクラスの定義を表します。それは、そのクラスによって定義された情報のみを含み、スーパークラスから継承された情報は含みません。ディクショナリのクラスに関する情報を提供するだけでなく、これらのクラスを使用して、プログラム的にクラス定義を変更したり新規作成できます。

コンパイル・クラス定義は、スーパークラスから継承されるクラス・メンバをすべて含みます。コンパイル・クラス定義オブジェクトは、コンパイルされたクラスからインスタンスを生成するだけです。コンパイル・クラス定義は保存できません。

この付録では、定義クラス定義のみ説明します。コンパイル・クラス定義のオペレーションも類似しています。

定義クラスを表すクラス定義のファミリには、以下のものが含まれます。

クラス定義のブラウズ

管理ポータルの SQL ページを使用すると、クラス定義クラスを参照できます。

同様に、クラス定義全体をプログラムで参照することもできます。これは、その他の種類のデータを参照するために使用するのと同じ手法を使用します。%ResultSetOpens in a new tab オブジェクトを使用して、一連のクラスを反復処理できます。また、特定のクラス定義を表す永続オブジェクトをインスタンス化できます。

例えば、Caché プロセスから、以下の %Dictionary.ClassDefinition:Summary() クエリを使用して、現在のネームスペースのディクショナリ内で定義されているすべてのクラスのリストを取得できます。

 Set result = ##class(%ResultSet).%New("%Dictionary.ClassDefinition:Summary")
 Do result.Execute()
 While (result.Next()) {
     Write result.Data("Name"),!
 }

クライアント ResultSet オブジェクトを使用して、ActiveX または Java クライアントからも容易にこのクエリを起動できます。

この %Dictionary.ClassDefinition:ClassInfo() クエリは、現在のネームスペースから見ることのできるすべてのクラス (システム・ライブラリ・クラスを含む) を返します。%Dictionary.ClassDefinition:Summary() クエリによって返されたさまざまな列を使用して、望まないクラスをフィルタできます。

特定のクラス定義に関する詳細は、そのクラスの %Dictionary.ClassDefinitionOpens in a new tab オブジェクトを開き、そのプロパティを表示することで取得できます。%Dictionary.ClassDefinitionOpens in a new tab オブジェクトを格納するための ID は、そのクラス名です。

 Set cdef = ##class(%Dictionary.ClassDefinition).%OpenId("Sample.Person")
 Write cdef.Name,!

 // get list of properties
 Set count = cdef.Properties.Count()
 For i = 1:1:count {
     Write cdef.Properties.GetAt(i).Name,!
 }

ActiveX、または Java のクライアントからも容易に行うことができます。クラス名とそのパッケージ名から成る完全記述名を指定しない場合、%OpenId() への呼び出しが失敗することに注意してください。

クラス定義の変更

%Dictionary.ClassDefinitionOpens in a new tab オブジェクトを開き、任意の変更を行い、%Save() メソッドを使用してそれを保存することで、既存のクラス定義を修正できます。

新規の %Dictionary.ClassDefinitionOpens in a new tab オブジェクトを生成し、そのプロパティを入力して保存することで、新規のクラスを生成できます。%Dictionary.ClassDefinitionOpens in a new tab オブジェクトを生成するときには、%New() コマンドでクラスの名前を渡す必要があります。クラス (プロパティやメソッド) にメンバを追加するとき、("class_name.member_name" を含む文字列を %New() コマンドに渡して) 対応する定義クラスを作成し、オブジェクトを %Dictionary.ClassDefinitionOpens in a new tab オブジェクト内の該当コレクションに追加する必要があります。

例えば以下のようになります。

 Set cdef = ##class(%Dictionary.ClassDefinition).%New("MyApp.MyClass")
 If $SYSTEM.Status.IsError(cdef)  {
     Do $system.Status.DecomposeStatus(%objlasterror,.Err)
     Write !, Err(Err)
 }
 Set cdef.Super = "%Persistent,%Populate"

 // add a Name property
 Set pdef = ##class(%Dictionary.PropertyDefinition).%New("MyClass:Name")
 If $SYSTEM.Status.IsError(pdef)  {
     Do $system.Status.DecomposeStatus(%objlasterror,.Err) 
     Write !,Err(Err)
 }
 
 Do cdef.Properties.Insert(pdef)

 Set pdef.Type="%String"

 // save the class definition object
 Do cdef.%Save()