ilog.tgo.model

Class IltAlarmObjectStateSAXInfo

java.lang.Object

ilog.tgo.model.IltAlarmObjectStateSAXInfo

All Implemented Interfaces:

IlpSAXSerializable

public class IltAlarmObjectStateSAXInfo
extends Object
implements IlpSAXSerializable

XML serialization class for IltAlarmObjectState. This class reads and writes an IltAlarmObjectState in the following format:

 [<alarms [notReporting="true"|"false"] [lossOfConnectivity="true"|"false"]>
   [<new severity="SSS" [operation=""set"|add"|"remove"]>NNN</new>]*
   [<ack severity="SSS" [operation=""set"|add"|"remove">NNN</ack>]*
 </alarms>]
 

where:

NNN

stands for an integer number.

SSS

stands for the severity.
For example:

• Raw.Warning for the raw alarm severity Warning.
• Impact.MinorHigh for the impact alarm severity Minor High.

Note:
The form severity="Warning" is deprecated. Use severity="Raw.Warning" instead.

The operation attribute is optional and indicates if the alarms are being added, removed or set in the object state. By default, the alarms are set to the object state. This attribute is used when the alarms are set within an updateState element.

Since:

JTGO 3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALARMS_TAG

Fields inherited from interface ilog.cpl.storage.IlpSAXSerializable

EMPTY_ATTRS

Constructor Summary

Constructors

Constructor and Description
IltAlarmObjectStateSAXInfo()

Method Summary

Modifier and Type	Method and Description
IlpSAXAttributeValueHandler	getSAXHandler() Returns a SAX handler capable of reading the attribute.
void	output(Object value, IlpTypeConverter typeConverter, ContentHandler outputHandler) Outputs the value to an SAX ContentHandler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALARMS_TAG

public static final String ALARMS_TAG

See Also:

Constant Field Values

Constructor Detail

IltAlarmObjectStateSAXInfo

public IltAlarmObjectStateSAXInfo()

Method Detail

getSAXHandler

public IlpSAXAttributeValueHandler getSAXHandler()

Description copied from interface: IlpSAXSerializable

Returns a SAX handler capable of reading the attribute. The returned SAX handler should either be a new one each time this method is called, or at least there should be one instance for each thread.

Specified by:

getSAXHandler in interface IlpSAXSerializable

Returns:

A handler for SAX events.

output

public void output(Object value,
                   IlpTypeConverter typeConverter,
                   ContentHandler outputHandler)
            throws SAXException

Description copied from interface: IlpSAXSerializable

Outputs the value to an SAX ContentHandler. The method translates the object as SAX ContentHandler method calls.

Specified by:

output in interface IlpSAXSerializable

Parameters:

value - The object to output

typeConverter - The type converter that may be needed to translate values to strings.

outputHandler - The SAX ContentHandler used by this method.

Throws:

SAXException

See Also:

IlpTypeConverter.createStringValue(Class,Object)