You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
176 lines
6.8 KiB
176 lines
6.8 KiB
/* This file is part of the KDE project
|
|
Copyright (C) 2003-2007 Jaroslaw Staniek <js@iidea.pl>
|
|
|
|
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 <tqvaluelist.h>
|
|
#include <tqdict.h>
|
|
#include <tqstring.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 TQString& 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. */
|
|
TQStringList 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 TQString 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 TQString& n1, const TQString& n2 = TQString(),
|
|
const TQString& n3 = TQString(), const TQString& n4 = TQString(),
|
|
const TQString& n5 = TQString(), const TQString& n6 = TQString(),
|
|
const TQString& n7 = TQString(), const TQString& n8 = TQString(),
|
|
const TQString& n9 = TQString(), const TQString& n10 = TQString(),
|
|
const TQString& n11 = TQString(), const TQString& n12 = TQString(),
|
|
const TQString& n13 = TQString(), const TQString& n14 = TQString(),
|
|
const TQString& n15 = TQString(), const TQString& n16 = TQString(),
|
|
const TQString& n17 = TQString(), const TQString& n18 = TQString()
|
|
);
|
|
|
|
/*! Like above, but with a TQStringList */
|
|
FieldList* subList(const TQStringList& list);
|
|
|
|
/*! Like above, but with a list of field indices */
|
|
FieldList* subList(const TQValueList<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.
|
|
*/
|
|
TQString sqlFieldsList(Driver *driver, const TQString& separator = TQString::tqfromLatin1(","),
|
|
const TQString& tableAlias = TQString(),
|
|
int drvEscaping = Driver::EscapeDriver|Driver::EscapeAsNecessary);
|
|
|
|
/*! Like above, but this is convenient static function, so you can pass any \a list here. */
|
|
static TQString sqlFieldsList(Field::List* list, Driver *driver,
|
|
const TQString& separator = TQString::tqfromLatin1(","), const TQString& tableAlias = TQString(),
|
|
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 TQString& oldName, const TQString& newName);
|
|
|
|
/*! @internal
|
|
\overload void renameField(const TQString& oldName, const TQString& newName) */
|
|
void renameField(KexiDB::Field *field, const TQString& newName);
|
|
|
|
protected:
|
|
Field::List m_fields;
|
|
TQDict<Field> m_fields_by_name; //!< Fields collected by name. Not used by QuerySchema.
|
|
Field::List *m_autoinc_fields;
|
|
|
|
private:
|
|
//! cached
|
|
TQString m_sqlFields;
|
|
};
|
|
|
|
} //namespace KexiDB
|
|
|
|
#endif
|