com.tivoli.twg.monlet
Class MonletAttributeNode

java.lang.Object
  extended bycom.tivoli.twg.monlet.MonletAttributeNode
All Implemented Interfaces:
java.io.Serializable

public class MonletAttributeNode
extends java.lang.Object
implements java.io.Serializable

This class is a contains properties of a monlet node (an attribute data node or a path node).

See Also:
Serialized Form

Field Summary
static int ATTRIBUTE_TYPE
           
protected static int BUFFER_FIXED_LEN
           
static byte COUNTER_NODEDATA
           
static int CURRENT_BUF_VERSION
           
protected  java.lang.String displayNodeName
          The variable contains a string that specifies the name of the node.
static byte DOUBLE_NODEDATA
           
static int INVALID_HANDLE
           
static byte INVALID_NODEDATA
           
protected  java.util.Locale myLocale
          default the local to the US English locale
protected  int myMonitorType
          The variable contains an int that specify the monitor type Note: the node type must be ATTRIBUTE_TYPE for this variable to have meaning
protected  int myNodeType
          The variable contains an int that specify the type of node
static int PATH_TYPE
           
protected  java.lang.String programmaticNodeName
          The variable contains a string that specifies the programatic name of the node.
static byte STRING_NODEDATA
           
static int UNKNOWN_TYPE
           
 
Constructor Summary
MonletAttributeNode(java.lang.String passedDisplayNodeName, java.lang.String passedProgrammaticNodeName, java.util.Locale passedLocale, int passedNodeType)
          This is the constructor for building the node without monitor type
MonletAttributeNode(java.lang.String passedDisplayNodeName, java.lang.String passedProgrammaticNodeName, java.util.Locale passedLocale, int passedNodeType, int passedMonitorType)
          This is the constructor for building the node with monitor type
 
Method Summary
 int getAttributeType()
          Gets the type of node the node is
 java.lang.String getDisplayName()
          Gets the Displayable Node name and return it to the caller
 java.util.Locale getLocale()
          Gets the locale information for the node
 java.lang.String getProgrammaticName()
          Gets the Program Node name and return it to the caller
 boolean isLeaf()
          Gets indication if the node is a leaf node or branch point
 void setAttributeType(int type)
          Sets the type of data stored in an attribute node
 void setNodeType(int type)
          Sets the type of node the node is
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CURRENT_BUF_VERSION

public static final int CURRENT_BUF_VERSION
See Also:
Constant Field Values

BUFFER_FIXED_LEN

protected static final int BUFFER_FIXED_LEN
See Also:
Constant Field Values

UNKNOWN_TYPE

public static final int UNKNOWN_TYPE
See Also:
Constant Field Values

ATTRIBUTE_TYPE

public static final int ATTRIBUTE_TYPE
See Also:
Constant Field Values

PATH_TYPE

public static final int PATH_TYPE
See Also:
Constant Field Values

INVALID_NODEDATA

public static final byte INVALID_NODEDATA
See Also:
Constant Field Values

DOUBLE_NODEDATA

public static final byte DOUBLE_NODEDATA
See Also:
Constant Field Values

STRING_NODEDATA

public static final byte STRING_NODEDATA
See Also:
Constant Field Values

COUNTER_NODEDATA

public static final byte COUNTER_NODEDATA
See Also:
Constant Field Values

INVALID_HANDLE

public static final int INVALID_HANDLE
See Also:
Constant Field Values

displayNodeName

protected java.lang.String displayNodeName
The variable contains a string that specifies the name of the node. The name may vary with locale


programmaticNodeName

protected java.lang.String programmaticNodeName
The variable contains a string that specifies the programatic name of the node. This name does not vary with locale


myNodeType

protected int myNodeType
The variable contains an int that specify the type of node


myMonitorType

protected int myMonitorType
The variable contains an int that specify the monitor type Note: the node type must be ATTRIBUTE_TYPE for this variable to have meaning


myLocale

protected java.util.Locale myLocale
default the local to the US English locale

Constructor Detail

MonletAttributeNode

public MonletAttributeNode(java.lang.String passedDisplayNodeName,
                           java.lang.String passedProgrammaticNodeName,
                           java.util.Locale passedLocale,
                           int passedNodeType)
This is the constructor for building the node without monitor type

Parameters:
passedDisplayNodeName - the unicode string that identifies the node for display
passedLocale - the Locale that identifies the locale for the display node name
passedNodeType - the int that identifies the type of node being created

MonletAttributeNode

public MonletAttributeNode(java.lang.String passedDisplayNodeName,
                           java.lang.String passedProgrammaticNodeName,
                           java.util.Locale passedLocale,
                           int passedNodeType,
                           int passedMonitorType)
This is the constructor for building the node with monitor type

Parameters:
passedDisplayNodeName - the unicode string that identifies the node for display
passedLocale - the Locale that identifies the locale for the display node name
passedNodeType - the int that identifies the type of node being created
passedMonitorType - the int that identifies the type of monitor the node represents
Method Detail

getDisplayName

public java.lang.String getDisplayName()
Gets the Displayable Node name and return it to the caller

Returns:
String with the displayable name for the node

getProgrammaticName

public java.lang.String getProgrammaticName()
Gets the Program Node name and return it to the caller

Returns:
String with the programatic name for the node

isLeaf

public boolean isLeaf()
Gets indication if the node is a leaf node or branch point

Returns:
boolean indicating if node is leaf or path node.

getAttributeType

public int getAttributeType()
Gets the type of node the node is

Returns:
int with monitor type encoded in it.

getLocale

public java.util.Locale getLocale()
Gets the locale information for the node

Returns:
Locale locale the display info represents for the node

setNodeType

public void setNodeType(int type)
Sets the type of node the node is

Parameters:
type - node type

setAttributeType

public void setAttributeType(int type)
Sets the type of data stored in an attribute node

Parameters:
type - attribute type

toString

public java.lang.String toString()