プロパティー記述は、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);