It describes a primary key (pk) constraint. More...

#include <PrimaryKey.h>

Inheritance diagram for te::da::PrimaryKey:

Public Member Functions
void	add (const te::dt::Property *p)
	It adds a property to the list of properties of the primary key.

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

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

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

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

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

const std::vector< te::dt::Property * > &	getProperties () const
	It returns the properties that take part of the primary key.

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

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

PrimaryKey &	operator= (const PrimaryKey &rhs)
	Assignment operator.

	PrimaryKey (const PrimaryKey &rhs)
	Copy constructor.

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

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

void	replace (const std::string &propName, const te::dt::Property *pp)
	It changes a reference to property p to pp.

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

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

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

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

	~PrimaryKey ()
	Destructor.

Private Attributes
DataSetType *	m_dt
	The associated DataSetType.

unsigned int	m_id
	An identification number for the constraint.

Index *	m_index
	A pointer to an associated index.

std::string	m_name
	The constraint name.

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

Detailed Description

It describes a primary key (pk) constraint.

See also: DataSetType, UniqueKey, ForeignKey, CheckConstraint

Definition at line 48 of file PrimaryKey.h.

Constructor & Destructor Documentation

◆ PrimaryKey() [1/3]

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

Constructor.

Parameters

dt	The DataSetType associated to the pk.
id	The pk identifier.

Postcondition: If dt is provided, the pk 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!

Referenced by operator=(), and PrimaryKey().

◆ PrimaryKey() [2/3]

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

Constructor.

Parameters

name	The primary key constraint name.
dt	The DataSetType associated to the pk.
id	The pk identifier.

Postcondition: If dt is provided, the pk 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!

◆ PrimaryKey() [3/3]

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

Copy constructor.

The new object will not have an assigned DataSetType.

Parameters

rhs	Right-hand-side instance.

References PrimaryKey().

◆ ~PrimaryKey()

te::da::PrimaryKey::~PrimaryKey ( )

Destructor.

Member Function Documentation

◆ add()

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

inline

It adds a property to the list of properties of the primary key.

Parameters

p	The property that will take part of the primary key.

Definition at line 112 of file PrimaryKey.h.

References te::dt::Property::clone(), and m_properties.

◆ clone()

Constraint * te::da::PrimaryKey::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.

References te::da::Constraint::Constraint().

◆ getAssociatedIndex()

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

inline

It returns the associated index if one exists.

Returns: An associated index if one exists.

Definition at line 126 of file PrimaryKey.h.

References m_index.

◆ 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.

References m_dt.

◆ 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.

References m_id.

◆ 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.

References m_name.

◆ getProperties()

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

inline

It returns the properties that take part of the primary key.

Returns: The properties that take part of the primary key.

Definition at line 105 of file PrimaryKey.h.

References m_properties.

◆ getType()

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

inlinevirtual

It returns the constraint type: PRIMARYKEY.

Returns: The constraint type PRIMARYKEY.

Implements te::da::Constraint.

Definition at line 152 of file PrimaryKey.h.

References te::da::PRIMARY_KEY.

◆ has()

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

It verifies if Property is associated to the primary key.

Parameters

propertyName The Propertyname to be verified.

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

◆ operator=()

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

Assignment operator.

The new object will not have an assigned DataSetType.

Parameters

rhs	Right-hand-side instance.

Returns: A reference to this.

References PrimaryKey().

◆ replace()

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

It changes a reference to property p to pp.

Parameters

propName	A property name that takes part of the primary key.
pp	The property that will take p place.

Note: If p is not found in the primary key attribute list this method does nothing.

◆ setAssociatedIndex()

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

It sets the associated index.

Parameters

idx	If the primary key is associated to an index, this method will associate them.

◆ 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.

References m_dt.

◆ 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.

References m_id.

◆ 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.

References m_name.

Member Data Documentation

◆ m_dt

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

privateinherited

The associated DataSetType.

Definition at line 166 of file Constraint.h.

Referenced by getDataSetType(), and setDataSetType().

◆ m_id

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

privateinherited

An identification number for the constraint.

Definition at line 165 of file Constraint.h.

Referenced by getId(), and setId().

◆ m_index

Index* te::da::PrimaryKey::m_index

private

A pointer to an associated index.

Definition at line 165 of file PrimaryKey.h.

Referenced by getAssociatedIndex().

◆ m_name

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

privateinherited

The constraint name.

Definition at line 167 of file Constraint.h.

Referenced by getName(), and setName().

◆ m_properties

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

private

The properties that take part of primary key constraint.

Definition at line 166 of file PrimaryKey.h.

Referenced by add(), and getProperties().

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PrimaryKey() [1/3]

◆ PrimaryKey() [2/3]

◆ PrimaryKey() [3/3]

◆ ~PrimaryKey()

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