Class used to define the graph metadata informations. More...

#include <GraphMetadata.h>

Inheritance diagram for te::graph::GraphMetadata:

Public Member Functions
virtual void	addEdgeProperty (te::dt::Property *p)
	Add a new property associated to the edge element. More...

virtual void	addVertexProperty (te::dt::Property *p)
	Add a new property associated to the vertex element. More...

GraphClass	getClass ()
	It returns the the graph class (defined in Enums file) More...

te::da::DataSource *	getDataSource ()
	It returns the data source associated with this graph. More...

std::string	getDescription ()
	It returns the the graph description. More...

virtual te::dt::Property *	getEdgeProperty (int idx)
	Get a edge property given a index. More...

virtual int	getEdgePropertySize ()
	Used to verify the number of properties associated to edge elements. More...

std::string	getEdgeTableName ()
	It returns the edge table name that contains the vertex elements in data source. More...

virtual te::gm::Envelope *	getEnvelope ()
	Used to get the bounding box of the geometry elements associated with this graph. More...

int	getId ()
	It returns the graph id. More...

std::string	getName ()
	It returns the graph name. More...

virtual int	getSRID ()
	Used to get the SRID of the geometry elements associated with this graph. More...

GraphStorageMode	getStorageMode ()
	It returns the the graph storage mode (defined in Enums file) More...

std::string	getType ()
	It returns the graph type (defined in Enums file) More...

virtual te::dt::Property *	getVertexProperty (int idx)
	Get a vertex property given a index. More...

virtual int	getVertexPropertySize ()
	Used to verify the number of properties associated to vertex elements. More...

std::string	getVertexTableName ()
	It returns the vertex table name that contains the vertex elements in data source. More...

	GraphMetadata (te::da::DataSource *ds)
	Default constructor. More...

virtual void	load (int id)=0
	Function used to load the graph information given a graph id. More...

virtual void	removeEdgeProperty (int idx)
	Remove a property associated to the edge element. More...

virtual void	removeVertexProperty (int idx)
	Remove a property associated to the vertex element. More...

virtual void	save ()=0
	Function used to save the graph information. More...

void	setClass (GraphClass value)
	Set the graph class (defined in Enums file) More...

void	setDescription (std::string desc)
	Set the graph description. More...

virtual void	setEnvelope (te::gm::Envelope &extent)
	Used to set the bounding box of the geometry elements associated with this graph. More...

void	setName (std::string name)
	Set the graph name. More...

virtual void	setSRID (int srid)
	Used to set the SRID of the geometry elements associated with this graph. More...

void	setStorageMode (GraphStorageMode value)
	Set the graph storage mode (defined in Enums file) More...

void	setType (std::string graphType)
	Set the graph type (defined in Enums file) More...

virtual void	update ()=0
	Function used to update the graph information on a data source. More...

virtual	~GraphMetadata ()
	Default destructor. More...

Public Attributes
double	m_boxPercentSize
	Attribute used to box percent size used in loader strategy. More...

size_t	m_maxCacheSize
	Attribute used to set the max cache size. More...

size_t	m_maxVecCacheSize
	Attribute used to set the max vector cache size. More...

Protected Attributes
te::graph::GraphClass	m_class
	Enum attribute used to defines the graph class. More...

std::string	m_description
	Attribute used to describe a graph. More...

te::da::DataSource *	m_ds
	Data source attribute, has to be database information. More...

EdgeProperty *	m_edgeProp
	Attribute that defines the edge properties. More...

te::gm::Envelope *	m_extent
	Attribute used to define the graph extent. More...

int	m_id
	Attribute graph unique identifier. More...

te::graph::GraphStorageMode	m_mode
	Enum attribute used to defines the storage mode. More...

std::string	m_name
	Attribute name. More...

int	m_srid
	Attribute used to define the graph projection. More...

std::string	m_type
	Enum attribute used to defines the graph type. More...

VertexProperty *	m_vertexProp
	Attribute that defines the vertex properties. More...

Detailed Description

Class used to define the graph metadata informations.

See Also: Enums, AbstractGraph

Definition at line 56 of file GraphMetadata.h.

Constructor & Destructor Documentation

te::graph::GraphMetadata::GraphMetadata ( te::da::DataSource * ds )

Default constructor.

Definition at line 34 of file GraphMetadata.cpp.

References m_boxPercentSize, m_maxCacheSize, m_maxVecCacheSize, te::graph::Globals::sm_boxLoaderStrategyDefaultSize, te::graph::Globals::sm_graphCacheDefaultMaxSize, and te::graph::Globals::sm_graphVecCacheDefaultMaxSize.

te::graph::GraphMetadata::~GraphMetadata ( )

virtual

Default destructor.

Definition at line 48 of file GraphMetadata.cpp.

Member Function Documentation

void te::graph::GraphMetadata::addEdgeProperty ( te::dt::Property * p )

virtual

Add a new property associated to the edge element.

param p New property to be associated with edge elements.

Note: It's important before using this function call the flush() function, its necessary to force the memory clear and the elements will be loaded with the right size of properties.

Reimplemented in te::graph::DatabaseGraphMetadata.

Definition at line 192 of file GraphMetadata.cpp.

Referenced by te::graph::DatabaseGraphMetadata::addEdgeProperty(), and te::graph::DatabaseGraphMetadata::loadEdgeAttr().

void te::graph::GraphMetadata::addVertexProperty ( te::dt::Property * p )

virtual

Add a new property associated to the vertex element.

param p New property to be associated with vertex elements.

Note: It's important before using this function call the flush() function, its necessary to force the memory clear and the elements will be loaded with the right size of properties.

Reimplemented in te::graph::DatabaseGraphMetadata.

Definition at line 152 of file GraphMetadata.cpp.

Referenced by te::graph::DatabaseGraphMetadata::addVertexProperty(), and te::graph::DatabaseGraphMetadata::loadVertexAttr().

te::graph::GraphClass te::graph::GraphMetadata::getClass ( )

It returns the the graph class (defined in Enums file)

Returns: Enumerator value that defines the graph class

Definition at line 100 of file GraphMetadata.cpp.

te::da::DataSource * te::graph::GraphMetadata::getDataSource ( )

It returns the data source associated with this graph.

Returns: A pointer to a data source

Definition at line 115 of file GraphMetadata.cpp.

std::string te::graph::GraphMetadata::getDescription ( )

It returns the the graph description.

Returns: String with the graph description

Definition at line 80 of file GraphMetadata.cpp.

te::dt::Property * te::graph::GraphMetadata::getEdgeProperty ( int idx )

virtual

Get a edge property given a index.

Parameters

idx	Index of the property

Returns: A property associated to the edge element if the index is right and a null pointer in other case.

Definition at line 212 of file GraphMetadata.cpp.

Referenced by te::graph::QueryGraphBuilder::build(), and te::graph::DatabaseGraphMetadata::removeEdgeProperty().

int te::graph::GraphMetadata::getEdgePropertySize ( )

virtual

Used to verify the number of properties associated to edge elements.

Returns: Integer value with the number of properties.

Definition at line 222 of file GraphMetadata.cpp.

std::string te::graph::GraphMetadata::getEdgeTableName ( )

It returns the edge table name that contains the vertex elements in data source.

Returns: String with the table name

Definition at line 136 of file GraphMetadata.cpp.

References te::graph::Edge_List, te::graph::Globals::sm_tableEdgeAttributeModelSufixName, te::graph::Globals::sm_tableEdgeModelSufixName, and te::graph::Vertex_List.

te::gm::Envelope * te::graph::GraphMetadata::getEnvelope ( )

virtual

Used to get the bounding box of the geometry elements associated with this graph.

Returns: The bounding box information

Definition at line 242 of file GraphMetadata.cpp.

int te::graph::GraphMetadata::getId ( )

It returns the graph id.

Returns: Integer value with the graph id

Definition at line 60 of file GraphMetadata.cpp.

std::string te::graph::GraphMetadata::getName ( )

It returns the graph name.

Returns: String with the graph name

Definition at line 70 of file GraphMetadata.cpp.

int te::graph::GraphMetadata::getSRID ( )

virtual

Used to get the SRID of the geometry elements associated with this graph.

Returns: Integer value that defines the SRID

Definition at line 232 of file GraphMetadata.cpp.

te::graph::GraphStorageMode te::graph::GraphMetadata::getStorageMode ( )

It returns the the graph storage mode (defined in Enums file)

Returns: Enumerator value that defines the graph storage mode

Definition at line 110 of file GraphMetadata.cpp.

std::string te::graph::GraphMetadata::getType ( )

It returns the graph type (defined in Enums file)

Returns: Enumerator value that defines the graph type

Definition at line 90 of file GraphMetadata.cpp.

Referenced by te::graph::BoxLoaderStrategy::loadDataByEdgeId(), te::graph::SequenceLoaderStrategy::loadDataByVertexId(), and te::graph::BoxLoaderStrategy::loadDataByVertexId().

te::dt::Property * te::graph::GraphMetadata::getVertexProperty ( int idx )

virtual

Get a vertex property given a index.

Parameters

idx	Index of the property

Returns: A property associated to the vertex element if the index is right and a null pointer in other case.

Definition at line 172 of file GraphMetadata.cpp.

Referenced by te::graph::AddRasterAttribute::AddRasterAttribute(), te::graph::QueryGraphBuilder::build(), and te::graph::DatabaseGraphMetadata::removeVertexProperty().

int te::graph::GraphMetadata::getVertexPropertySize ( )

virtual

Used to verify the number of properties associated to vertex elements.

Returns: Integer value with the number of properties.

Definition at line 182 of file GraphMetadata.cpp.

Referenced by te::graph::AddRasterAttribute::AddRasterAttribute().

std::string te::graph::GraphMetadata::getVertexTableName ( )

It returns the vertex table name that contains the vertex elements in data source.

Returns: String with the table name

Definition at line 120 of file GraphMetadata.cpp.

References te::graph::Edge_List, te::graph::Globals::sm_tableVertexAttributeModelSufixName, te::graph::Globals::sm_tableVertexModelSufixName, and te::graph::Vertex_List.

virtual void te::graph::GraphMetadata::load ( int id )

pure virtual

Function used to load the graph information given a graph id.

Parameters

id	The Graph identifier

Exceptions

Exception It throws an exception if graph id equal -1

Implemented in te::graph::DatabaseGraphMetadata.

void te::graph::GraphMetadata::removeEdgeProperty ( int idx )

virtual

Remove a property associated to the edge element.

Parameters

idx	Index of the property

Reimplemented in te::graph::DatabaseGraphMetadata.

Definition at line 202 of file GraphMetadata.cpp.

Referenced by te::graph::DatabaseGraphMetadata::removeEdgeProperty().

void te::graph::GraphMetadata::removeVertexProperty ( int idx )

virtual

Remove a property associated to the vertex element.

Parameters

idx	Index of the property

Reimplemented in te::graph::DatabaseGraphMetadata.

Definition at line 162 of file GraphMetadata.cpp.

Referenced by te::graph::DatabaseGraphMetadata::removeVertexProperty().

virtual void te::graph::GraphMetadata::save ( )

pure virtual

Function used to save the graph information.

Implemented in te::graph::DatabaseGraphMetadata.

void te::graph::GraphMetadata::setClass ( GraphClass value )

Set the graph class (defined in Enums file)

Parameters

value Enumerator value that defines the graph class

Definition at line 95 of file GraphMetadata.cpp.

void te::graph::GraphMetadata::setDescription ( std::string desc )

Set the graph description.

Parameters

desc	String with the graph description

Definition at line 75 of file GraphMetadata.cpp.

Referenced by te::graph::BidirectionalGraphFactory::create(), te::graph::DirectedGraphFactory::create(), te::graph::GraphFactory::create(), and te::graph::UndirectedGraphFactory::create().

void te::graph::GraphMetadata::setEnvelope ( te::gm::Envelope & extent )

virtual

Used to set the bounding box of the geometry elements associated with this graph.

Parameters

The	bounding box information

Definition at line 247 of file GraphMetadata.cpp.

void te::graph::GraphMetadata::setName ( std::string name )

Set the graph name.

Parameters

name	String with the graph name

Definition at line 65 of file GraphMetadata.cpp.

Referenced by te::graph::BidirectionalGraphFactory::create(), te::graph::DirectedGraphFactory::create(), te::graph::GraphFactory::create(), and te::graph::UndirectedGraphFactory::create().

void te::graph::GraphMetadata::setSRID ( int srid )

virtual

Used to set the SRID of the geometry elements associated with this graph.

Parameters

Integer value that defines the SRID

Definition at line 237 of file GraphMetadata.cpp.

void te::graph::GraphMetadata::setStorageMode ( GraphStorageMode value )

Set the graph storage mode (defined in Enums file)

Parameters

value Enumerator value that defines the graph storage mode

Definition at line 105 of file GraphMetadata.cpp.

Referenced by te::graph::BidirectionalGraphFactory::create(), te::graph::DirectedGraphFactory::create(), te::graph::GraphFactory::create(), and te::graph::UndirectedGraphFactory::create().

void te::graph::GraphMetadata::setType ( std::string graphType )

Set the graph type (defined in Enums file)

Parameters

value Enumerator value that defines the graph type

Definition at line 85 of file GraphMetadata.cpp.

Referenced by te::graph::AbstractGraphFactory::make(), and te::graph::AbstractGraphFactory::open().

virtual void te::graph::GraphMetadata::update ( )

pure virtual

Function used to update the graph information on a data source.

Exceptions

Exception It throws an exception if graph id equal -1

Implemented in te::graph::DatabaseGraphMetadata.

Member Data Documentation

double te::graph::GraphMetadata::m_boxPercentSize

Attribute used to box percent size used in loader strategy.

Definition at line 321 of file GraphMetadata.h.

Referenced by GraphMetadata().

te::graph::GraphClass te::graph::GraphMetadata::m_class

protected

Enum attribute used to defines the graph class.

Definition at line 306 of file GraphMetadata.h.

std::string te::graph::GraphMetadata::m_description

protected

Attribute used to describe a graph.

Definition at line 298 of file GraphMetadata.h.

te::da::DataSource* te::graph::GraphMetadata::m_ds

protected

Data source attribute, has to be database information.

Definition at line 310 of file GraphMetadata.h.

EdgeProperty* te::graph::GraphMetadata::m_edgeProp

protected

Attribute that defines the edge properties.

Definition at line 314 of file GraphMetadata.h.

te::gm::Envelope* te::graph::GraphMetadata::m_extent

protected

Attribute used to define the graph extent.

Definition at line 302 of file GraphMetadata.h.

int te::graph::GraphMetadata::m_id

protected

Attribute graph unique identifier.

Definition at line 294 of file GraphMetadata.h.

size_t te::graph::GraphMetadata::m_maxCacheSize

Attribute used to set the max cache size.

Definition at line 319 of file GraphMetadata.h.

Referenced by GraphMetadata().

size_t te::graph::GraphMetadata::m_maxVecCacheSize

Attribute used to set the max vector cache size.

Definition at line 320 of file GraphMetadata.h.

Referenced by GraphMetadata().

te::graph::GraphStorageMode te::graph::GraphMetadata::m_mode

protected

Enum attribute used to defines the storage mode.

Definition at line 308 of file GraphMetadata.h.

Referenced by te::graph::DatabaseGraphMetadata::DatabaseGraphMetadata().

std::string te::graph::GraphMetadata::m_name

protected

Attribute name.

Definition at line 296 of file GraphMetadata.h.

int te::graph::GraphMetadata::m_srid

protected

Attribute used to define the graph projection.

Definition at line 300 of file GraphMetadata.h.

std::string te::graph::GraphMetadata::m_type

protected

Enum attribute used to defines the graph type.

Definition at line 304 of file GraphMetadata.h.

VertexProperty* te::graph::GraphMetadata::m_vertexProp

protected

Attribute that defines the vertex properties.

Definition at line 312 of file GraphMetadata.h.

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/graph/core/GraphMetadata.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/graph/core/GraphMetadata.cpp

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation