te::graph::GraphCache Class Reference

Class used to manager the graph data elements. This class uses a cache policy to control the elements in memory. If a element was requested and not found in cache, the GraphDataManager is used to loaded a new GraphData. More...

#include <GraphCache.h>

Public Member Functions
	GraphCache (AbstractCachePolicy *cp, GraphDataManager *dm)
	Default constructor. More...
	~GraphCache ()
	Default destructor. More...
Graph Cache Manager Methods
Method used to manager a graph data
GraphData *	getGraphDataByVertexId (int id)
	Get a graph data from vector using a vertex id information. if not found a new graph data has to be loaded using AbstractDataManager. More...
GraphData *	getGraphDataByEdgeId (int id)
	Get a graph data from vector using a edge id information. if not found a new graph data has to be loaded using AbstractDataManager. More...
GraphData *	getGraphData ()
	Get a graph data. More...
GraphData *	createGraphData ()
	Creates a new graph data structure. More...
void	removeGraphData (int idx)
	Used to remove a graph data from cache. More...
void	saveGraphData (GraphData *data)
	Save the graph data structure inside a data source. More...
void	clearCache ()
	Used to remove from memory all elements loaded. More...
GraphData *	checkCacheByVertexId (int id)
	This functions check in cache if the vertex element with a given id was alredy in memory. More...
GraphData *	checkCacheByEdgeId (int id)
	This functions check in cache if the edge element with a given id was alredy in memory. More...

Protected Member Functions
int	getGraphDataId ()
	Protected function used to define a new value of Id to a graph data. More...

Private Attributes
GraphDataManager *	m_dataManager
	Used to load and save GraphData information from a DataSource. More...
int	m_graphDataCounter
	Graph data identifier counter. More...
std::map< int, GraphData * >	m_graphDataMap
	This map represents all data loaded in cache. More...
GraphMetadata *	m_metadata
	Graph metadata information. More...
AbstractCachePolicy *	m_policy
	Cache policy to control the cache in memory. More...

Detailed Description

Class used to manager the graph data elements. This class uses a cache policy to control the elements in memory. If a element was requested and not found in cache, the GraphDataManager is used to loaded a new GraphData.

See also

GraphDataManager, GraphData

Definition at line 60 of file GraphCache.h.

Constructor & Destructor Documentation

te::graph::GraphCache::GraphCache	(	AbstractCachePolicy *	cp,
		GraphDataManager *	dm
	)

Default constructor.

Parameters

cp	Implementation of a cache policy
dm	Data manager pointer

te::graph::GraphCache::~GraphCache

(

)

Default destructor.

Member Function Documentation

GraphData* te::graph::GraphCache::checkCacheByEdgeId

(

int

id

)

This functions check in cache if the edge element with a given id was alredy in memory.

Parameters

id	The edge Id

Returns

If the element was found its returns a pointer to a graph data that contains this element

GraphData* te::graph::GraphCache::checkCacheByVertexId

(

int

id

)

This functions check in cache if the vertex element with a given id was alredy in memory.

Parameters

id	The vertex Id

Returns

If the element was found its returns a pointer to a graph data that contains this element

void te::graph::GraphCache::clearCache

(

)

Used to remove from memory all elements loaded.

Note

The function Flush from AbstractGraph calls this function.

GraphData* te::graph::GraphCache::createGraphData

(

)

Creates a new graph data structure.

Returns

A pointer to a new graph data

GraphData* te::graph::GraphCache::getGraphData

(

)

Get a graph data.

Note

It's always try to return the graph data with the max number of elements that is not already full. If its not possible a new graph data will be created.

Returns

A pointer to a graph data.

GraphData* te::graph::GraphCache::getGraphDataByEdgeId

(

int

id

)

Get a graph data from vector using a edge id information. if not found a new graph data has to be loaded using AbstractDataManager.

Parameters

id	The edge identifier of the desired element.

Returns

A Graph Data that contains the request element.

GraphData* te::graph::GraphCache::getGraphDataByVertexId

(

int

id

)

Get a graph data from vector using a vertex id information. if not found a new graph data has to be loaded using AbstractDataManager.

Parameters

id	The vertex identifier of the desired element.

Returns

A Graph Data that contains the request element.

int te::graph::GraphCache::getGraphDataId ( )

protected

Protected function used to define a new value of Id to a graph data.

Returns

Integer value with the id information

void te::graph::GraphCache::removeGraphData

(

int

idx

)

Used to remove a graph data from cache.

Parameters

idx	The graph data identifier

void te::graph::GraphCache::saveGraphData

(

GraphData *

data

)

Save the graph data structure inside a data source.

Parameters

data	The graph data to be saved

Member Data Documentation

GraphDataManager* te::graph::GraphCache::m_dataManager

private

Used to load and save GraphData information from a DataSource.

Definition at line 181 of file GraphCache.h.

int te::graph::GraphCache::m_graphDataCounter

private

Graph data identifier counter.

Definition at line 185 of file GraphCache.h.

std::map<int, GraphData*> te::graph::GraphCache::m_graphDataMap

private

This map represents all data loaded in cache.

Definition at line 177 of file GraphCache.h.

GraphMetadata* te::graph::GraphCache::m_metadata

private

Graph metadata information.

Definition at line 183 of file GraphCache.h.

AbstractCachePolicy* te::graph::GraphCache::m_policy

private

Cache policy to control the cache in memory.

Definition at line 179 of file GraphCache.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/graph/core/GraphCache.h