Una descripción de propiedad es una instancia de la clase PropertyDescription.
Por qué y cuándo se efectúa esta tarea
Para añadir una descripción de propiedad a una definición de suceso, antes
debe crear una nueva descripción de propiedad y, a continuación, establecer los
valores de sus campos. A continuación, puede añadir la descripción de propiedad a la
definición de suceso.
Pasos para realizar esta tarea
- Para crear una nueva descripción de propiedad, cree una instancia de
PropertyDescription y especifique el nombre y la vía de acceso de la propiedad.
PropertyDescription propDesc = new PropertyDescription(nombre, vía de acceso);
Los parámetros de este constructor son los siguientes: - nombre
- El nombre de la propiedad. Debe ser el nombre de una propiedad simple del
elemento CommonBaseEvent o uno de sus hijos.
- vía de acceso
- Una vía de acceso de ubicación XPath que especifica la vía de acceso de la
propiedad. Para una propiedad de nivel superior de CommonBaseEvent (como
severity o priority), el valor de vía de
acceso debe ser nulo.
El objeto devuelto es un nuevo objeto
PropertyDescription.
- Llene los campos de la descripción de propiedad. La clase
PropertyDescription proporciona un método setter para cada uno de los
campos en una descripción de propiedad. Consulte la documentación de la API Javadoc para obtener información
completa sobre estos métodos. Por ejemplo,
para especificar que una propiedad es necesaria, establecería la propiedad
required en true utilizando el método setRequired(booleano):
propDesc.setRequired(true);
- Añada la descripción de propiedad a la definición de suceso utilizando el
método EventDefinition.addPropertyDescription().
definition.addPropertyDescription(propDesc);
Si la definición de suceso ya incluye otra descripción de propiedad con el mismo
nombre y la misma vía de acceso, se emitirá una excepción DescriptionExistsException.
Ejemplo
El fragmento de código siguiente crea una nueva descripción de propiedad,
la llena de datos y la añade a la definición de suceso.
PropertyDescription propDesc = new PropertyDescription("severity",null);
propDesc.setRequired(true);
propDesc.setMinValue('30');
// la definición es una definición de suceso válida
definition.addPropertyDescription(propDesc);