It models a foreign key constraint for a DataSetType. More...

#include <ForeignKey.h>

Inheritance diagram for te::da::ForeignKey:

Public Member Functions
void	add (const te::dt::Property *p)
	It adds a property to the foreign key constraint. More...

void	addRefProperty (const te::dt::Property *p)
	It adds a reference property (on the referenced DataSetType) of this foreign key constraint. More...

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

	ForeignKey (const ForeignKey &rhs)
	Copy constructor not allowed. More...

	ForeignKey (const std::string &name, unsigned int id=0)
	Constructor. More...

	ForeignKey (unsigned int id=0)
	Constructor. 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...

FKActionType	getOnDeleteAction () const
	It returns the action performed when a referenced element value in the referenced DataSetType is being deleted. More...

FKActionType	getOnUpdateAction () const
	It returns the action performed when a referenced element value in the referenced DataSetType is being updated to a new value. More...

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

DataSetType *	getReferencedDataSetType () const
	It returns the referenced DataSetType of this foreign key constraint. More...

const std::vector< te::dt::Property * > &	getReferencedProperties () const
	It returns the referenced properties (on the referenced DataSetType) of this foreign key constraint. More...

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

bool	has (const std::string &propertyName)
	It verifies if Property takes part of the foreign key. More...

bool	isReferenced (const std::string &propertyName)
	It verifies if Property is referenced by the foreign key. More...

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

void	replace (const std::string &propName, const te::dt::Property *pp)
	It changes a reference to property p to pp. 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...

void	setOnDeleteAction (FKActionType a)
	It sets the action to be performed when a referenced element value in the referenced DataSetType is being deleted. More...

void	setOnUpdateAction (FKActionType a)
	It sets the action to be performed when a referenced element value in the referenced DataSetType is being updated to a new value. More...

void	setReferencedDataSetType (DataSetType *refDt)
	It sets the referenced DataSetType of this foreign key constraint. More...

	~ForeignKey ()
	Destructor. More...

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

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

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

FKActionType	m_onDelete
	The action to be performed when a referenced element value in the referenced DataSetType is being deleted. More...

FKActionType	m_onUpdate
	The action to be performed when a referenced element value in the referenced DataSetType is being updated to a new value. More...

std::vector< te::dt::Property * >	m_properties
	The properties that are part of the foreign key constraint. More...

DataSetType *	m_refDt
	The referenced DataSetType of this foreign key constraint. More...

std::vector< te::dt::Property * >	m_refProperties
	The referenced properties (on the referenced DataSetType) of this foreign key constraint. More...

Detailed Description

It models a foreign key constraint for a DataSetType.

See also: DataSetType, PrimaryKey, UniqueKey, CheckConstraint

Definition at line 48 of file ForeignKey.h.

Constructor & Destructor Documentation

◆ ForeignKey() [1/3]

te::da::ForeignKey::ForeignKey ( unsigned int id = 0 )

Constructor.

The default fk will have the actions OnDelete and OnUpdate set as NO_ACTION.

Parameters

id	The fk identifier.

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

◆ ForeignKey() [2/3]

te::da::ForeignKey::ForeignKey	(	const std::string &	name,
		unsigned int	id = `0`
	)

Constructor.

Parameters

name	The foreign key constraint name.
id	The fk identifier.

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

◆ ForeignKey() [3/3]

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

Copy constructor not allowed.

The new object will not have an associated DataSetType.

Parameters

rhs	Right-hand-side instance.

◆ ~ForeignKey()

te::da::ForeignKey::~ForeignKey ( )

Destructor.

Member Function Documentation

◆ add()

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

inline

It adds a property to the foreign key constraint.

Parameters

p	The property to be added to the foreign key constraint.

Precondition: All properties added must belong to the same DataSetType.

Definition at line 110 of file ForeignKey.h.

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

◆ addRefProperty()

void te::da::ForeignKey::addRefProperty ( const te::dt::Property * p )

inline

It adds a reference property (on the referenced DataSetType) of this foreign key constraint.

Parameters

p	The referenced property (on the referenced DataSetType) of this foreign key constraint.

Precondition: All properties being added must reference the same DataSetType.

Definition at line 126 of file ForeignKey.h.

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

◆ clone()

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

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

◆ getOnDeleteAction()

FKActionType te::da::ForeignKey::getOnDeleteAction ( ) const

inline

It returns the action performed when a referenced element value in the referenced DataSetType is being deleted.

Returns: The action performed when a referenced element value in the referenced DataSetType is being deleted.

Definition at line 147 of file ForeignKey.h.

◆ getOnUpdateAction()

FKActionType te::da::ForeignKey::getOnUpdateAction ( ) const

inline

It returns the action performed when a referenced element value in the referenced DataSetType is being updated to a new value.

Returns: The action performed when a referenced element value in the referenced DataSetType is being updated to a new value.

Definition at line 161 of file ForeignKey.h.

◆ getProperties()

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

inline

It returns the properties that take part of the foreign key constraint.

Returns: The properties that take part of the foreign key constraint.

Definition at line 101 of file ForeignKey.h.

◆ getReferencedDataSetType()

DataSetType* te::da::ForeignKey::getReferencedDataSetType ( ) const

inline

It returns the referenced DataSetType of this foreign key constraint.

Returns: The referenced DataSetType of this foreign key constraint.

Definition at line 133 of file ForeignKey.h.

◆ getReferencedProperties()

const std::vector<te::dt::Property*>& te::da::ForeignKey::getReferencedProperties ( ) const

inline

It returns the referenced properties (on the referenced DataSetType) of this foreign key constraint.

Returns: The referenced properties (on the referenced DataSetType) of this foreign key constraint.

Definition at line 117 of file ForeignKey.h.

◆ getType()

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

inlinevirtual

It returns the constraint type: FOREIGNKEY.

Returns: The constraint type FOREIGNKEY.

Implements te::da::Constraint.

Definition at line 205 of file ForeignKey.h.

References te::da::FOREIGN_KEY.

◆ has()

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

It verifies if Property takes part of the foreign key.

Parameters

propertyName The Property name to be verified.

Returns: True if Property takes part of the foreign key, false otherwise.

◆ isReferenced()

bool te::da::ForeignKey::isReferenced ( const std::string & propertyName )

It verifies if Property is referenced by the foreign key.

Parameters

propertyName The Property name to be verified.

Returns: True if Property is referenced by the foreign key, false otherwise.

◆ operator=()

ForeignKey& te::da::ForeignKey::operator= ( const ForeignKey & 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::ForeignKey::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 foreign key or is referenced by it.
pp	The property that will take p place.

Note: This method will replace property checking both property list (referenced and the properties in the fk).; If the property p is not in the fk attribute list this method does nothing.

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

◆ setOnDeleteAction()

void te::da::ForeignKey::setOnDeleteAction ( FKActionType a )

inline

It sets the action to be performed when a referenced element value in the referenced DataSetType is being deleted.

Parameters

a	The action to be performed when a referenced element value in the referenced DataSetType is being deleted.

Definition at line 154 of file ForeignKey.h.

◆ setOnUpdateAction()

void te::da::ForeignKey::setOnUpdateAction ( FKActionType a )

inline

It sets the action to be performed when a referenced element value in the referenced DataSetType is being updated to a new value.

Parameters

a	The action to be performed when a referenced element value in the referenced DataSetType is being updated to a new value.

Definition at line 168 of file ForeignKey.h.

◆ setReferencedDataSetType()

void te::da::ForeignKey::setReferencedDataSetType ( DataSetType * refDt )

inline

It sets the referenced DataSetType of this foreign key constraint.

Parameters

refDt The referenced DataSetType of this foreign key constraint.

Definition at line 140 of file ForeignKey.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_name

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

privateinherited

The constraint name.

Definition at line 167 of file Constraint.h.

◆ m_onDelete

FKActionType te::da::ForeignKey::m_onDelete

private

The action to be performed when a referenced element value in the referenced DataSetType is being deleted.

Definition at line 218 of file ForeignKey.h.

◆ m_onUpdate

FKActionType te::da::ForeignKey::m_onUpdate

private

The action to be performed when a referenced element value in the referenced DataSetType is being updated to a new value.

Definition at line 219 of file ForeignKey.h.

◆ m_properties

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

private

The properties that are part of the foreign key constraint.

Definition at line 221 of file ForeignKey.h.

◆ m_refDt

DataSetType* te::da::ForeignKey::m_refDt

private

The referenced DataSetType of this foreign key constraint.

Definition at line 220 of file ForeignKey.h.

◆ m_refProperties

std::vector<te::dt::Property*> te::da::ForeignKey::m_refProperties

private

The referenced properties (on the referenced DataSetType) of this foreign key constraint.

Definition at line 222 of file ForeignKey.h.

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ForeignKey() [1/3]

◆ ForeignKey() [2/3]

◆ ForeignKey() [3/3]

◆ ~ForeignKey()

Member Function Documentation

◆ add()

◆ addRefProperty()

◆ clone()

◆ getDataSetType()

◆ getId()

◆ getName()

◆ getOnDeleteAction()

◆ getOnUpdateAction()

◆ getProperties()

◆ getReferencedDataSetType()

◆ getReferencedProperties()

◆ getType()

◆ has()

◆ isReferenced()

◆ operator=()

◆ replace()

◆ setDataSetType()

◆ setId()

◆ setName()

◆ setOnDeleteAction()

◆ setOnUpdateAction()

◆ setReferencedDataSetType()

Member Data Documentation

◆ m_dt

◆ m_id

◆ m_name

◆ m_onDelete

◆ m_onUpdate

◆ m_properties

◆ m_refDt

◆ m_refProperties