內容說明是 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.addPropertyDescription(propDesc);