QxOrm  1.4.7
C++ Object Relational Mapping library
IxDao_Helper.h
Go to the documentation of this file.
00001 /****************************************************************************
00002 **
00003 ** https://www.qxorm.com/
00004 ** Copyright (C) 2013 Lionel Marty (contact@qxorm.com)
00005 **
00006 ** This file is part of the QxOrm library
00007 **
00008 ** This software is provided 'as-is', without any express or implied
00009 ** warranty. In no event will the authors be held liable for any
00010 ** damages arising from the use of this software
00011 **
00012 ** Commercial Usage
00013 ** Licensees holding valid commercial QxOrm licenses may use this file in
00014 ** accordance with the commercial license agreement provided with the
00015 ** Software or, alternatively, in accordance with the terms contained in
00016 ** a written agreement between you and Lionel Marty
00017 **
00018 ** GNU General Public License Usage
00019 ** Alternatively, this file may be used under the terms of the GNU
00020 ** General Public License version 3.0 as published by the Free Software
00021 ** Foundation and appearing in the file 'license.gpl3.txt' included in the
00022 ** packaging of this file. Please review the following information to
00023 ** ensure the GNU General Public License version 3.0 requirements will be
00024 ** met : http://www.gnu.org/copyleft/gpl.html
00025 **
00026 ** If you are unsure which license is appropriate for your use, or
00027 ** if you have questions regarding the use of this file, please contact :
00028 ** contact@qxorm.com
00029 **
00030 ****************************************************************************/
00031 
00032 #ifndef _IX_DAO_HELPER_H_
00033 #define _IX_DAO_HELPER_H_
00034 
00035 #ifdef _MSC_VER
00036 #pragma once
00037 #endif
00038 
00046 #include <QtSql/qsqldatabase.h>
00047 #include <QtSql/qsqlquery.h>
00048 #include <QtSql/qsqlerror.h>
00049 #include <QtSql/qsqldriver.h>
00050 #include <QtSql/qsqlrecord.h>
00051 
00052 #include <QxTraits/get_primary_key.h>
00053 #include <QxTraits/is_valid_primary_key.h>
00054 
00055 #include <QxDao/QxSqlDatabase.h>
00056 #include <QxDao/IxSqlQueryBuilder.h>
00057 #include <QxDao/QxSqlQuery.h>
00058 #include <QxDao/IxSqlRelation.h>
00059 #include <QxDao/QxSqlRelationLinked.h>
00060 
00061 #include <QxDao/QxSqlGenerator/IxSqlGenerator.h>
00062 
00063 #include <QxCollection/QxCollection.h>
00064 
00065 #include <QxDataMember/IxDataMemberX.h>
00066 
00067 #include <QxValidator/QxInvalidValueX.h>
00068 #include <QxValidator/QxValidatorError.h>
00069 
00070 namespace qx {
00071 template <class T>
00072 QxInvalidValueX validate(T & t, const QString & group);
00073 } // namespace qx
00074 
00075 namespace qx {
00076 namespace dao {
00077 namespace detail {
00078 
00079 struct IxDao_Timer;
00080 
00085 class QX_DLL_EXPORT IxDao_Helper
00086 {
00087 
00088    friend struct IxDao_Timer;
00089 
00090 public:
00091 
00092    enum timer_type { timer_none, timer_total, timer_db_exec, timer_db_next, timer_db_prepare, timer_cpp_build_hierarchy, 
00093                      timer_cpp_build_instance, timer_cpp_read_instance, timer_build_sql, timer_db_open, timer_db_transaction };
00094 
00095 private:
00096 
00097    struct IxDao_HelperImpl;
00098    std::unique_ptr<IxDao_HelperImpl> m_pImpl; 
00099 
00100 protected:
00101 
00102    IxDao_Helper(qx::IxSqlQueryBuilder * pBuilder, const qx::QxSqlQuery * pQuery = NULL);
00103    virtual ~IxDao_Helper();
00104 
00105 public:
00106 
00107    bool isValid() const;
00108    bool hasFeature(QSqlDriver::DriverFeature ft) const;
00109 
00110    QSqlDatabase & database();
00111    const QSqlDatabase & database() const;
00112    QSqlQuery & query();
00113    const QSqlQuery & query() const;
00114    QSqlError & error();
00115    const QSqlError & error() const;
00116    qx::QxSqlQuery & qxQuery();
00117    const qx::QxSqlQuery & qxQuery() const;
00118    qx::IxSqlQueryBuilder & builder();
00119    const qx::IxSqlQueryBuilder & builder() const;
00120    qx::IxDataMemberX * getDataMemberX() const;
00121    long getDataCount() const;
00122    qx::IxDataMember * getDataId() const;
00123    qx::IxDataMember * nextData(long & l) const;
00124    QString sql() const;
00125    qx::QxSqlRelationLinked * getSqlRelationLinked() const;
00126    bool getCartesianProduct() const;
00127    QStringList getSqlColumns() const;
00128    void setSqlColumns(const QStringList & lst);
00129    IxSqlGenerator * getSqlGenerator() const;
00130    void addInvalidValues(const qx::QxInvalidValueX & lst);
00131    bool getAddAutoIncrementIdToUpdateQuery() const;
00132    QStringList & itemsAsJson();
00133    bool isReadOnly() const;
00134    bool isMongoDB() const;
00135 
00136    QSqlError errFailed(bool bPrepare = false);
00137    QSqlError errEmpty();
00138    QSqlError errNoData();
00139    QSqlError errInvalidId();
00140    QSqlError errInvalidRelation();
00141    QSqlError errReadOnly();
00142 
00143    bool transaction();
00144    bool nextRecord();
00145    void quiet();
00146    bool exec(bool bForceEmptyExec = false);
00147    bool prepare(QString & sql);
00148 
00149    QSqlError updateError(const QSqlError & error);
00150    bool updateSqlRelationX(const QStringList & relation);
00151    void addQuery(bool bResolve);
00152    void dumpRecord() const;
00153 
00154    template <class U>
00155    inline bool isValidPrimaryKey(const U & u)
00156    { return (getDataId() && qx::trait::is_valid_primary_key(getDataId()->toVariant((& u), -1, qx::cvt::context::e_database))); }
00157 
00158    template <class U>
00159    inline void updateLastInsertId(U & u)
00160    {
00161       if (getDataId() && getDataId()->getAutoIncrement() && this->hasFeature(QSqlDriver::LastInsertId))
00162       { getDataId()->fromVariant((& u), query().lastInsertId(), -1, qx::cvt::context::e_database); }
00163    }
00164 
00165    template <class U>
00166    inline bool validateInstance(U & u)
00167    {
00168       qx::QxInvalidValueX invalidValues = qx::validate(u, "");
00169       this->addInvalidValues(invalidValues);
00170       return (invalidValues.count() <= 0);
00171    }
00172 
00173 protected:
00174 
00175    void dumpBoundValues() const;
00176    QSqlError updateError(const QString & sError);
00177    void timerStart(IxDao_Helper::timer_type timer);
00178    qint64 timerElapsed(IxDao_Helper::timer_type timer);
00179    void init(QSqlDatabase * pDatabase, const QString & sContext);
00180    void terminate();
00181 
00182 };
00183 
00188 struct IxDao_Timer
00189 {
00190 
00191    IxDao_Helper * m_pDaoHelper;              
00192    IxDao_Helper::timer_type m_eTimerType;    
00193 
00194    IxDao_Timer(IxDao_Helper * pDaoHelper, IxDao_Helper::timer_type timer) : m_pDaoHelper(pDaoHelper), m_eTimerType(timer) { if (m_pDaoHelper) { m_pDaoHelper->timerStart(m_eTimerType); } }
00195    ~IxDao_Timer() { if (m_pDaoHelper) { m_pDaoHelper->timerElapsed(m_eTimerType); } }
00196 
00197 };
00198 
00199 } // namespace detail
00200 } // namespace dao
00201 } // namespace qx
00202 
00203 #endif // _IX_DAO_HELPER_H_