KexiDB::IndexSchema Class Reference

#include <indexschema.h>

Inheritance diagram for KexiDB::IndexSchema:

Detailed Description

Provides information about database index that can be created for a database table.

IndexSchema object stores information about table fields that defines this index and additional properties like: whether index is unique or primary key (requires unique). Single-field index can be also auto generated.

Definition at line 43 of file indexschema.h.

Public Types

typedef QPtrList< IndexSchema > List

typedef QPtrListIterator<
IndexSchema > ListIterator

Public Member Functions

IndexSchema (TableSchema *tableSchema)

IndexSchema (const IndexSchema &idx, TableSchema &parentTable)

virtual ~IndexSchema ()

virtual FieldList & addField (Field *field)

TableSchema * table () const

Relationship::List * masterRelationships ()

Relationship::List * detailsRelationships ()

void attachRelationship (Relationship *rel)

void detachRelationship (Relationship *rel)

bool isAutoGenerated () const

bool isPrimaryKey () const

void setPrimaryKey (bool set)

bool isUnique () const

void setUnique (bool set)

virtual QString debugString ()

Protected Member Functions

void setAutoGenerated (bool set)

void setForeignKey (bool set)

void attachRelationship (Relationship *rel, bool ownedByMaster)

Protected Attributes

TableSchema * m_tableSchema

Relationship::List m_master_owned_rels

table on that index is built

Relationship::List m_master_rels

Relationship::List m_details_rels

bool m_primary: 1

bool m_unique: 1

bool m_isAutoGenerated: 1

bool m_isForeignKey: 1

Friends

class Connection

class TableSchema

class QuerySchema

class Relationship

Member Typedef Documentation

typedef QPtrList<IndexSchema> KexiDB::IndexSchema::List

Definition at line 46 of file indexschema.h.

typedef QPtrListIterator<IndexSchema> KexiDB::IndexSchema::ListIterator

Definition at line 47 of file indexschema.h.

Constructor & Destructor Documentation

IndexSchema::IndexSchema ( TableSchema * tableSchema )

Constructs empty index schema object that is assigned to table, and will be owned by this table. Any fields added with addField() won't be owned by index, but by its table. Do not forget to add these fields to table, because adding these to IndexSchema is not enough.
Definition at line 32 of file indexschema.cpp.
References m_master_owned_rels.

IndexSchema::IndexSchema ( const IndexSchema & idx,

TableSchema & parentTable

)

Copy constructor. Copies all attributes from index idx, and fields assigned with it but the fields are taken (by name) from parentTable, not from idx itself, so it's possible to copy of index for a copy of table.
To copy an index within the same table it's enough to call:
new IndexSchema(idx, *idx.table());

Todo:
All relationships should be also copied

Definition at line 44 of file indexschema.cpp.
References addField(), KexiDB::FieldList::clear(), KexiDB::FieldList::field(), KexiDBWarn, and m_master_owned_rels.

IndexSchema::~IndexSchema ( ) [virtual]

Destroys the index. Field objects are not deleted. All Relationship objects listed in masterRelationships() list are destroyed (these are also detached from detail-side indices before destruction). Relationship objects listed in detailsRelationships() are not touched.
Definition at line 75 of file indexschema.cpp.
References m_master_owned_rels.

Member Function Documentation

FieldList & IndexSchema::addField ( Field * field ) [virtual]

Adds field at the end of field list. Field will not be owned by index. Field must belong to a table the index is bulit on, otherwise field couldn't be added.
Definition at line 91 of file indexschema.cpp.
References KexiDB::FieldList::addField(), KexiDBDbg, m_tableSchema, KexiDB::Field::name(), and KexiDB::Field::table().
Referenced by KexiDB::Relationship::createIndices(), IndexSchema(), and KexiDB::TableSchema::insertField().

void IndexSchema::attachRelationship ( Relationship * rel,

bool ownedByMaster

) [protected]

Internal version of attachRelationship(). If ownedByMaster is true, attached rel object will be owned by this index.
Definition at line 169 of file indexschema.cpp.
References KexiDB::Relationship::detailsIndex(), m_details_rels, m_master_owned_rels, m_master_rels, and KexiDB::Relationship::masterIndex().

void IndexSchema::attachRelationship ( Relationship * rel )

Attaches relationship definition rel to this IndexSchema object. If rel relationship has this IndexSchema defined at the master-side, rel is added to the list of master relationships (available with masterRelationships()). If rel relationship has this IndexSchema defined at the details-side, rel is added to the list of details relationships (available with detailsRelationships()). For the former case, attached rel object is now owned by this IndexSchema object.
Note: call detachRelationship() for IndexSchema object that rel was previously attached to, if any.
Definition at line 164 of file indexschema.cpp.
Referenced by KexiDB::Relationship::setIndices().

QString IndexSchema::debugString ( ) [virtual]

Returns:
String for debugging purposes.

Reimplemented from KexiDB::FieldList.
Definition at line 154 of file indexschema.cpp.
References KexiDB::FieldList::debugString(), m_isAutoGenerated, m_isForeignKey, m_primary, m_unique, and KexiDB::SchemaData::schemaDataDebugString().

void IndexSchema::detachRelationship ( Relationship * rel )

Detaches relationship definition rel for this IndexSchema object from the list of master relationships (available with masterRelationships()), or from details relationships list, depending for which side of the relationship is this IndexSchem object assigned.
Note: If rel was detached from masterRelationships() list, this object now has no parent, so you need to attach it to somewhere or destruct it.
Definition at line 192 of file indexschema.cpp.
References m_details_rels, m_master_owned_rels, and m_master_rels.

Relationship::List* KexiDB::IndexSchema::detailsRelationships ( ) [inline]

Returns:
list of relationships to the table (of this index), i.e. any such relationship in which this table is at 'details' side. See Relationship class documentation for more information.

Definition at line 94 of file indexschema.h.
Referenced by KexiCellEditorFactory::createEditor().

bool IndexSchema::isAutoGenerated ( ) const

Returns:
true if index is auto-generated. Auto-generated index is one-field index that was automatically generated for CREATE TABLE statement when the field has UNIQUE or PRIMARY KEY constraint enabled.
Any newly created IndexSchema object has this flag set to false.
This flag is handled internally by TableSchema. It can be usable for GUI application if we do not want display implicity/auto generated indices on the indices list or we if want to show these indices to the user in a special way.
Definition at line 109 of file indexschema.cpp.
References m_isAutoGenerated.

bool IndexSchema::isPrimaryKey ( ) const

Returns:
true if this index is primary key of its table. This can be one or multifield.

Definition at line 119 of file indexschema.cpp.
References m_primary.

bool IndexSchema::isUnique ( ) const

Returns:
true if this is unique index. This can be one or multifield.

Definition at line 131 of file indexschema.cpp.
References m_unique.

Relationship::List* KexiDB::IndexSchema::masterRelationships ( ) [inline]

Returns:
list of relationships from the table (of this index), i.e. any such relationship in which this table is at 'master' side. See Relationship class documentation for more information. All objects listed here will be automatically destroyed on this IndexSchema object destruction.

Definition at line 89 of file indexschema.h.

void IndexSchema::setAutoGenerated ( bool set ) [protected]

Sets auto-generated flag. This method should be called only from TableSchema code
See also:
isAutoGenerated().

Definition at line 114 of file indexschema.cpp.
References m_isAutoGenerated.
Referenced by KexiDB::TableSchema::insertField().

void IndexSchema::setForeignKey ( bool set ) [protected]

If set is true, declares that the index defines a foreign key, created implicity for Relationship object. Setting this to true, implies clearing 'primary key', 'unique' and 'auto generated' flags. If this index contains just single field, it's 'foreign field' flag will be set to true as well.
Definition at line 143 of file indexschema.cpp.
References KexiDB::FieldList::fieldCount(), KexiDB::FieldList::m_fields, m_isForeignKey, and setUnique().
Referenced by KexiDB::Relationship::createIndices().

void IndexSchema::setPrimaryKey ( bool set )

Sets PRIMARY KEY flag.
See also:
isPrimary(). Note: Setting PRIMARY KEY on (true), UNIQUE flag will be also implicity set.

Definition at line 124 of file indexschema.cpp.
References m_primary, and m_unique.
Referenced by KexiDB::TableSchema::setPrimaryKey().

void IndexSchema::setUnique ( bool set )

Sets UNIQUE flag.
See also:
isUnique(). Note: Setting UNIQUE off (false), PRIMARY KEY flag will be also implicity set off, because this UNIQUE is the requirement for PRIMARY KEYS.

Definition at line 136 of file indexschema.cpp.
References m_primary, and m_unique.
Referenced by KexiDB::TableSchema::insertField(), and setForeignKey().

KexiDB::TableSchema * IndexSchema::table ( ) const

Returns:
table that index is defined for.

Definition at line 104 of file indexschema.cpp.
References m_tableSchema.
Referenced by KexiDB::Relationship::createIndices(), KexiDB::Relationship::detailsTable(), KexiDB::Relationship::masterTable(), and KexiDB::Relationship::setIndices().

Friends And Related Function Documentation

friend class Connection [friend]

Reimplemented from KexiDB::SchemaData.
Definition at line 201 of file indexschema.h.

friend class QuerySchema [friend]

Definition at line 203 of file indexschema.h.

friend class Relationship [friend]

Definition at line 204 of file indexschema.h.

friend class TableSchema [friend]

Definition at line 202 of file indexschema.h.

Member Data Documentation

Relationship::List KexiDB::IndexSchema::m_details_rels [protected]

a list of relationships to table (of this index)
Definition at line 194 of file indexschema.h.
Referenced by attachRelationship(), and detachRelationship().

bool KexiDB::IndexSchema::m_isAutoGenerated [protected]

Definition at line 198 of file indexschema.h.
Referenced by debugString(), isAutoGenerated(), and setAutoGenerated().

bool KexiDB::IndexSchema::m_isForeignKey [protected]

Definition at line 199 of file indexschema.h.
Referenced by debugString(), and setForeignKey().

Relationship::List KexiDB::IndexSchema::m_master_owned_rels [protected]

table on that index is built
a list of master relationships for the table (of this index), this index is a master key for these relationships and therefore - owner of these
Definition at line 188 of file indexschema.h.
Referenced by attachRelationship(), detachRelationship(), IndexSchema(), and ~IndexSchema().

Relationship::List KexiDB::IndexSchema::m_master_rels [protected]

a list of master relationships that are not owned by this schema
Definition at line 191 of file indexschema.h.
Referenced by attachRelationship(), and detachRelationship().

bool KexiDB::IndexSchema::m_primary [protected]

Definition at line 196 of file indexschema.h.
Referenced by debugString(), isPrimaryKey(), setPrimaryKey(), and setUnique().

TableSchema* KexiDB::IndexSchema::m_tableSchema [protected]

Definition at line 182 of file indexschema.h.
Referenced by addField(), and table().

bool KexiDB::IndexSchema::m_unique [protected]

Definition at line 197 of file indexschema.h.
Referenced by debugString(), isUnique(), setPrimaryKey(), and setUnique().

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


Public Types
typedef QPtrList< IndexSchema >	List
typedef QPtrListIterator< IndexSchema >	ListIterator
Public Member Functions
	IndexSchema (TableSchema *tableSchema)
	IndexSchema (const IndexSchema &idx, TableSchema &parentTable)
virtual	~IndexSchema ()
virtual FieldList &	addField (Field *field)
TableSchema *	table () const
Relationship::List *	masterRelationships ()
Relationship::List *	detailsRelationships ()
void	attachRelationship (Relationship *rel)
void	detachRelationship (Relationship *rel)
bool	isAutoGenerated () const
bool	isPrimaryKey () const
void	setPrimaryKey (bool set)
bool	isUnique () const
void	setUnique (bool set)
virtual QString	debugString ()
Protected Member Functions
void	setAutoGenerated (bool set)
void	setForeignKey (bool set)
void	attachRelationship (Relationship *rel, bool ownedByMaster)
Protected Attributes
TableSchema *	m_tableSchema
Relationship::List	m_master_owned_rels
	table on that index is built
Relationship::List	m_master_rels
Relationship::List	m_details_rels
bool	m_primary: 1
bool	m_unique: 1
bool	m_isAutoGenerated: 1
bool	m_isForeignKey: 1
Friends
class	Connection
class	TableSchema
class	QuerySchema
class	Relationship

Kexi API Documentation (2.0 alpha)

KexiDB::IndexSchema Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation