拡張データ・エレメント記述は、クラス PropertyDescription のインスタンスです。
このタスクを実行する理由と時期
イベント定義にプロパティー記述を追加するには、先に新しいプロパティー記述を作成してから、
そのプロパティー記述のフィールドの値を設定する必要があります。これで、プロパティー記述をイベント定義に追加できます。
このタスクのステップ
- 新規プロパティー記述を作成するには、
プロパティーの名前とパスを指定して PropertyDescription のインスタンスを作成します。
PropertyDescription propDesc = new PropertyDescription(name, path);
このコンストラクターのパラメーターは、以下のとおりです。- name
- プロパティーの名前。
これは、CommonBaseEvent エレメントまたはその子エレメントのいずれかの、単純プロパティーの名前でなければなりません。
- path
- プロパティーへのパスを指定する XPath ロケーション・パス。CommonBaseEvent (severity や priority など) のトップレベル・プロパティーの場合、path はヌルにする必要があります。
戻されるオブジェクトは、新しい PropertyDescription オブジェクトです。
- プロパティー記述のフィールドにデータを取り込みます。 PropertyDescription クラスは、
プロパティー記述の各フィールドに setter メソッドを提供します。
これらのメソッドについて詳しくは、Javadoc API の資料を参照してください。 例えば、プロパティーが必須であることを指定するには、setRequired(boolean) メソッドを使用して required プロパティーを true に設定します。
propDesc.setRequired(true);
- EventDefinition.addPropertyDescription() メソッドを使用して、イベント定義にプロパティー記述を追加します。
definition.addPropertyDescription(propDesc);
イベント定義に、同じ名前とパスを持つ別のプロパティー記述が既に含まれている場合は、
DescriptionExistsException 例外がスローされます。
次のコード・フラグメントは、新しいプロパティー記述を作成し、作成した記述にデータを取り込み、
その記述をイベント定義に追加します。
PropertyDescription propDesc = new PropertyDescription("severity",null);
propDesc.setRequired(true);
propDesc.setMinValue('30');
// definition is a valid event definition
definition.addPropertyDescription(propDesc);