Simias::Storage::LinkNode Class Reference

Represents an object that can be used as an alias to a Node object. More...

Inheritance diagram for Simias::Storage::LinkNode:

Inheritance graph
[legend]
Collaboration diagram for Simias::Storage::LinkNode:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 LinkNode (string name, Relationship relationship)
 Constructor used to create a new LinkNode object.
 LinkNode (string name, string nodeID, Relationship relationship)
 Constructor used to create a new LinkNode object with a specified ID.
 LinkNode (Node node)
 Constructor for creating an existing LinkNode object.
 LinkNode (Collection collection, ShallowNode shallowNode)
 Constructor that creates a LinkNode object from a ShallowNode object.
Node GetReference (Store store)
 Gets the Node referenced by this LinkNode object.


Detailed Description

Represents an object that can be used as an alias to a Node object.


Constructor & Destructor Documentation

Simias::Storage::LinkNode::LinkNode ( string  name,
Relationship  relationship 
) [inline]

Constructor used to create a new LinkNode object.

Parameters:
name The name of this LinkNode object.
relationship A relationship object set for another Node object.

Simias::Storage::LinkNode::LinkNode ( string  name,
string  nodeID,
Relationship  relationship 
) [inline]

Constructor used to create a new LinkNode object with a specified ID.

Parameters:
name The name of this LinkNode object.
nodeID Globally unique identifier for the LinkNode object.
relationship A relationship object set for another Node object.

Simias::Storage::LinkNode::LinkNode ( Node  node  )  [inline]

Constructor for creating an existing LinkNode object.

Parameters:
node Node object to create LinkNode object from.

Simias::Storage::LinkNode::LinkNode ( Collection  collection,
ShallowNode  shallowNode 
) [inline]

Constructor that creates a LinkNode object from a ShallowNode object.

Parameters:
collection Collection that the specified Node object belongs to.
shallowNode ShallowNode object to create the LinkNode object from.


Member Function Documentation

Node Simias::Storage::LinkNode::GetReference ( Store  store  )  [inline]

Gets the Node referenced by this LinkNode object.

Parameters:
store A reference to the Collection Store.
Returns:
The node that is referenced by this LinkNode object or null if the link is broken.


The documentation for this class was generated from the following file:

Generated on Wed Apr 8 14:54:57 2009 for simias by  doxygen 1.5.6