It models a property definition. More...

#include <Property.h>

Inheritance diagram for te::dt::Property:

Public Member Functions
virtual Property *	clone () const =0
	It returns a clone of the object. More...

const std::string &	getDatasetName () const
	It returns the name of the propery's dataset. More...

unsigned int	getId () const
	It returns the property identifier. More...

const std::string &	getName () const
	It returns the property name. More...

Property *	getParent () const
	It returns the parent of this property, or NULL, if it doesn't have one. More...

int	getType () const
	It returns the property data type. More...

virtual bool	has (Property *p) const =0
	It checks if the Property "p" is associated to this property or any other parent. More...

Property &	operator= (const Property &rhs)
	Assignment operator. More...

	Property (const Property &rhs)
	Copy constructor. More...

	Property (const std::string &name, int datatype, unsigned int id=0, Property *parent=0, const std::string &dsName="")
	It initializes a new Property. More...

void	setDatasetName (const std::string &dsName)
	It sets the property name. More...

void	setId (unsigned int id)
	It sets the property identifier. More...

void	setName (const std::string &name)
	It sets the property name. More...

void	setParent (Property *p)
	It associate this property to the informed parent. More...

virtual	~Property ()
	Virtual destructor. More...

Protected Attributes
std::string	m_datasetName
	The property's dataset name. More...

unsigned int	m_id
	An identification number that can be used internally. More...

std::string	m_name
	The property name. More...

Property *	m_parent
	The parent property type: it must be a CompositeProperty. More...

int	m_type
	The property data type. More...

Detailed Description

It models a property definition.

The class Property defines information about the values of a given property. This includes:

The data type associated to the property;
Any restrictions on the values of the property;

See also: SimpleProperty, CompositeProperty, NumericProperty, StringProperty, DateTimeProperty

Definition at line 59 of file Property.h.

Constructor & Destructor Documentation

◆ Property() [1/2]

te::dt::Property::Property	(	const std::string &	name,
		int	datatype,
		unsigned int	id = `0`,
		Property *	parent = `0`,
		const std::string &	dsName = `""`
	)

It initializes a new Property.

Parameters

name	The Property name.
datatype	The property data type.
id	The property identifier.
parent	A reference to the parent Property of the new object.

Warning: The identifier value (id) may be used by data source implementations. So, don't rely on its value!

◆ Property() [2/2]

te::dt::Property::Property ( const Property & rhs )

Copy constructor.

Parameters

rhs	The right-hand-side copy used to copy from.

Note: Copy constructor doesn't preserve parent relationship.

◆ ~Property()

virtual te::dt::Property::~Property ( )

inlinevirtual

Virtual destructor.

Definition at line 89 of file Property.h.

Member Function Documentation

◆ clone()

virtual Property * te::dt::Property::clone ( ) const

pure virtual

It returns a clone of the object.

The new Property may not have associations to other elements. For example, a DataSetType associated to a DataSourceCatalog when cloned will not have the clone associate to the same DataSourceCatalog.

Returns: A clone of the object.

Implemented in te::da::DataSetType, te::dt::ArrayProperty, te::dt::BitProperty, te::dt::ByteArrayProperty, te::dt::CompositeProperty, te::dt::DateTimeProperty, te::dt::NumericProperty, te::dt::SimpleProperty, te::dt::StringProperty, te::gm::GeometryProperty, and te::rst::RasterProperty.

Referenced by te::da::ForeignKey::add(), te::da::Index::add(), te::da::PrimaryKey::add(), te::da::UniqueKey::add(), te::da::ForeignKey::addRefProperty(), and te::dt::new_clone().

◆ getDatasetName()

const std::string & te::dt::Property::getDatasetName ( ) const

inline

It returns the name of the propery's dataset.

Returns: The the propery's dataset name.

Definition at line 144 of file Property.h.

◆ getId()

unsigned int te::dt::Property::getId ( ) const

inline

It returns the property identifier.

Returns: A number used to identify the property.

Warning: The identifier value may be used by data source implementations. So, don't rely on its value!

Definition at line 109 of file Property.h.

◆ getName()

const std::string & te::dt::Property::getName ( ) const

inline

It returns the property name.

Returns: The property name.

Note: For DataSetTypes the name can have namespace prefix or schema name prefix, it will depend on the data source implementation.

Definition at line 127 of file Property.h.

◆ getParent()

Property * te::dt::Property::getParent ( ) const

inline

It returns the parent of this property, or NULL, if it doesn't have one.

Returns: The parent of this property, or NULL, if it doesn't have one.

Definition at line 168 of file Property.h.

◆ getType()

int te::dt::Property::getType ( ) const

inline

It returns the property data type.

Returns: The property data type.

Definition at line 161 of file Property.h.

Referenced by te::dt::CompositeProperty::findFirstPropertyOfType().

◆ has()

virtual bool te::dt::Property::has ( Property * p ) const

pure virtual

It checks if the Property "p" is associated to this property or any other parent.

This method can be used to ask if a given Property belongs to a more complex type (like: CompositeProperty or DataSetType).

Parameters

p	The Property we are checking.

Returns: True if the given Property "p" is associated to to this Property, otherwise, returns false.

Implemented in te::dt::CompositeProperty, and te::dt::SimpleProperty.

◆ operator=()

Property & te::dt::Property::operator= ( const Property & rhs )

Assignment operator.

Parameters

rhs	The right-hand-side copy used to copy from.

Returns: A reference to this object.

Note: Assignment operator doesn't preserve parent relationship.

◆ setDatasetName()

void te::dt::Property::setDatasetName ( const std::string & dsName )

inline

It sets the property name.

Parameters

name	The new property name.

Warning: Take care when calling this method for a DataSetType associated to a DataSourceCatalog. Prefer using the rename method on the DataSourceCatalog API instead of using this method.

Definition at line 154 of file Property.h.

◆ setId()

void te::dt::Property::setId ( unsigned int id )

inline

It sets the property identifier.

Parameters

id	A number used to identify the property.

Warning: The identifier value may be used by data source implementations. So, don't rely on its value!

Definition at line 118 of file Property.h.

◆ setName()

void te::dt::Property::setName ( const std::string & name )

inline

It sets the property name.

Parameters

name	The new property name.

Warning: Take care when calling this method for a DataSetType associated to a DataSourceCatalog. Prefer using the rename method on the DataSourceCatalog API instead of using this method.

Definition at line 137 of file Property.h.

◆ setParent()

void te::dt::Property::setParent ( Property * p )

inline

It associate this property to the informed parent.

Parameters

p	Teh parent property.

Warning: Don't use this method without knowing the internal details of its use.

Definition at line 177 of file Property.h.

Member Data Documentation

◆ m_datasetName

std::string te::dt::Property::m_datasetName

protected

The property's dataset name.

Definition at line 208 of file Property.h.

◆ m_id

unsigned int te::dt::Property::m_id

protected

An identification number that can be used internally.

Definition at line 205 of file Property.h.

◆ m_name

std::string te::dt::Property::m_name

protected

The property name.

Definition at line 207 of file Property.h.

◆ m_parent

Property* te::dt::Property::m_parent

protected

The parent property type: it must be a CompositeProperty.

Definition at line 204 of file Property.h.

◆ m_type

int te::dt::Property::m_type

protected

The property data type.

Definition at line 206 of file Property.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/datatype/Property.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Property() [1/2]

◆ Property() [2/2]

◆ ~Property()

Member Function Documentation

◆ clone()

◆ getDatasetName()

◆ getId()

◆ getName()

◆ getParent()

◆ getType()

◆ has()

◆ operator=()

◆ setDatasetName()

◆ setId()

◆ setName()

◆ setParent()

Member Data Documentation

◆ m_datasetName

◆ m_id

◆ m_name

◆ m_parent

◆ m_type