source: src/orm/ormrecord.h @ 68b2df2

qt5
Last change on this file since 68b2df2 was 68b2df2, checked in by gregor herrmann <gregoa@…>, 10 years ago

Add copyright to source.

  • Property mode set to 100644
File size: 5.9 KB
Line 
1/*
2 * Copyright (C) 2010 Ixonos Plc.
3 * Copyright (C) 2011 Philipp Spitzer, gregor herrmann
4 *
5 * This file is part of ConfClerk.
6 *
7 * ConfClerk is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the Free
9 * Software Foundation, either version 2 of the License, or (at your option)
10 * any later version.
11 *
12 * ConfClerk is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15 * more details.
16 *
17 * You should have received a copy of the GNU General Public License along with
18 * ConfClerk.  If not, see <http://www.gnu.org/licenses/>.
19 */
20#ifndef ORMRECORD_H
21#define ORMRECORD_H
22
23#include <QSqlQuery>
24#include <QSqlRecord>
25#include <QSqlField>
26#include <QSqlError>
27#include <QStringList>
28#include <QDateTime>
29#include <QDebug>
30
31class OrmException
32{
33public:
34    OrmException(const QString& text) : mText(text) {}
35    virtual ~OrmException(){}
36    virtual const QString& text() const { return mText; }
37private:
38    QString mText;
39};
40
41class OrmNoObjectException : public OrmException
42{
43public:
44    OrmNoObjectException() : OrmException("No object exception"){}
45    ~OrmNoObjectException(){}
46};
47
48class OrmSqlException : public OrmException
49{
50public:
51    OrmSqlException(const QString& text) : OrmException( QString("Sql error: ") + text ) {}
52    ~OrmSqlException(){}
53};
54
55template <typename T>
56class OrmRecord : protected QSqlRecord
57{
58public:
59    OrmRecord();
60    static T hydrate(const QSqlRecord& record);
61    void update(QString col, QVariant value = QVariant()); // updates specified column 'col'
62
63protected:
64    QVariant value(QString col) const;
65    void setValue(QString col, QVariant value);
66
67    static T loadOne(QSqlQuery query);
68    static QList<T> load(QSqlQuery query);
69
70    // auxiliary methods
71    static QSqlRecord toRecord(const QList<QSqlField> & columnList);
72    // all record items/columns are in one table
73    static QString columnsForSelect(const QString& prefix = QString());
74    static QString selectQuery();
75    static QString updateQuery();
76
77    static QVariant convertToC(QVariant value, QVariant::Type colType);
78    static QVariant convertToDb(QVariant value, QVariant::Type colType);
79};
80
81template <typename T>
82OrmRecord<T>::OrmRecord()
83{
84    QSqlRecord::operator=(T::sColumns);
85}
86
87template <typename T>
88T OrmRecord<T>::hydrate(const QSqlRecord& record)
89{
90    T object;
91    object.QSqlRecord::operator=(record);
92    return object;
93}
94
95// updates specified column 'col'
96// if the value is not specified  as an argument,
97// it's taken from the reford itself
98// see also: setValue() method for more details
99template <typename T>
100void OrmRecord<T>::update(QString col, QVariant value)
101{
102    QSqlQuery query;
103    query.prepare(QString(updateQuery() + "SET %1 = :col WHERE id = :id").arg(col));
104    if(value.isValid()) // take 'col' value from the method's arguments
105        query.bindValue(":col", value);
106    else // take 'col' value from the record; see setValue()
107        query.bindValue(":col", convertToDb(this->value(col), this->value(col).type()));
108    query.bindValue(":id", this->value("id"));
109    //query.bindValue(":id", convertToDb(value("id"), QVariant::Int));
110    query.exec();
111}
112
113template <typename T>
114QVariant OrmRecord<T>::value(QString col) const
115{
116    return convertToC(QSqlRecord::value(col), T::sColumns.field(col).type());
117}
118
119template <typename T>
120void OrmRecord<T>::setValue(QString col, QVariant value)
121{
122    QSqlRecord::setValue(col, convertToDb(value, T::sColumns.field(col).type()));
123}
124
125template <typename T>
126T OrmRecord<T>::loadOne(QSqlQuery query)
127{
128    if (!query.isActive())
129    {
130        if (!query.exec())
131        {
132            throw OrmSqlException(query.lastError().text());
133        }
134    }
135
136    if (!query.next())
137    {
138        throw OrmNoObjectException();
139    }
140
141    return hydrate(query.record());
142}
143
144template <typename T>
145QList<T> OrmRecord<T>::load(QSqlQuery query)
146{
147    if (!query.isActive())
148    {
149        if (!query.exec())
150        {
151            qDebug() << "Error: " << query.lastError().driverText() << "; Type: " << query.lastError().type();
152            throw OrmSqlException(query.lastError().text());
153        }
154        else
155        {
156            /*qDebug() << "SQL OK";*/
157        }
158    }
159
160    QList<T> objects;
161    while (query.next())
162    {
163        objects << hydrate(query.record());
164    }
165    /*qDebug() << "Fetch done";*/
166    return objects;
167}
168
169template <typename T>
170QString OrmRecord<T>::columnsForSelect(const QString& prefix)
171{
172    QStringList prefixedColumns;
173    for (int i=0; i<T::sColumns.count(); i++)
174    {
175        prefixedColumns.append(prefix.isEmpty() ?
176            T::sColumns.field(i).name() :
177            QString("%1.%2").arg(prefix, T::sColumns.field(i).name()));
178    }
179    return prefixedColumns.join(",");
180}
181
182template <typename T>
183QString OrmRecord<T>::selectQuery()
184{
185    return QString("SELECT %1 FROM %2 ").arg(columnsForSelect(), T::sTableName);
186}
187
188template <typename T>
189QString OrmRecord<T>::updateQuery()
190{
191    return QString("UPDATE %1 ").arg(T::sTableName);
192}
193
194template <typename T>
195QSqlRecord OrmRecord<T>::toRecord(const QList<QSqlField> & columnList)
196{
197    QSqlRecord record;
198    for(int i=0; i< columnList.count(); i++)
199    {
200        record.append(columnList[i]);
201    }
202    return record;
203}
204
205template <typename T>
206QVariant OrmRecord<T>::convertToC(QVariant value, QVariant::Type colType)
207{
208    if (colType == QVariant::DateTime && value.canConvert<uint>())
209    {
210        QDateTime date;
211        date.setTimeSpec(Qt::UTC);
212        date.setTime_t(value.toUInt());
213        return date;
214    }
215
216    return value;
217}
218
219template <typename T>
220QVariant OrmRecord<T>::convertToDb(QVariant value, QVariant::Type colType)
221{
222    if (colType == QVariant::DateTime && value.canConvert<QDateTime>())
223    {
224        return value.toDateTime().toTime_t();
225    }
226
227    return value;
228}
229
230#endif // ORMRECORD_H
231
Note: See TracBrowser for help on using the repository browser.