属性描述是类 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);