From 8362bf63dea22bbf6736609b0f49c152f975eb63 Mon Sep 17 00:00:00 2001 From: tpearson Date: Wed, 20 Jan 2010 01:29:50 +0000 Subject: Added old abandoned KDE3 version of koffice git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/koffice@1077364 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- kexi/kexidb/tableschema.h | 210 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 210 insertions(+) create mode 100644 kexi/kexidb/tableschema.h (limited to 'kexi/kexidb/tableschema.h') diff --git a/kexi/kexidb/tableschema.h b/kexi/kexidb/tableschema.h new file mode 100644 index 00000000..7584d703 --- /dev/null +++ b/kexi/kexidb/tableschema.h @@ -0,0 +1,210 @@ +/* This file is part of the KDE project + Copyright (C) 2003 Joseph Wenninger + Copyright (C) 2003-2006 Jaroslaw Staniek + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. +*/ + +#ifndef KEXIDB_TABLE_H +#define KEXIDB_TABLE_H + +#include +#include +#include +#include + +#include +#include +#include +#include + +namespace KexiDB { + +class Connection; +class LookupFieldSchema; + +/*! KexiDB::TableSchema provides information about native database table + that can be stored using KexiDB database engine. +*/ +class KEXI_DB_EXPORT TableSchema : public FieldList, public SchemaData +{ + public: + typedef QPtrList List; //!< Type of tables list + typedef QPtrListIterator ListIterator; //!< Iterator for tables list + + TableSchema(const QString & name); + TableSchema(const SchemaData& sdata); + TableSchema(); + + /*! Copy constructor. + if \a copyId is true, it's copied as well, otherwise the table id becomes -1, + what is usable when we want to store the copy as an independent table. */ + TableSchema(const TableSchema& ts, bool copyId = true); + + /*! Copy constructor like \ref TableSchema(const TableSchema&, bool). + \a setId is set as the table identifier. This is rarely usable, e.g. + in project and data migration routines when we need to need deal with unique identifiers; + @see KexiMigrate::performImport(). */ + TableSchema(const TableSchema& ts, int setId); + + virtual ~TableSchema(); + + /*! Inserts \a field into a specified position (\a index). + 'order' property of \a field is set automatically. */ + virtual FieldList& insertField(uint index, Field *field); + + /*! Reimplemented for internal reasons. */ + virtual void removeField(KexiDB::Field *field); + + /*! \return list of fields that are primary key of this table. + This method never returns 0 value, + if there is no primary key, empty IndexSchema object is returned. + IndexSchema object is owned by the table schema. */ + IndexSchema* primaryKey() const { return m_pkey; } + + /*! Sets table's primary key index to \a pkey. Pass pkey==0 if you want to unassign + existing primary key ("primary" property of given IndexSchema object will be + cleared then so this index becomes ordinary index, still existing on table indeices list). + + If this table already has primary key assigned, + it is unassigned using setPrimaryKey(0) call. + + Before assigning as primary key, you should add the index to indices list + with addIndex() (this is not done automatically!). + */ + void setPrimaryKey(IndexSchema *pkey); + + const IndexSchema::ListIterator indicesIterator() const + { return IndexSchema::ListIterator(m_indices); } + + const IndexSchema::List* indices() { return &m_indices; } + + /*! Removes all fields from the list, clears name and all other properties. + \sa FieldList::clear() */ + virtual void clear(); + + /*! \return String for debugging purposes, if \a includeTableName is true, + table name, caption, etc. is prepended, else only debug string for + the fields are returned. */ + QString debugString(bool includeTableName); + + /*! \return String for debugging purposes. Equal to debugString(true). */ + virtual QString debugString(); + + /*! \return connection object if table was created/retrieved using a connection, + otherwise 0. */ + Connection* connection() const { return m_conn; } + + /*! \return true if this is KexiDB storage system's table + (used internally by KexiDB). This helps in hiding such tables + in applications (if desired) and will also enable lookup of system + tables for schema export/import functionality. + + Any internal KexiDB system table's schema (kexi__*) has + cleared its SchemaData part, e.g. id=-1 for such table, + and no description, caption and so on. This is because + it represents a native database table rather that extended Kexi table. + + isKexiDBSystem()==true implies isNative()==true. + + By default (after allocation), TableSchema object + has this property set to false. */ + bool isKexiDBSystem() const { return m_isKexiDBSystem; } + + /*! Sets KexiDBSystem flag to on or off. When on, native flag is forced to be on. + When off, native flag is not affected. + \sa isKexiDBSystem() */ + void setKexiDBSystem(bool set); + + /*! \return true if this is schema of native database object, + When this is kexiDBSystem table, native flag is forced to be on. */ + virtual bool isNative() const { return m_native || m_isKexiDBSystem; } + + /* Sets native flag. Does not allow to set this off for system KexiDB table. */ + virtual void setNative(bool set); + + /*! \return query schema object that is defined by "select * from " + This query schema object is owned by the table schema object. + It is convenient way to get such a query when it is not available otherwise. + Always returns non-0. */ + QuerySchema* query(); + + /*! \return any field not being a part of primary key of this table. + If there is no such field, returns 0. */ + Field* anyNonPKField(); + + /*! Sets lookup field schema \a lookupFieldSchema for \a fieldName. + Passing null \a lookupFieldSchema will remove the previously set lookup field. + \return true if \a lookupFieldSchema has been added, + or false if there is no such field \a fieldName. */ + bool setLookupFieldSchema( const QString& fieldName, LookupFieldSchema *lookupFieldSchema ); + + /*! \return lookup field schema for \a field. + 0 is returned if there is no such field in the table or this field has no lookup schema. + Note that even id non-zero is returned here, you may want to check whether lookup field's + rowSource().name() is empty (if so, the field should behave as there was no lookup field + defined at all). */ + LookupFieldSchema *lookupFieldSchema( const Field& field ) const; + + /*! \overload LookupFieldSchema *TableSchema::lookupFieldSchema( Field& field ) const */ + LookupFieldSchema *lookupFieldSchema( const QString& fieldName ); + + /*! \return list of lookup field schemas for this table. + The order is the same as the order of fields within the table. */ + const QPtrVector& lookupFieldsList(); + + protected: + /*! Automatically retrieves table schema via connection. */ + TableSchema(Connection *conn, const QString & name = QString::null); + + IndexSchema::List m_indices; + + QGuardedPtr m_conn; + + IndexSchema *m_pkey; + + QuerySchema *m_query; //!< cached query schema that is defined by "select * from " + + class Private; + Private *d; + + private: + //! Used by some ctors. + void init(); + + //! Used by some ctors. + void init(const TableSchema& ts, bool copyId); + + bool m_isKexiDBSystem : 1; + + friend class Connection; +}; + +/*! Internal table with a name \a name. Rarely used. + Use Connection::createTable() to create a table using this schema. + The table will not be visible as user table. + For example, 'kexi__blobs' table is created this way by Kexi application. */ +class KEXI_DB_EXPORT InternalTableSchema : public TableSchema +{ + public: + InternalTableSchema(const QString& name); + InternalTableSchema(const TableSchema& ts); + virtual ~InternalTableSchema(); +}; + +} //namespace KexiDB + +#endif -- cgit v1.2.1