ilog.tgo.model

Class IltOSIObjectStateSAXInfo

java.lang.Object

ilog.tgo.model.IltObjectStateSAXInfo

ilog.tgo.model.IltOSIObjectStateSAXInfo

All Implemented Interfaces:

IlpSAXSerializable

public class IltOSIObjectStateSAXInfo
extends IltObjectStateSAXInfo

XML serialization class for IltOSIObjectState.

This class lets you read and write an IltOSIObjectState in the following format:

  [<state>
    <administrative>AAA</administrative>
    <operational>OOO</operational>
    <usage>UUU</usage>
  </state>]
  [<procedural [operation="add"|"remove"]>ppp</procedural>]*
  [<availability [operation="add"|"remove"]>aaa</availability>]*
  [<control [operation="add"|"remove"]>ccc</control>]*
  [<standby [operation="add"|"remove"]>sss</standy>]*
  [<repair [operation="add"|"remove"]>rrr</repair>]*
 

Where, for the states:

AAA

stands for the administrative state value, such as Locked.

OOO

stands for the operational state value, such as Enabled.

UUU

stands for the usage state value, such as Idle.

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

For the list of possible state values, see section Graphical Representation of OSI States in the User's Manual.

For the statusesAdd:

ppp

stands for the name of a procedural status, such as Initializing.

aaa

stands for the name of an availability status, such as Degraded.

ccc

stands for the name of a control status, such as ReservedForTest.

sss

stands for the name of a standby status, such as InStandby.

rrr

stands for the name of a repair status, such as UnderRepair.

For the list of possible statusesAdd, see the section Graphical Representation of OSI Statuses in the User's Manual.

The format may also contain the elements described in the common object state format (IltObjectStateSAXInfo).

Since:

JTGO 3.0

Field Summary

Fields inherited from class ilog.tgo.model.IltObjectStateSAXInfo

ALARMS_TAG, MISC_TAG, PERFORMANCE_TAG, SAN_TAG, TRAPS_TAG

Fields inherited from interface ilog.cpl.storage.IlpSAXSerializable

EMPTY_ATTRS

Constructor Summary

Constructors

Constructor and Description
IltOSIObjectStateSAXInfo()

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

Constructor Detail

IltOSIObjectStateSAXInfo

public IltOSIObjectStateSAXInfo()

Method Detail

getSAXHandler

public IlpSAXAttributeValueHandler getSAXHandler()

Description copied from class: IltObjectStateSAXInfo

Returns a SAX handler capable of reading the attribute. To avoid an instance of SAX handler to be used simultaneously by two concurrent threads, this method should either return a new instance of SAX handler each time it is called or take advantage of the java.lang.ThreadLocal class to return a different instance for each thread.

Specified by:

getSAXHandler in interface IlpSAXSerializable

Specified by:

getSAXHandler in class IltObjectStateSAXInfo

Returns:

A SAX event handler.

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

Overrides:

output in class IltObjectStateSAXInfo

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)