com.pcbsys.nirvana.nAdminAPI.nNode Class Reference

All classes that exist in the Nirvana Realm NameSpace extend this object. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nNode:
com.pcbsys.nirvana.nAdminAPI.nContainer com.pcbsys.nirvana.nAdminAPI.nDataStreamNode com.pcbsys.nirvana.nAdminAPI.nDurableNode com.pcbsys.nirvana.nAdminAPI.nLeafNode com.pcbsys.nirvana.nAdminAPI.nScheduler com.pcbsys.nirvana.nAdminAPI.nClusterNode com.pcbsys.nirvana.nAdminAPI.nDataGroupNode com.pcbsys.nirvana.nAdminAPI.nDataGroupsContainer com.pcbsys.nirvana.nAdminAPI.nLinkNode com.pcbsys.nirvana.nAdminAPI.nRealmNode com.pcbsys.nirvana.nAdminAPI.nSchedulerManager com.pcbsys.nirvana.nAdminAPI.nZoneNode

Public Member Functions

boolean equals (long aLong)
 Needed as part of the SortedObject interface.
 
synchronized String getAbsolutePath ()
 This function walks the tree to the root to generate a fully qualified name for this node. More...
 
String getName ()
 Returns the generic name of this node within the namespace. More...
 
nNode getParent ()
 Returns this nodes parent node. More...
 
String getRelativePath (nNode top) throws nAdminIllegalArgumentException
 This method returns the relative path from this node to the nNode passed. More...
 
boolean isMatch (Object item)
 Compares this object with the passed object. More...
 
boolean lessThan (long aLong)
 Needed as part of the SortedObject interface.
 
boolean lessThan (Object item)
 Compares this object with the passed object. More...
 

Detailed Description

All classes that exist in the Nirvana Realm NameSpace extend this object.

This object contains generic functions such as getName and getAboslutePath etc.

Member Function Documentation

synchronized String com.pcbsys.nirvana.nAdminAPI.nNode.getAbsolutePath ( )

This function walks the tree to the root to generate a fully qualified name for this node.

Returns
String full path and name
String com.pcbsys.nirvana.nAdminAPI.nNode.getName ( )

Returns the generic name of this node within the namespace.

Returns
String name
nNode com.pcbsys.nirvana.nAdminAPI.nNode.getParent ( )

Returns this nodes parent node.

If this node is the root it will return null

Returns
nNode of the parent
String com.pcbsys.nirvana.nAdminAPI.nNode.getRelativePath ( nNode  top) throws nAdminIllegalArgumentException

This method returns the relative path from this node to the nNode passed.

Note. It is assumed that the nNode passed is a parent node, this method will not locate nodes in different parts of the tree.

Returns
String path relative to the node passed in
boolean com.pcbsys.nirvana.nAdminAPI.nNode.isMatch ( Object  item)

Compares this object with the passed object.

Parameters
itemObject to compare against
Returns
True if they are equal
boolean com.pcbsys.nirvana.nAdminAPI.nNode.lessThan ( Object  item)

Compares this object with the passed object.

Parameters
itemObject to compare against
Returns
True if this object is less than the passed object