Reprensents a File on disk. More...

#include <WsFileNode.h>

Inheritance diagram for WsFileNode:

Collaboration diagram for WsFileNode:

Public Types
enum	ResourceType { Icones, Images, Templates }

Public Member Functions
	WsFileNode (const path &fullPath, const path &rootPath)
	Constructor for FileNode. More...

	WsFileNode ()

bool	isAllowed (const std::set< string > &gids)
	Return true or false whether the gids are allowed or no. More...

const set< string >	getGroups ()
	returns the list of the groups allowed to access this node More...

bool	getDisplayInMenu ()
	returns true if the item should be displayed in the menu. This value is set in the configuration file of the node More...

const string	getPublishDate ()
	returns the publish date of the file More...

const string	getAuthor ()
	returns the author name. More...

const uintmax_t	getSize ()
	return the size of the file More...

bool	isDirectory ()

bool	isRegularFile ()

const path &	getPath ()
	returns the relative path of the node More...

const path &	getFullPath ()
	returns the full path of the node More...

string	getName (const bool noExt=false)
	returns the name of the node More...

const string	getDisplayName (const bool noExt=false)
	returns the display name of the node More...

int	addChildDirectory (NodePtr f)
	adds a node as a child directory The Directory is added to the WsAbstractNode::m_dirVect More...

int	addChildFile (NodePtr f)
	adds a node as a child file The Directory is added to the WsAbstractNode::m_fileVect More...

int	addChildNode (NodePtr f)
	add a Node to the combined vect WsAbstractNode::m_combinedVect More...

void	setParent (NodePtr n)
	sets the parent of the node represented by this More...

NodePtr	getParent ()
	returns the parent node of this More...

const vector< NodePtr >	getFiles ()
	returns the list of all the file contained in the directory represented by this More...

const vector< NodePtr >	getDirectories ()
	returns the list of all the file contained in the file reprensented by this More...

const vector< NodePtr >	getAll ()
	combine the vector of files and directories into a single one More...

NodePtr	getNodeByName (const std::string &name)
	Searches for the NodePtr reprenting the filename. More...

void	setProperties (NodePropertiesPtr properties)
	set the properties of the node. The properties are a WsAbstractProperties object. More...

NodePropertiesPtr	getProperties ()
	get the properties of the node If the properties are not set (no conf found, or node retrieved from server) empty properties are returned. To get the properties for a node retrieved from server use WsUser::getProperties More...

std::string	getProperty (const std::string &section, const std::string &id, const std::string &def, bool recurse=false)
	get a node property reprensented by section/id If no value found, the value def is returned More...

void	sort ()
	sort the nodes using the sort number or the name if not provided More...

const time_t &	getModifyDate ()
	returns the modification date of the file reprenseted by the node More...

const time_t &	getCreateDate ()
	WsAbstractNode::getCreateDate() More...

void	setCreateDate (const time_t &t)
	sets the creation date of the file. This method does not change the actual creation date of the file represented by the node More...

void	setModifyDate (const time_t &t)
	sets the modification date of the file. This method does not change the actual modification date of the file represented by the node More...

void	setSize (const uintmax_t &size)
	sets the file size in the node. Typically called by WsFileSystemTree when building the FileSystemTree More...

NodePtr	eatPath (const std::string &path)
	resolves the path and returns the node reprenseted by this path The path should be starting from the rootPath otherwise the method won't be able to resolve it. More...

Public Attributes
WNodePtr	m_parent

vector< NodePtr >	m_fileVect

vector< NodePtr >	m_dirVect

vector< NodePtr >	m_combinedVect

path	m_fullPath

path	m_relPath

uintmax_t	m_size

Protected Attributes
NodePropertiesPtr	m_properties

time_t	m_createTime

time_t	m_modifyTime

boost::mutex *	m_mutexSort

Detailed Description

Reprensents a File on disk.

Definition at line 23 of file WsFileNode.h.

Member Enumeration Documentation

enum WsAbstractNode::ResourceType

inherited

Type of ressource

Enumerator
Icones
Images
Templates

Definition at line 57 of file WsAbstractNode.h.

Constructor & Destructor Documentation

WsFileNode::WsFileNode	(	const path &	fullPath,
		const path &	rootPath
	)

Constructor for FileNode.

Parameters

fullPath	the fullPath of the node
rootPath	the rootPath (ie the directory of the site)

Definition at line 16 of file WsFileNode.cpp.

WsFileNode::WsFileNode ( )

Definition at line 20 of file WsFileNode.cpp.

Member Function Documentation

int WsNode::addChildDirectory ( NodePtr f )

virtualinherited

adds a node as a child directory The Directory is added to the WsAbstractNode::m_dirVect

Parameters

f	a NodePtr of the WsAbstractNode representing the directory

Returns: SUCCESS or FAILURE

Implements WsAbstractNode.

Definition at line 47 of file WsNode.cpp.

int WsNode::addChildFile ( NodePtr f )

virtualinherited

adds a node as a child file The Directory is added to the WsAbstractNode::m_fileVect

Parameters

f	a NodePtr of the WsAbstractNode representing the file

Implements WsAbstractNode.

Definition at line 60 of file WsNode.cpp.

int WsNode::addChildNode ( NodePtr f )

virtualinherited

add a Node to the combined vect WsAbstractNode::m_combinedVect

Parameters

f	a NodePtr of the WsAbstractNode representing the file or directory

Implements WsAbstractNode.

Definition at line 73 of file WsNode.cpp.

NodePtr WsNode::eatPath ( const std::string & path )

virtualinherited

resolves the path and returns the node reprenseted by this path The path should be starting from the rootPath otherwise the method won't be able to resolve it.

Parameters

path	the path of the node we are searching starting from the rootPath

Returns: The corresponding NodePtr reprensenting the WsAbstractNode if found or an empty NodePtr

Implements WsAbstractNode.

Definition at line 207 of file WsNode.cpp.

Here is the call graph for this function:

const vector< NodePtr > WsNode::getAll ( )

virtualinherited

combine the vector of files and directories into a single one

Returns: the combined vector

Implements WsAbstractNode.

Definition at line 130 of file WsNode.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

const string WsFileNode::getAuthor ( )

returns the author name.

Returns: a string containing this name

Definition at line 63 of file WsFileNode.cpp.

const time_t & WsNode::getCreateDate ( )

virtualinherited

WsAbstractNode::getCreateDate()

Implements WsAbstractNode.

Definition at line 244 of file WsNode.cpp.

const vector< NodePtr > WsNode::getDirectories ( )

virtualinherited

returns the list of all the file contained in the file reprensented by this

Returns: a list of Nodes containing these children

Implements WsAbstractNode.

Definition at line 124 of file WsNode.cpp.

Here is the call graph for this function:

bool WsFileNode::getDisplayInMenu ( )

virtual

returns true if the item should be displayed in the menu. This value is set in the configuration file of the node

Deprecated:: TODO remove

Implements WsAbstractNode.

Definition at line 49 of file WsFileNode.cpp.

const string WsNode::getDisplayName ( const bool noExt = false )

virtualinherited

returns the display name of the node

Returns: the display name of the node if set in the configuration file of the node, otherwise WsAbstractNode::getName() is returned

Implements WsAbstractNode.

Definition at line 111 of file WsNode.cpp.

Here is the call graph for this function:

const vector< NodePtr > WsNode::getFiles ( )

virtualinherited

returns the list of all the file contained in the directory represented by this

Returns: a list of Nodes containing these children

Implements WsAbstractNode.

Definition at line 118 of file WsNode.cpp.

Here is the call graph for this function:

const path & WsNode::getFullPath ( )

virtualinherited

returns the full path of the node

Implements WsAbstractNode.

Definition at line 99 of file WsNode.cpp.

const set< string > WsFileNode::getGroups ( )

returns the list of the groups allowed to access this node

Returns: a set containing these groups

Definition at line 24 of file WsFileNode.cpp.

const time_t & WsNode::getModifyDate ( )

virtualinherited

returns the modification date of the file reprenseted by the node

Implements WsAbstractNode.

Definition at line 239 of file WsNode.cpp.

string WsNode::getName ( const bool noExt = false )

virtualinherited

returns the name of the node

Returns: the name of the node. ie the text contained between the last '/' and the end

Implements WsAbstractNode.

Definition at line 104 of file WsNode.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

NodePtr WsNode::getNodeByName ( const std::string & name )

virtualinherited

Searches for the NodePtr reprenting the filename.

Parameters

name	the name of the node with the extension

Returns: the corresponding NodePtr or an empty NodePtr if not found

Implements WsAbstractNode.

Definition at line 138 of file WsNode.cpp.

Here is the caller graph for this function:

NodePtr WsNode::getParent ( )

virtualinherited

returns the parent node of this

Returns: the parent Node, a NodePtr representing a WsDirNode if existing otherwise returns NULL

Implements WsAbstractNode.

Definition at line 88 of file WsNode.cpp.

const path & WsNode::getPath ( )

virtualinherited

returns the relative path of the node

Returns: the relative path of the node, ie the Full path without the rootPath

Implements WsAbstractNode.

Definition at line 94 of file WsNode.cpp.

Here is the caller graph for this function:

NodePropertiesPtr WsNode::getProperties ( )

virtualinherited

get the properties of the node If the properties are not set (no conf found, or node retrieved from server) empty properties are returned. To get the properties for a node retrieved from server use WsUser::getProperties

See Also: WsUser::getProperties

Implements WsAbstractNode.

Definition at line 175 of file WsNode.cpp.

Here is the caller graph for this function:

string WsNode::getProperty	(	const std::string &	section,
		const std::string &	id,
		const std::string &	def,
		bool	recurse = `false`
	)

virtualinherited

get a node property reprensented by section/id If no value found, the value def is returned

Parameters

section	the section of the key we are searching
id	the key we are searching
def	the default value to return if not found
recurse	if set to true and no value found , the method will look for parent values until a value is found.

Implements WsAbstractNode.

Definition at line 180 of file WsNode.cpp.

Here is the caller graph for this function:

const string WsFileNode::getPublishDate ( )

returns the publish date of the file

Returns: a string containing this date. The publish date is reprensetend is iso format (seconds from epoch)

Definition at line 57 of file WsFileNode.cpp.

Here is the caller graph for this function:

const uintmax_t WsFileNode::getSize ( )

virtual

return the size of the file

Implements WsNode.

Definition at line 68 of file WsFileNode.cpp.

bool WsFileNode::isAllowed ( const std::set< string > & gids )

virtual

Return true or false whether the gids are allowed or no.

Parameters

gids the gids

Returns: true or false

Implements WsAbstractNode.

Definition at line 34 of file WsFileNode.cpp.

bool WsFileNode::isDirectory ( )

virtual

Returns: false because it's a File

Implements WsNode.

Definition at line 73 of file WsFileNode.cpp.

bool WsFileNode::isRegularFile ( )

virtual

Returns: true because it's a File

Implements WsNode.

Definition at line 78 of file WsFileNode.cpp.

void WsNode::setCreateDate ( const time_t & t )

virtualinherited

sets the creation date of the file. This method does not change the actual creation date of the file represented by the node

Implements WsAbstractNode.

Definition at line 249 of file WsNode.cpp.

void WsNode::setModifyDate ( const time_t & t )

virtualinherited

sets the modification date of the file. This method does not change the actual modification date of the file represented by the node

Implements WsAbstractNode.

Definition at line 254 of file WsNode.cpp.

Here is the caller graph for this function:

void WsNode::setParent ( NodePtr n )

virtualinherited

sets the parent of the node represented by this

Parameters

n	the parent node that is a NodePtr representing a WsDirNode

Implements WsAbstractNode.

Definition at line 83 of file WsNode.cpp.

void WsNode::setProperties ( NodePropertiesPtr properties )

virtualinherited

set the properties of the node. The properties are a WsAbstractProperties object.

Parameters

properties w WsNodeProperties representing the properties of the node. The object should be instanciated and values set in it

Implements WsAbstractNode.

Definition at line 165 of file WsNode.cpp.

Here is the caller graph for this function:

void WsNode::setSize ( const uintmax_t & size )

virtualinherited

sets the file size in the node. Typically called by WsFileSystemTree when building the FileSystemTree

Implements WsAbstractNode.

Definition at line 170 of file WsNode.cpp.

Here is the caller graph for this function:

void WsNode::sort ( )

virtualinherited

sort the nodes using the sort number or the name if not provided

Implements WsAbstractNode.

Definition at line 192 of file WsNode.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

vector<NodePtr> WsAbstractNode::m_combinedVect

inherited

A combined vector of WsAbstractNode::m_fileVect and WsAbstractNode::m_dirVect It is built in the WsAbstractNode::sort() method

Definition at line 258 of file WsAbstractNode.h.

time_t WsNode::m_createTime

protectedinherited

The creation date of the node

Definition at line 222 of file WsNode.h.

vector<NodePtr> WsAbstractNode::m_dirVect

inherited

The std::vector containing the children directories of the Node represented by this

Definition at line 253 of file WsAbstractNode.h.

vector<NodePtr> WsAbstractNode::m_fileVect

inherited

The std::vector containing the children files of the Node represented by this

Definition at line 249 of file WsAbstractNode.h.

path WsAbstractNode::m_fullPath

inherited

The full path of the Node (ie the rootPath + m_relPath)

Definition at line 262 of file WsAbstractNode.h.

time_t WsNode::m_modifyTime

protectedinherited

The modification date of the node

Definition at line 226 of file WsNode.h.

boost::mutex* WsNode::m_mutexSort

protectedinherited

Definition at line 228 of file WsNode.h.

WNodePtr WsAbstractNode::m_parent

inherited

The parent Node

Definition at line 245 of file WsAbstractNode.h.

NodePropertiesPtr WsNode::m_properties

protectedinherited

The properties of the node

Definition at line 218 of file WsNode.h.

path WsAbstractNode::m_relPath

inherited

The relative path of the Node (ie the path starting from the rootPath

Definition at line 266 of file WsAbstractNode.h.

uintmax_t WsAbstractNode::m_size

inherited

The size of the file represented by the node on disk

Definition at line 270 of file WsAbstractNode.h.

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

/Users/benoitdaccache/Documents/Dropbox/Programming/Ws/wscore/src/FileSystemTree/WsFileNode.h
/Users/benoitdaccache/Documents/Dropbox/Programming/Ws/wscore/src/FileSystemTree/WsFileNode.cpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation