It describes a unique key (uk) constraint. More...

#include <UniqueKey.h>

Inheritance diagram for te::da::UniqueKey:

Public Member Functions
void	add (const te::dt::Property *p)
	It adds the property to the list of properties that participates in the unique key. More...

Constraint *	clone ()
	It returns a clone of the object. More...

Index *	getAssociatedIndex () const
	It returns the associated index if one exists. More...

virtual DataSetType *	getDataSetType () const
	It returns the DataSetType associated to the constraint. More...

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

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

const std::vector< te::dt::Property * > &	getProperties () const
	It returns the properties that form the unique key. More...

ConstraintType	getType () const
	It returns the constraint type: UNIQUEKEY. More...

bool	has (const std::string &propertyName) const
	It verifies if Property is associated to the unique key. More...

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

void	replace (const std::string &propName, const te::dt::Property *pp)

void	setAssociatedIndex (const Index *idx)
	It sets the associated index. More...

virtual void	setDataSetType (DataSetType *dt)
	It sets the DataSetType associated to the constraint. More...

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

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

	UniqueKey (const std::string &name, DataSetType *dt=0, unsigned int id=0)
	Constructor. More...

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

	UniqueKey (DataSetType *dt=0, unsigned int id=0)
	Constructor. More...

	~UniqueKey ()
	Destructor. More...

Private Attributes
DataSetType *	m_dt
	The associated DataSetType. More...

unsigned int	m_id
	An identification number for the constraint. More...

Index *	m_index
	A pointer to an associated index. More...

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

std::vector< te::dt::Property * >	m_properties
	The properties that take part of primary key constraint. More...

Detailed Description

It describes a unique key (uk) constraint.

See also: DataSetType, Index, PrimaryKey, ForeignKey, DataSetTypeCheckRestriction

Definition at line 49 of file UniqueKey.h.

Constructor & Destructor Documentation

◆ UniqueKey() [1/3]

te::da::UniqueKey::UniqueKey	(	DataSetType *	dt = `0`,
		unsigned int	id = `0`
	)

Constructor.

Parameters

dt	The DataSetType associated to this uk.
id	The uk identifier.

Postcondition: If dt is provided, the uk will belong to the given DataSetType.

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

◆ UniqueKey() [2/3]

te::da::UniqueKey::UniqueKey	(	const std::string &	name,
		DataSetType *	dt = `0`,
		unsigned int	id = `0`
	)

Constructor.

Parameters

name	The unique key (uk) constraint name.
dt	The DataSetType associated to this uk.
id	The uk identifier.

Postcondition: If dt is provided, the uk will belong to the given DataSetType.

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

◆ UniqueKey() [3/3]

te::da::UniqueKey::UniqueKey ( const UniqueKey & rhs )

Copy constructor.

The new object will not have an associated DataSetType.

Parameters

rhs	Right-hand-side instance.

◆ ~UniqueKey()

te::da::UniqueKey::~UniqueKey ( )

Destructor.

Member Function Documentation

◆ add()

void te::da::UniqueKey::add ( const te::dt::Property * p )

inline

It adds the property to the list of properties that participates in the unique key.

Parameters

p	The Property that will take part of the unique key.

Definition at line 113 of file UniqueKey.h.

References te::dt::Property::clone().

◆ clone()

Constraint * te::da::UniqueKey::clone ( )

virtual

It returns a clone of the object.

The new object will not have an associated DataSetType.

Returns: A clone of the object.

Implements te::da::Constraint.

◆ getAssociatedIndex()

Index * te::da::UniqueKey::getAssociatedIndex ( ) const

inline

It returns the associated index if one exists.

Returns: An associated index if one exists.

Definition at line 120 of file UniqueKey.h.

◆ getDataSetType()

virtual DataSetType * te::da::Constraint::getDataSetType ( ) const

inlinevirtualinherited

It returns the DataSetType associated to the constraint.

Returns: The DataSetType associated to the constraint.

Definition at line 133 of file Constraint.h.

◆ getId()

virtual unsigned int te::da::Constraint::getId ( ) const

inlinevirtualinherited

It returns the constraint identifier.

Returns: A number that identifies the constraint.

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

Definition at line 103 of file Constraint.h.

◆ getName()

virtual const std::string & te::da::Constraint::getName ( ) const

inlinevirtualinherited

It returns the constraint name.

Returns: The constraint name.

Definition at line 119 of file Constraint.h.

◆ getProperties()

const std::vector< te::dt::Property * > & te::da::UniqueKey::getProperties ( ) const

inline

It returns the properties that form the unique key.

Returns: The properties that form the unique key.

Definition at line 106 of file UniqueKey.h.

◆ getType()

ConstraintType te::da::UniqueKey::getType ( ) const

inlinevirtual

It returns the constraint type: UNIQUEKEY.

Returns: The constraint type UNIQUEKEY.

Implements te::da::Constraint.

Definition at line 153 of file UniqueKey.h.

References te::da::UNIQUE_KEY.

◆ has()

bool te::da::UniqueKey::has ( const std::string & propertyName ) const

It verifies if Property is associated to the unique key.

Parameters

propertyName The Property name to be verified.

Returns: True if Property is associated to the unique key, false otherwise.

◆ operator=()

UniqueKey & te::da::UniqueKey::operator= ( const UniqueKey & rhs )

Assignment operator.

The new object will not have an assigned DataSetType.

Parameters

rhs	Right-hand-side instance.

Returns: A reference to this.

◆ replace()

void te::da::UniqueKey::replace	(	const std::string &	propName,
		const te::dt::Property *	pp
	)

◆ setAssociatedIndex()

void te::da::UniqueKey::setAssociatedIndex ( const Index * idx )

It sets the associated index.

Parameters

idx	A index associated to the unique key.

◆ setDataSetType()

virtual void te::da::Constraint::setDataSetType ( DataSetType * dt )

inlinevirtualinherited

It sets the DataSetType associated to the constraint.

Parameters

dt	The DataSetType associated to this constraint.

Warning: Take care when calling this method. If the constraint belongs to a DataSetType, remember to detach it from the DataSetType before calling this method.

Definition at line 143 of file Constraint.h.

◆ setId()

virtual void te::da::Constraint::setId ( unsigned int id )

inlinevirtualinherited

It sets the constraint identifier.

Parameters

id	A number that identifies the constraint.

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

Definition at line 112 of file Constraint.h.

◆ setName()

virtual void te::da::Constraint::setName ( const std::string & name )

inlinevirtualinherited

It sets the constraint name.

Parameters

name	The constraint name.

Definition at line 126 of file Constraint.h.

Member Data Documentation

◆ m_dt

DataSetType* te::da::Constraint::m_dt

privateinherited

The associated DataSetType.

Definition at line 166 of file Constraint.h.

◆ m_id

unsigned int te::da::Constraint::m_id

privateinherited

An identification number for the constraint.

Definition at line 165 of file Constraint.h.

◆ m_index

Index* te::da::UniqueKey::m_index

private

A pointer to an associated index.

Definition at line 166 of file UniqueKey.h.

◆ m_name

std::string te::da::Constraint::m_name

privateinherited

The constraint name.

Definition at line 167 of file Constraint.h.

◆ m_properties

std::vector<te::dt::Property*> te::da::UniqueKey::m_properties

private

The properties that take part of primary key constraint.

Definition at line 167 of file UniqueKey.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/dataaccess/dataset/UniqueKey.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UniqueKey() [1/3]

◆ UniqueKey() [2/3]

◆ UniqueKey() [3/3]

◆ ~UniqueKey()

Member Function Documentation

◆ add()

◆ clone()

◆ getAssociatedIndex()

◆ getDataSetType()

◆ getId()

◆ getName()

◆ getProperties()

◆ getType()

◆ has()

◆ operator=()

◆ replace()

◆ setAssociatedIndex()

◆ setDataSetType()

◆ setId()

◆ setName()

Member Data Documentation

◆ m_dt

◆ m_id

◆ m_index

◆ m_name

◆ m_properties