com.tivoli.twg.monlet
Class MonletAttrMetaData

java.lang.Object
  extended bycom.tivoli.twg.monlet.MonletAttrMetaData

public class MonletAttrMetaData
extends java.lang.Object

This class contains the properties of a monitorable attribute.


Field Summary
static int NODEDATA_DOUBLE
           
static int NODEDATA_STRING
           
 
Constructor Summary
MonletAttrMetaData()
          Default constructor Construct attribute properties container setting data type to String type
MonletAttrMetaData(int dataType, java.lang.String unitsLabel, java.lang.String formatStr, int unitsEnum, boolean enumerated)
          Constructor
 
Method Summary
 int getDataType()
          Get data type
 java.lang.String getFormatStr()
          Get formatting string
 int getUnitsEnum()
          Get units enum
 java.lang.String getUnitsLabel()
          Get units label
 boolean isEnumerated()
          Get enumerated flag
 void setDataType(int dataType)
          Set data type
 void setEnumerated(boolean val)
          Set enumerated flag
 void setFormatStr(java.lang.String formatStr)
          Set formatting string (printf-style string)
 void setUnitsEnum(int unitsEnum)
          Set units enum
 void setUnitsLabel(java.lang.String unitsLabel)
          Set units label
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NODEDATA_DOUBLE

public static final int NODEDATA_DOUBLE
See Also:
Constant Field Values

NODEDATA_STRING

public static final int NODEDATA_STRING
See Also:
Constant Field Values
Constructor Detail

MonletAttrMetaData

public MonletAttrMetaData()
Default constructor Construct attribute properties container setting data type to String type


MonletAttrMetaData

public MonletAttrMetaData(int dataType,
                          java.lang.String unitsLabel,
                          java.lang.String formatStr,
                          int unitsEnum,
                          boolean enumerated)
Constructor

Parameters:
dataType - data type for attribute - supported types are: DOUBLE_NODEDATA, STRING_NODEDATA
unitsLabel - units label
formatStr - formatting string
unitsEnum - units enum value
enumerated - enumerated flag
Method Detail

setDataType

public void setDataType(int dataType)
Set data type

Parameters:
dataType - one of the supported data types: DOUBLE_NODEDATA, STRING_NODEDATA

setUnitsLabel

public void setUnitsLabel(java.lang.String unitsLabel)
Set units label

Parameters:
unitsLabel - value to set

setFormatStr

public void setFormatStr(java.lang.String formatStr)
Set formatting string (printf-style string)

Parameters:
formatStr - value to set

setUnitsEnum

public void setUnitsEnum(int unitsEnum)
Set units enum

Parameters:
unitsEnum - value to set

setEnumerated

public void setEnumerated(boolean val)
Set enumerated flag

Parameters:
val - value to set

getDataType

public int getDataType()
Get data type

Returns:
data type

getUnitsLabel

public java.lang.String getUnitsLabel()
Get units label

Returns:
units label

getFormatStr

public java.lang.String getFormatStr()
Get formatting string

Returns:
printf-style formatting string

getUnitsEnum

public int getUnitsEnum()
Get units enum

Returns:
units enum value

isEnumerated

public boolean isEnumerated()
Get enumerated flag

Returns:
true if attribute values are enumerated, otherwise false