Simias::Storage::StoreFileNode Class Reference
Represents a file entry that whose location is managed by the Collection Store. More...
Public Member Functions | |
| StoreFileNode (string name, Stream stream) | |
| Constructor used to create a new StoreFileNode object. | |
| StoreFileNode (string name, string fileID, Stream stream) | |
| Constructor used to create a new StoreFileNode object with a specified ID. | |
| StoreFileNode (Node node) | |
| Constructor for creating an existing StoreFileNode object. | |
| StoreFileNode (Collection collection, ShallowNode shallowNode) | |
| Constructor for creating an existing StoreFileNode 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. | |
Detailed Description
Represents a file entry that whose location is managed by the Collection Store.
Constructor & Destructor Documentation
| Simias::Storage::StoreFileNode::StoreFileNode | ( | string | name, | |
| Stream | stream | |||
| ) | [inline] |
Constructor used to create a new StoreFileNode object.
Note: The Stream object parameter that is passed to this constructor becomes owned by the StoreFileNode object and should not be manipulated or closed by the caller.
- Parameters:
-
name Name of this StoreFileNode object. stream A Stream object where the data can be read.
| Simias::Storage::StoreFileNode::StoreFileNode | ( | string | name, | |
| string | fileID, | |||
| Stream | stream | |||
| ) | [inline] |
Constructor used to create a new StoreFileNode object with a specified ID.
Note: The Stream object parameter that is passed to this constructor becomes owned by the StoreFileNode object and should not be manipulated or closed by the caller.
- Parameters:
-
name Name of this StoreFileNode object. fileID Globally unique identifier for the StoreFileNode object. stream A Stream object where the data can be read.
| Simias::Storage::StoreFileNode::StoreFileNode | ( | Node | node | ) | [inline] |
Constructor for creating an existing StoreFileNode object.
- Parameters:
-
node Node object to create StoreFileNode object from.
| Simias::Storage::StoreFileNode::StoreFileNode | ( | Collection | collection, | |
| ShallowNode | shallowNode | |||
| ) | [inline] |
Constructor for creating an existing StoreFileNode object from a ShallowNode object.
- Parameters:
-
collection Collection that the Node object belongs to. shallowNode ShallowNode object to create StoreFileNode object from.
Member Function Documentation
| override string Simias::Storage::StoreFileNode::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::StoreFileNode::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.
The documentation for this class was generated from the following file:
- src/core/CollectionStore/StoreFileNode.cs
