Simias::Storage::DirNode Class Reference

Represents a directory entry in a external file system. More...

Inheritance diagram for Simias::Storage::DirNode:

Collaboration diagram for Simias::Storage::DirNode:

List of all members.

Public Member Functions

DirNode (Collection collection, DirNode parentNode, string dirName)

Constructor used to create a new DirNode object.

DirNode (Collection collection, DirNode parentNode, string dirName, string dirID)

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

DirNode (Collection collection, string dirPath)

Constructor used to create a new DirNode object with a specified ID that represents a root directory in the Collection.

DirNode (Collection collection, string dirPath, string dirID)

Constructor used to create a new DirNode object with a specified ID that represents a root directory in the Collection.

DirNode (Collection collection, ShallowNode shallowNode)

Constructor for create an existing DirNode object from a ShallowNode object.

DirNode (Node node)

Constructor for creating an existing DirNode object.

string GetFullPath (Collection collection)

Gets the full path of the directory entry.

DirNode GetParent (Collection collection)

Gets the DirNode object that represents the parent relationship to this directory entry.

string GetRelativePath (Collection collection)

Gets the path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.

string GetRelativePath ()

Gets the path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.

bool HasChildren (Collection collection)

Returns whether this DirNode object contains children.

void MoveRoot (Collection collection, string newRoot)

Move the Root node in the file system.

Properties

new DateTime CreationTime [get, set]

Gets the directory creation time.

bool IsRoot [get]

Gets whether this object is the root relationship.

Detailed Description

Represents a directory entry in a external file system.

Constructor & Destructor Documentation

Simias::Storage::DirNode::DirNode	(	Collection	collection,
		DirNode	parentNode,
		string	dirName
	)			`[inline]`

Constructor used to create a new DirNode object.

Parameters:

	collection	Collection that this DirNode object will be associated with.
	parentNode	The DirNode object that will be the parent to this object or null if this directory exists at the collection root.
	dirName	Name of the directory entry.

Simias::Storage::DirNode::DirNode	(	Collection	collection,
		DirNode	parentNode,
		string	dirName,
		string	dirID
	)			`[inline]`

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

Parameters:

	collection	Collection that this DirNode object will be associated with.
	parentNode	The DirNode object that will be the parent to this object or null if this directory exists at the collection root.
	dirName	Name of the directory entry.
	dirID	Globally unique identifier for the directory entry.

Simias::Storage::DirNode::DirNode	(	Collection	collection,
		string	dirPath
	)			`[inline]`

Constructor used to create a new DirNode object with a specified ID that represents a root directory in the Collection.

Parameters:

	collection	Collection that this DirNode object will be associated with.
	dirPath	An absolute path to a directory entry in the external file system.

Simias::Storage::DirNode::DirNode	(	Collection	collection,
		string	dirPath,
		string	dirID
	)			`[inline]`

Constructor used to create a new DirNode object with a specified ID that represents a root directory in the Collection.

Parameters:

	collection	Collection that this DirNode object will be associated with.
	dirPath	An absolute path to a directory entry in the external file system.
	dirID	Globally unique identifier for the directory entry.

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

Constructor for create an existing DirNode object from a ShallowNode object.

Parameters:

	collection	Collection that the ShallowNode belongs to.
	shallowNode	ShallowNode object to create new DirNode object from.

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

Constructor for creating an existing DirNode object.

Parameters:

node

Node object to create DirNode object from.

Member Function Documentation

string Simias::Storage::DirNode::GetFullPath ( Collection collection ) [inline]

Gets the full path of the directory entry.

Parameters:

collection

Collection object that this object belongs to.

Returns:: The absolute path to the directory.

DirNode Simias::Storage::DirNode::GetParent ( Collection collection ) [inline]

Gets the DirNode object that represents the parent relationship to this directory entry.

Parameters:

collection

Collection object that this object belongs to.

Returns:: A DirNode object that represents the parent relationship or null if the DirNode object exists at the collection root.

string Simias::Storage::DirNode::GetRelativePath ( Collection collection ) [inline]

Gets the path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.

Parameters:

collection

Collection object that this object belongs to.

Returns:: The path relative to the collection root directory.

string Simias::Storage::DirNode::GetRelativePath ( ) [inline]

Gets the path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.

Returns:: The path relative to the collection root directory.

bool Simias::Storage::DirNode::HasChildren ( Collection collection ) [inline]

Returns whether this DirNode object contains children.

Parameters:

collection

Collection object that this object belongs to.

Returns:: True if DirNode object contains children, otherwise false is returned.

void Simias::Storage::DirNode::MoveRoot	(	Collection	collection,
		string	newRoot
	)			`[inline]`

Move the Root node in the file system.

Parameters:

	collection	The collection that contains the node.
	newRoot	The new path to the parent container.

Property Documentation

new DateTime Simias::Storage::DirNode::CreationTime [get, set]

Gets the directory creation time.

Reimplemented from Simias::Storage::Node.

bool Simias::Storage::DirNode::IsRoot [get]

Gets whether this object is the root relationship.

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

src/core/CollectionStore/DirNode.cs


Public Member Functions
	DirNode (Collection collection, DirNode parentNode, string dirName)
	Constructor used to create a new DirNode object.
	DirNode (Collection collection, DirNode parentNode, string dirName, string dirID)
	Constructor used to create a new DirNode object with a specified ID.
	DirNode (Collection collection, string dirPath)
	Constructor used to create a new DirNode object with a specified ID that represents a root directory in the Collection.
	DirNode (Collection collection, string dirPath, string dirID)
	Constructor used to create a new DirNode object with a specified ID that represents a root directory in the Collection.
	DirNode (Collection collection, ShallowNode shallowNode)
	Constructor for create an existing DirNode object from a ShallowNode object.
	DirNode (Node node)
	Constructor for creating an existing DirNode object.
string	GetFullPath (Collection collection)
	Gets the full path of the directory entry.
DirNode	GetParent (Collection collection)
	Gets the DirNode object that represents the parent relationship to this directory entry.
string	GetRelativePath (Collection collection)
	Gets the path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.
string	GetRelativePath ()
	Gets the path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.
bool	HasChildren (Collection collection)
	Returns whether this DirNode object contains children.
void	MoveRoot (Collection collection, string newRoot)
	Move the Root node in the file system.
Properties
new DateTime	CreationTime `[get, set]`
	Gets the directory creation time.
bool	IsRoot `[get]`
	Gets whether this object is the root relationship.