summaryrefslogtreecommitdiffstats
path: root/kexi/kexidb/fieldlist.h
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 01:29:50 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 01:29:50 +0000
commit8362bf63dea22bbf6736609b0f49c152f975eb63 (patch)
tree0eea3928e39e50fae91d4e68b21b1e6cbae25604 /kexi/kexidb/fieldlist.h
downloadkoffice-8362bf63dea22bbf6736609b0f49c152f975eb63.tar.gz
koffice-8362bf63dea22bbf6736609b0f49c152f975eb63.zip
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
Diffstat (limited to 'kexi/kexidb/fieldlist.h')
-rw-r--r--kexi/kexidb/fieldlist.h175
1 files changed, 175 insertions, 0 deletions
diff --git a/kexi/kexidb/fieldlist.h b/kexi/kexidb/fieldlist.h
new file mode 100644
index 00000000..fd47459e
--- /dev/null
+++ b/kexi/kexidb/fieldlist.h
@@ -0,0 +1,175 @@
+/* This file is part of the KDE project
+ Copyright (C) 2003-2007 Jaroslaw Staniek <[email protected]>
+
+ 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_FIELDLIST_H
+#define KEXIDB_FIELDLIST_H
+
+#include <qvaluelist.h>
+#include <qdict.h>
+#include <qstring.h>
+
+#include <kexidb/field.h>
+#include <kexidb/driver.h>
+
+namespace KexiDB {
+
+class Connection;
+
+/*! Helper class that stores list of fields.
+*/
+
+class KEXI_DB_EXPORT FieldList
+{
+ public:
+ /*! Creates empty list of fields. If \a owner is true, the list will be
+ owner of any added field, what means that these field
+ will be removed on the list destruction. Otherwise, the list
+ just points any field that was added.
+ \sa isOwner()
+ */
+ FieldList(bool owner = false);
+
+ /*! Copy constructor.
+ If \a deepCopyFields is true, all fields are deeply copied, else only pointer are copied.
+ Reimplemented in QuerySchema constructor. */
+ FieldList(const FieldList& fl, bool deepCopyFields = true);
+
+ /*! Destroys the list. If the list owns fields (see constructor),
+ these are also deleted. */
+ virtual ~FieldList();
+
+ /*! \return number of fields in the list. */
+ inline uint fieldCount() const { return m_fields.count(); }
+
+ /*! Adds \a field at the and of field list. */
+ FieldList& addField(Field *field);
+
+ /*! Inserts \a field into a specified position (\a index).
+
+ Note: You can reimplement this method but you should still call
+ this implementation in your subclass. */
+ virtual FieldList& insertField(uint index, Field *field);
+
+ /*! Removes field from the field list. Use with care.
+
+ Note: You can reimplement this method but you should still call
+ this implementation in your subclass. */
+ virtual void removeField(KexiDB::Field *field);
+
+ /*! \return field id or NULL if there is no such a field. */
+ inline Field* field(uint id) { return (id < m_fields.count()) ? m_fields.at(id) : 0; }
+
+ /*! \return field with name \a name or NULL if there is no such a field. */
+ virtual Field* field(const QString& name);
+
+ /*! \return true if this list contains given \a field. */
+ inline bool hasField(const Field* field) { return m_fields.findRef(field)!=-1; }
+
+ /*! \return first occurrence of \a field in the list
+ or -1 if this list does not contain this field. */
+ inline int indexOf(const Field* field) { return m_fields.findRef(field); }
+
+ /*! \return list of field names for this list. */
+ QStringList names() const;
+
+ Field::ListIterator fieldsIterator() const { return Field::ListIterator(m_fields); }
+
+ inline Field::List* fields() { return &m_fields; }
+
+ /*! \return list of autoincremented fields. The list is owned by this FieldList object. */
+ Field::List* autoIncrementFields();
+
+ /*! \return true if fields in the list are owned by this list. */
+ inline bool isOwner() const { return m_fields.autoDelete(); }
+
+ /*! Removes all fields from the list. */
+ virtual void clear();
+
+ /*! \return String for debugging purposes. */
+ virtual QString debugString();
+
+ /*! Shows debug information about all fields in the list. */
+ void debug();
+
+ /*! Creates and returns a list that contain fields selected by name.
+ At least one field (exising on this list) should be selected, otherwise 0 is
+ returned. Returned FieldList object is not owned by any parent (so you need
+ to destroy yourself) and Field objects included in it are not owned by it
+ (but still as before, by 'this' object).
+ Returned list can be usable e.g. as argument for Connection::insertRecord().
+ 0 is returned if at least one name cannot be found.
+ */
+ FieldList* subList(const QString& n1, const QString& n2 = QString::null,
+ const QString& n3 = QString::null, const QString& n4 = QString::null,
+ const QString& n5 = QString::null, const QString& n6 = QString::null,
+ const QString& n7 = QString::null, const QString& n8 = QString::null,
+ const QString& n9 = QString::null, const QString& n10 = QString::null,
+ const QString& n11 = QString::null, const QString& n12 = QString::null,
+ const QString& n13 = QString::null, const QString& n14 = QString::null,
+ const QString& n15 = QString::null, const QString& n16 = QString::null,
+ const QString& n17 = QString::null, const QString& n18 = QString::null
+ );
+
+ /*! Like above, but with a QStringList */
+ FieldList* subList(const QStringList& list);
+
+ /*! Like above, but with a list of field indices */
+ FieldList* subList(const QValueList<uint>& list);
+
+ /*! \return a string that is a result of all field names concatenated
+ and with \a separator. This is usable e.g. as argument like "field1,field2"
+ for "INSERT INTO (xxx) ..". The result of this method is effectively cached,
+ and it is invalidated when set of fields changes (e.g. using clear()
+ or addField()).
+ \a tableAlias, if provided is prepended to each field, so the resulting
+ names will be in form tableAlias.fieldName. This option is used for building
+ queries with joins, where fields have to be spicified without ambiguity.
+ See @ref Connection::selectStatement() for example use.
+ \a drvEscaping can be used to alter default escaping type.
+ */
+ QString sqlFieldsList(Driver *driver, const QString& separator = QString::fromLatin1(","),
+ const QString& tableAlias = QString::null,
+ int drvEscaping = Driver::EscapeDriver|Driver::EscapeAsNecessary);
+
+ /*! Like above, but this is convenient static function, so you can pass any \a list here. */
+ static QString sqlFieldsList(Field::List* list, Driver *driver,
+ const QString& separator = QString::fromLatin1(","), const QString& tableAlias = QString::null,
+ int drvEscaping = Driver::EscapeDriver|Driver::EscapeAsNecessary);
+
+ /*! @internal Renames field \a oldName to \a newName.
+ Do not use this for physical renaming columns. Use AlterTableHandler instead. */
+ void renameField(const QString& oldName, const QString& newName);
+
+ /*! @internal
+ \overload void renameField(const QString& oldName, const QString& newName) */
+ void renameField(KexiDB::Field *field, const QString& newName);
+
+ protected:
+ Field::List m_fields;
+ QDict<Field> m_fields_by_name; //!< Fields collected by name. Not used by QuerySchema.
+ Field::List *m_autoinc_fields;
+
+ private:
+ //! cached
+ QString m_sqlFields;
+};
+
+} //namespace KexiDB
+
+#endif