Simias::Storage::FileNode Class Reference

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

Inheritance diagram for Simias::Storage::FileNode:

Collaboration diagram for Simias::Storage::FileNode:

List of all members.

Public Member Functions

FileNode (Collection collection, DirNode parentNode, string fileName)

Constructor used to create a new FileNode object.

FileNode (Collection collection, DirNode parentNode, string fileName, string fileID)

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

FileNode (Node node)

Constructor for creating an existing FileNode object.

FileNode (Collection collection, ShallowNode shallowNode)

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

override string GetFileName ()

Gets the file entry name with its extension.

override string GetFullPath (Collection collection)

Gets the full path of the file entry.

DirNode GetParent (Collection collection)

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

string GetRelativePath (Collection collection)

Gets the file 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 file path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.

Detailed Description

Represents a file entry in an external file system.

Constructor & Destructor Documentation

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

Constructor used to create a new FileNode object.

Parameters:

	collection	Collection that this FileNode object will be associated with.
	parentNode	The DirNode object that will be the parent to this object.
	fileName	Friendly name of the FileNode object.

Simias::Storage::FileNode::FileNode	(	Collection	collection,
		DirNode	parentNode,
		string	fileName,
		string	fileID
	)			`[inline]`

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

Parameters:

	collection	Collection that this FileNode object will be associated with.
	parentNode	The DirNode object that will be the parent to this object.
	fileName	Friendly name of the FileNode object.
	fileID	Globally unique identifier for the FileNode object.

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

Constructor for creating an existing FileNode object.

Parameters:

node

Node object to create FileNode object from.

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

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

Parameters:

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

Member Function Documentation

override string Simias::Storage::FileNode::GetFileName ( ) [inline, virtual]

Gets the file entry name with its extension.

Returns:: The name of the file including the extension.

Implements Simias::Storage::BaseFileNode.

override string Simias::Storage::FileNode::GetFullPath ( Collection collection ) [inline, virtual]

Gets the full path of the file entry.

Parameters:

collection

Collection that this file entry is associated with.

Returns:: The absolute path to the file.

Implements Simias::Storage::BaseFileNode.

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

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

Parameters:

collection

Collection that this FileNode object is associated with.

Returns:: A DirNode object that represents the parent relationship.

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

Gets the file 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 file path relative to the collection root directory.

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

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

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

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

src/core/CollectionStore/FileNode.cs


Public Member Functions
	FileNode (Collection collection, DirNode parentNode, string fileName)
	Constructor used to create a new FileNode object.
	FileNode (Collection collection, DirNode parentNode, string fileName, string fileID)
	Constructor used to create a new FileNode object with a specified ID.
	FileNode (Node node)
	Constructor for creating an existing FileNode object.
	FileNode (Collection collection, ShallowNode shallowNode)
	Constructor for create an existing FileNode object from a ShallowNode object.
override string	GetFileName ()
	Gets the file entry name with its extension.
override string	GetFullPath (Collection collection)
	Gets the full path of the file entry.
DirNode	GetParent (Collection collection)
	Gets the DirNode object that represents the parent relationship to this file entry.
string	GetRelativePath (Collection collection)
	Gets the file 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 file path relative to the collection root directory. This method will always return relative paths that are normalized using forward slashes as separators.