Simias::Storage::NodeCache Class Reference

Object that handles cache life cycle of node objects. More...

Collaboration diagram for Simias::Storage::NodeCache:

[legend]

List of all members.

Public Member Functions
	NodeCache (Store store)
	Initializes a new instance of the object.
void	Add (Collection collection, Node node)
	Adds a node object to the cache.
void	DumpCache ()
	Empties out the cache.
void	DumpCache (string collectionID)
	Removes all nodes from the specified collection from the cache.
Node	Get (string collectionID, string nodeID)
	Gets a node object from the cache table.
void	Remove (string collectionID, string nodeID)
	Removes a node object from the cache.

---

Detailed Description

Object that handles cache life cycle of node objects.

---

Constructor & Destructor Documentation

Simias::Storage::NodeCache::NodeCache

(

Store

store

)

[inline]

Initializes a new instance of the object.

Parameters:

store

Reference to the store.

---

Member Function Documentation

void Simias::Storage::NodeCache::Add	(	Collection	collection,
		Node	node
	)			[inline]

Adds a node object to the cache.

Parameters:

	collection	The collection that the node object belongs to.
	node	The node object to add to the cache.

void Simias::Storage::NodeCache::DumpCache

(

)

[inline]

Empties out the cache.

void Simias::Storage::NodeCache::DumpCache

(

string

collectionID

)

[inline]

Removes all nodes from the specified collection from the cache.

Parameters:

collectionID

The ID of the collection to remove.

Node Simias::Storage::NodeCache::Get	(	string	collectionID,
		string	nodeID
	)			[inline]

Gets a node object from the cache table.

Parameters:

	collectionID	The ID of the collection that the node belongs to.
	nodeID	The ID of the node object.

Returns:

A node object if the ID exists in the cache. Otherwise a null is returned.

void Simias::Storage::NodeCache::Remove	(	string	collectionID,
		string	nodeID
	)			[inline]

Removes a node object from the cache.

Parameters:

	collectionID	The ID of the collection that the node belongs to.
	nodeID	The ID of the node object to remove from the cache.

---

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

• src/core/CollectionStore/NodeCache.cs