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.client.Observable com.pcbsys.nirvana.nAdminAPI.nContainer com.pcbsys.nirvana.nAdminAPI.nDataStreamNode com.pcbsys.nirvana.nAdminAPI.nLeafNode 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

Public Member Functions

bool Equals (long aLong)
 Needed as part of the SortedObject interface. More...
 
override bool Equals (object item)
 Compares this object with the passed object More...
 
virtual string getAbsolutePath ()
 This function walks the tree to the root to generate a fully qualified name for this node More...
 
virtual nNode getParent ()
 Returns this nodes parent node. More...
 
virtual string getRelativePath (nNode top)
 This method returns the relative path from this node to the nNode passed. More...
 
virtual bool lessThan (long aLong)
 Needed as part of the SortedObject interface. More...
 
virtual bool lessThan (object item)
 Compares this object with the passed object. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void addObserver (IObserver o)
 Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...
 
int countObservers ()
 Returns the number of observers of this Observable object. More...
 
void deleteObserver (IObserver o)
 Deletes an observer from the set of observers of this object. More...
 
void deleteObservers ()
 Clears the observer list so that this object no longer has any observers. More...
 
bool hasChanged ()
 Tests if this object has changed. More...
 
void notifyObservers ()
 If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More...
 
void notifyObservers (Object arg)
 If this object has changed, as indicated by the More...
 
 Observable ()
 Construct an Observable with zero Observers. More...
 

Properties

virtual string Name [get]
 Returns the generic name of this node within the namespace More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void clearChanged ()
 Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More...
 
void setChanged ()
 Marks this Observable object as having been changed; the hasChanged method will now return true. 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

bool com.pcbsys.nirvana.nAdminAPI.nNode.Equals ( long  aLong)

Needed as part of the SortedObject interface.

override bool com.pcbsys.nirvana.nAdminAPI.nNode.Equals ( object  item)

Compares this object with the passed object

Parameters
itemObject to compare against
Returns
True if they are equal
virtual string com.pcbsys.nirvana.nAdminAPI.nNode.getAbsolutePath ( )
virtual

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

Returns
String full path and name

Reimplemented in com.pcbsys.nirvana.nAdminAPI.nLeafNode.

virtual nNode com.pcbsys.nirvana.nAdminAPI.nNode.getParent ( )
virtual

Returns this nodes parent node.

If this node is the root it will return null

Returns
nNode of the parent
virtual string com.pcbsys.nirvana.nAdminAPI.nNode.getRelativePath ( nNode  top)
virtual

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
virtual bool com.pcbsys.nirvana.nAdminAPI.nNode.lessThan ( long  aLong)
virtual

Needed as part of the SortedObject interface.

virtual bool com.pcbsys.nirvana.nAdminAPI.nNode.lessThan ( object  item)
virtual

Compares this object with the passed object.

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

Property Documentation

virtual string com.pcbsys.nirvana.nAdminAPI.nNode.Name
get

Returns the generic name of this node within the namespace

Returns
String name