Simias::Storage::BaseFileNode Class Reference

Represents a generic file object. More...

Inheritance diagram for Simias::Storage::BaseFileNode:

[legend]

Collaboration diagram for Simias::Storage::BaseFileNode:

[legend]

List of all members.

Public Member Functions
abstract string	GetFileName ()
	Gets the file entry name with its extension.
abstract string	GetFullPath (Collection collection)
	Gets the full path of the file entry.
bool	UpdateFileInfo (Collection collection)
	Updates the file node with file information from the disk file.
bool	UpdateFileInfo (Collection collection, string fullPath)
	Updates the file node with file information from the disk file.
Protected Member Functions
internal	BaseFileNode (Collection collection, string parentPath, string fileName, string fileID, string fileType)
	Constructor used to create a new BaseFileNode object.
internal	BaseFileNode (Stream stream, string fileName, string fileID, string fileType)
	Constructor used to create a new BaseFileNode object.
internal	BaseFileNode (string fileName, string fileID, string fileType)
	Constructor used to create a new BaseFileNode object.
internal	BaseFileNode (Node node)
	Constructor for creating an existing BaseFileNode object.
internal	BaseFileNode (Collection collection, ShallowNode shallowNode)
	Constructor for create an existing BaseFileNode object from a ShallowNode object.
internal	BaseFileNode (XmlDocument document)
	Constructor for creating an existing BaseFileNode object from an Xml document object.
Properties
new DateTime	CreationTime [get, set]
	Gets or sets the file creation time in the metadata.
DateTime	LastAccessTime [get, set]
	Gets or sets the file last access time in the metadata.
DateTime	LastWriteTime [get, set]
	Gets or sets the file last write time in the metadata.
long	Length [get, set]
	Gets or sets the file length in the metadata.

---

Detailed Description

Represents a generic file object.

---

Constructor & Destructor Documentation

internal Simias::Storage::BaseFileNode::BaseFileNode	(	Collection	collection,
		string	parentPath,
		string	fileName,
		string	fileID,
		string	fileType
	)			[inline, protected]

Constructor used to create a new BaseFileNode object.

Parameters:

	collection	Collection that this file entry will be associated with.
	parentPath	Fully qualified path to the parent directory.
	fileName	Friendly name of the file entry.
	fileID	Globally unique identifier for the file entry.
	fileType	Class type to deserialize file entry as.

internal Simias::Storage::BaseFileNode::BaseFileNode	(	Stream	stream,
		string	fileName,
		string	fileID,
		string	fileType
	)			[inline, protected]

Constructor used to create a new BaseFileNode object.

Parameters:

	stream	Stream object that contains the file data.
	fileName	Friendly name of the file entry.
	fileID	Globally unique identifier for the file entry.
	fileType	Class type to deserialize file entry as.

internal Simias::Storage::BaseFileNode::BaseFileNode	(	string	fileName,
		string	fileID,
		string	fileType
	)			[inline, protected]

Constructor used to create a new BaseFileNode object.

Parameters:

	fileName	Friendly name of the file entry.
	fileID	Globally unique identifier for the file entry.
	fileType	Class type to deserialize file entry as.

internal Simias::Storage::BaseFileNode::BaseFileNode

(

Node

node

)

[inline, protected]

Constructor for creating an existing BaseFileNode object.

Parameters:

node

Node object to create BaseFileNode object from.

internal Simias::Storage::BaseFileNode::BaseFileNode	(	Collection	collection,
		ShallowNode	shallowNode
	)			[inline, protected]

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

Parameters:

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

internal Simias::Storage::BaseFileNode::BaseFileNode

(

XmlDocument

document

)

[inline, protected]

Constructor for creating an existing BaseFileNode object from an Xml document object.

Parameters:

document

Xml document object to create BaseFileNode object from.

---

Member Function Documentation

abstract string Simias::Storage::BaseFileNode::GetFileName

(

)

[pure virtual]

Gets the file entry name with its extension.

Returns:

The name of the file including the extension.

Implemented in Simias::Storage::FileNode, and Simias::Storage::StoreFileNode.

abstract string Simias::Storage::BaseFileNode::GetFullPath

(

Collection

collection

)

[pure 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.

Implemented in Simias::Storage::FileNode, and Simias::Storage::StoreFileNode.

bool Simias::Storage::BaseFileNode::UpdateFileInfo

(

Collection

collection

)

[inline]

Updates the file node with file information from the disk file.

Parameters:

collection

Collection that this file entry is associated with.

Returns:

True if the file information has changed, otherwise false is returned.

bool Simias::Storage::BaseFileNode::UpdateFileInfo	(	Collection	collection,
		string	fullPath
	)			[inline]

Updates the file node with file information from the disk file.

Parameters:

	collection	Collection that this file entry is associated with.
	fullPath	Absolute path to the disk file.

Returns:

True if the file information has changed, otherwise false is returned.

---

Property Documentation

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

Gets or sets the file creation time in the metadata.

Reimplemented from Simias::Storage::Node.

DateTime Simias::Storage::BaseFileNode::LastAccessTime [get, set]

Gets or sets the file last access time in the metadata.

DateTime Simias::Storage::BaseFileNode::LastWriteTime [get, set]

Gets or sets the file last write time in the metadata.

long Simias::Storage::BaseFileNode::Length [get, set]

Gets or sets the file length in the metadata.

---

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

• src/core/CollectionStore/BaseFileNode.cs