AdventNet Web NMS 4 API Specification

com.adventnet.nms.fe.common
Class PanelTreeNode

java.lang.Object
  |
  +--com.adventnet.nms.fe.common.PanelTreeNode
All Implemented Interfaces:
java.io.Serializable

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

A class which holds data related to Tree node . PanelTreeNode contains data representing PanelTree and PanelProps table which forms the source for Tree construction in the client.Contents of PanelTreeNode can be explained with help of small example . Let us take a tree structure with Parent as root node and it has three child's namly child1, child2,and child3 The position of child under the given parent is represented by nodeIndex and previousNode.

nodeIndex : Is a positive integer representing the position of child under the given parent. In the example, Child1 has nodeIndex value 0 and Child3 has nodeIndex value 2

previousNode: Represents the Node that is previous to it under a given parent. This first child under a given parent has previousNode value "START". In the example, child1 has previousNode value "START". Child2 has previousNode value 'Child1'. If previousNode and NodeIndex is given in PanelTreeNode previousNode value takes precedence.

panelProperties contains attribute key and value for the given node example "ICON-FILE" and its value.ModuleName defines table name where user defined values can be stored.ViewProperties contains attributes to be stored in the userDefined table Default values set are userName='All',nodeIndex='-1' and moduleName='Default'. These default values will be overwritten when user uses corresponding Set methods to set the value.

Since:
Web NMS 2.3
See Also:
Serialized Form

Constructor Summary
PanelTreeNode(java.lang.String nodeId)
          Constructor for creating an instance .
 
Method Summary
 java.lang.String getModuleName()
          Get the value of moduleName
 java.lang.String getNodeId()
          Get the value of NodeId
 int getNodeIndex()
          Get the value of nodeIndex
 java.lang.String getNodeType()
          Get the value of nodeType
 java.util.Properties getPanelProperties()
          get the value of panelProperties
 java.lang.String getParent()
          Get the value of parent
 java.lang.String getPreviousNode()
          Get the value of getPreviousNode
 java.lang.String getUserName()
          Get the value of userName
 java.util.Properties getViewProperties()
          get the value of viewProperties
 void setModuleName(java.lang.String moduleName)
          Set the value of moduleName
 void setNodeIndex(int nodeIndex)
          Set the value of nodeIndex
 void setNodeType(java.lang.String nodeType)
          Set the value of nodeType
 void setPanelProperties(java.util.Properties p)
          Set the value of panelProperties
 void setParent(java.lang.String parent)
          Set the value of Parent
 void setPreviousNode(java.lang.String prevNode)
          Set the value of PreviousNode
 void setUserName(java.lang.String user)
          Set the value of userName
 void setViewProperties(java.util.Properties p)
          Set the value of viewProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PanelTreeNode

public PanelTreeNode(java.lang.String nodeId)
Constructor for creating an instance . The nodeId needs to be passed on as a parameter. In the constructor default value for nodeIndex is set to -1 and moduleName as "Default"
Parameters:
nodeId - a String nodeId for which the operation is performed.
Method Detail

setUserName

public void setUserName(java.lang.String user)
Set the value of userName
Parameters:
userName - a String Value to assign to userName.

getUserName

public java.lang.String getUserName()
Get the value of userName
Returns:
userName a String value of userName.

getNodeId

public java.lang.String getNodeId()
Get the value of NodeId
Returns:
nodeId a String value of nodeId.

setNodeType

public void setNodeType(java.lang.String nodeType)
Set the value of nodeType
Parameters:
nodeType - a String Value to assign to userName.

getNodeType

public java.lang.String getNodeType()
Get the value of nodeType
Returns:
nodeType a String value of nodeType.

setNodeIndex

public void setNodeIndex(int nodeIndex)
Set the value of nodeIndex
Parameters:
nodeIndex - a int Value to assign to nodeIndex.

getNodeIndex

public int getNodeIndex()
Get the value of nodeIndex
Returns:
nodeIndex a int value of nodeIndex.

setParent

public void setParent(java.lang.String parent)
Set the value of Parent
Parameters:
parent - a String Value to assign to parent.

getParent

public java.lang.String getParent()
Get the value of parent
Returns:
parent a String value of parent

getModuleName

public java.lang.String getModuleName()
Get the value of moduleName
Returns:
moduleName a String value of moduleName

setModuleName

public void setModuleName(java.lang.String moduleName)
Set the value of moduleName
Parameters:
moduleName - a String Value to assign to moduleName.The value will overwrite the the default value.

setPreviousNode

public void setPreviousNode(java.lang.String prevNode)
Set the value of PreviousNode
Parameters:
prevNode - a String Value to assign to previousNode.The value will overwrite the the default value.

getPreviousNode

public java.lang.String getPreviousNode()
Get the value of getPreviousNode
Returns:
previousNode a String value of previousNode

getPanelProperties

public java.util.Properties getPanelProperties()
get the value of panelProperties
Returns:
panelProperties

setPanelProperties

public void setPanelProperties(java.util.Properties p)
Set the value of panelProperties
Parameters:
p - Value to assign to panelProperties

getViewProperties

public java.util.Properties getViewProperties()
get the value of viewProperties
Returns:
viewProperties

setViewProperties

public void setViewProperties(java.util.Properties p)
Set the value of viewProperties
Parameters:
p - Value to assign to viewProperties

AdventNet Web NMS 4 API Specification