Db::Relation Class Reference

#include <relation.h>

Detailed Description

A Relation object describes a relation between 2 tables which are linked through a common attribute.

Copyright

(C) 2006 Radon Labs GmbH (C) 2013-2016 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Public Member Functions
	Relation ()
	constructor
virtual	~Relation ()
	destructor
void	SetParent (const Ptr< Table > &table, const Attr::AttrId &columnId)
	set the parent table and column id
const Ptr< Table > &	GetParentTable () const
	get parent table
const Attr::AttrId &	GetParentColumnId () const
	get parent column id
void	SetChild (const Ptr< Table > &table, const Attr::AttrId &columnId)
	set child table and column id
const Ptr< Table > &	GetChildTable () const
	get child table
const Attr::AttrId &	GetChildColumnId () const
	get child column id
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (Relation)

Private Attributes
Ptr< Table >	parentTable
Attr::AttrId	parentColumnId
Ptr< Table >	childTable
Attr::AttrId	childColumnId

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

Relation()

Db::Relation::Relation

(

)

constructor

~Relation()

Db::Relation::~Relation ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Db::Relation::__DeclareClass ( Relation )

private

GetChildColumnId()

const Attr::AttrId & Db::Relation::GetChildColumnId ( ) const

inline

get child column id

GetChildTable()

const Ptr< Table > & Db::Relation::GetChildTable ( ) const

inline

get child table

GetParentColumnId()

const Attr::AttrId & Db::Relation::GetParentColumnId ( ) const

inline

get parent column id

GetParentTable()

const Ptr< Table > & Db::Relation::GetParentTable ( ) const

inline

get parent table

SetChild()

void Db::Relation::SetChild ( const Ptr< Table > & table, const Attr::AttrId & columnId )

inline

set child table and column id

SetParent()

void Db::Relation::SetParent ( const Ptr< Table > & table, const Attr::AttrId & columnId )

inline

set the parent table and column id

Member Data Documentation

childColumnId

Attr::AttrId Db::Relation::childColumnId

private

childTable

Ptr<Table> Db::Relation::childTable

private

parentColumnId

Attr::AttrId Db::Relation::parentColumnId

private

parentTable

Ptr<Table> Db::Relation::parentTable

private

---

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

• /github/workspace/code/addons/db/relation.h
• /github/workspace/code/addons/db/relation.cc