KeyImpl Class Reference

This class represents a generated (concrete version of a) KeyDef. More...

#include <KeyImpl.h>

Inheritance diagram for KeyImpl:

[legend]

List of all members.

Public Member Functions
	KeyImpl (TableImplPtr nativeTable, TableImplPtr foreignTable, cstring name, bool primary, bool lookup=false)
	Construct a foreign key belonging to the specified native table to the specified foreign table with the specified name.
	~KeyImpl ()
	Destructor, a noop.
FieldValuePtr	newValue ()
	Returns a new FieldValue for this field.
TableImplPtr	getForeignTable () const
	Returns the foreign table this key points to, is equal to the native table in the case of a native key.
bool	isKey () const
	Returns that this is a key field.
bool	isPrimaryKey () const
	Returns wether this field is a primary key.
bool	isForeignKey () const
	Returns whether this is a foreign key.

---

Detailed Description

This class represents a generated (concrete version of a) KeyDef.

This class should not be instantiated manually. Instead, the generated ones contained in TableImpls should be used.

See also:

KeyDef

TableImpls

FieldImpl

Definition at line 42 of file KeyImpl.h.

---

Constructor & Destructor Documentation

KeyImpl::KeyImpl	(	TableImplPtr	nativeTable,
		TableImplPtr	foreignTable,
		cstring	name,
		bool	primary,
		bool	lookup = false
	)

Construct a foreign key belonging to the specified native table to the specified foreign table with the specified name.

KeyImpl::~KeyImpl

(

)

[inline]

Destructor, a noop.

Definition at line 49 of file KeyImpl.h.

---

Member Function Documentation

FieldValuePtr KeyImpl::newValue

(

)

[virtual]

Returns a new FieldValue for this field.

Reimplemented from FieldImpl.

TableImplPtr KeyImpl::getForeignTable

(

)

const

Returns the foreign table this key points to, is equal to the native table in the case of a native key.

bool KeyImpl::isKey

(

)

const [inline, virtual]

Returns that this is a key field.

Reimplemented from FieldImpl.

Definition at line 60 of file KeyImpl.h.

bool KeyImpl::isPrimaryKey

(

)

const [inline, virtual]

Returns wether this field is a primary key.

Reimplemented from FieldImpl.

Definition at line 62 of file KeyImpl.h.

bool KeyImpl::isForeignKey

(

)

const

Returns whether this is a foreign key.

---