KeyDef Class Reference

This class represents the definition of a key field in a table. More...

#include <KeyDef.h>

Inheritance diagram for KeyDef:

[legend]

List of all members.

Public Member Functions
	KeyDef (TableDefPtr foreignTable, cstring name, bool primary)
	Constructs a key for the specified foreign table with the specified name.
	~KeyDef ()
	Destructor, a noop.
bool	isKey () const
	Returns that this field is a key field.
bool	isPrimaryKey () const
	Whether this field is a primary key field.
TableDefPtr	getForeignTable ()
	Returns the foreign table for this key, is NULL for native keys.

---

Detailed Description

This class represents the definition of a key field in a table.

Based on this class KeyImpl's will be generated.

Definition at line 38 of file KeyDef.h.

---

Constructor & Destructor Documentation

KeyDef::KeyDef	(	TableDefPtr	foreignTable,
		cstring	name,
		bool	primary
	)			[inline]

Constructs a key for the specified foreign table with the specified name.

Definition at line 42 of file KeyDef.h.

KeyDef::~KeyDef

(

)

[inline]

Destructor, a noop.

Definition at line 45 of file KeyDef.h.

---

Member Function Documentation

bool KeyDef::isKey

(

)

const [inline, virtual]

Returns that this field is a key field.

Reimplemented from FieldDef.

Definition at line 49 of file KeyDef.h.

bool KeyDef::isPrimaryKey

(

)

const [inline, virtual]

Whether this field is a primary key field.

Reimplemented from FieldDef.

Definition at line 52 of file KeyDef.h.

TableDefPtr KeyDef::getForeignTable

(

)

[inline]

Returns the foreign table for this key, is NULL for native keys.

Definition at line 55 of file KeyDef.h.

---