| QxOrm 1.2.5 C++ Object Relational Mapping library

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Directories

- File List
- File Members

IxDataMember.h
Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** http://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_DATA_MEMBER_H_
    00033 #define _IX_DATA_MEMBER_H_
    00034
    00035 #ifdef _MSC_VER
    00036 #pragma once
    00037 #endif
    00038
    00046 #ifdef _MSC_VER
    00047 #pragma warning(push)
    00048 #pragma warning(disable:4996)
    00049 #endif // _MSC_VER
    00050
    00051 #include <boost/any.hpp>
    00052
    00053 #include <QxCommon/QxBool.h>
    00054 #include <QxCommon/QxPropertyBag.h>
    00055
    00056 #include <QxSerialize/boost/QxSerializeInclude.h>
    00057
    00058 #include <QxDao/IxSqlRelation.h>
    00059
    00060 #ifdef _MSC_VER
    00061 #pragma warning(pop)
    00062 #endif // _MSC_VER
    00063
    00064 #define QX_CONSTRUCT_IX_DATA_MEMBER() \
    00065 m_iPrecision(6), m_iMinLength(-1), m_iMaxLength(-1), m_bRequired(false), \
    00066 m_bReadOnly(false), m_bAutoIncrement(false), m_bNotNull(false), \
    00067 m_bIsPrimaryKey(false), m_bAccessDataPointer(false), m_pName(NULL), m_pParent(NULL)
    00068
    00069 #define QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(ArchiveInput, ArchiveOutput) \
    00070 virtual void toArchive(const void * pOwner, ArchiveOutput & ar) const = 0; \
    00071 virtual void fromArchive(void * pOwner, ArchiveInput & ar) = 0;
    00072
    00073 namespace qx {
    00074
    00075 class IxDataMemberX;
    00076
    00081 class QX_DLL_EXPORT IxDataMember : public qx::QxPropertyBag
    00082 {
    00083
    00084 protected:
    00085
    00086    QString     m_sKey;
    00087    QString     m_sName;
    00088    QString     m_sNameParent;
    00089    QString     m_sDescription;
    00090    QString     m_sFormat;
    00091    QString     m_sSqlType;
    00092    QString     m_sSqlAlias;
    00093    long        m_lVersion;
    00094    bool        m_bSerialize;
    00095    bool        m_bDao;
    00096    QVariant    m_vDefaultValue;
    00097    QVariant    m_vMinValue;
    00098    QVariant    m_vMaxValue;
    00099    int         m_iPrecision;
    00100    int         m_iMinLength;
    00101    int         m_iMaxLength;
    00102    bool        m_bRequired;
    00103    bool        m_bReadOnly;
    00104    bool        m_bAutoIncrement;
    00105    bool        m_bNotNull;
    00106    bool        m_bIsPrimaryKey;
    00107    bool        m_bAccessDataPointer;
    00108
    00109    QByteArray m_byteName;
    00110    const char * m_pName;
    00111    QStringList m_lstNames;
    00112
    00113    boost::scoped_ptr<IxSqlRelation> m_pSqlRelation;
    00114    IxDataMemberX * m_pParent;
    00115
    00116 public:
    00117
    00118    IxDataMember(const QString & sKey) : qx::QxPropertyBag(), m_sKey(sKey), m_lVersion(-1), m_bSerialize(true), m_bDao(true), QX_CONSTRUCT_IX_DATA_MEMBER() { qAssert(! m_sKey.isEmpty()); updateNamePtr(); }
    00119    IxDataMember(const QString & sKey, long lVersion, bool bSerialize, bool bDao) : qx::QxPropertyBag(), m_sKey(sKey), m_lVersion(lVersion), m_bSerialize(bSerialize), m_bDao(bDao), QX_CONSTRUCT_IX_DATA_MEMBER() { qAssert(! m_sKey.isEmpty()); updateNamePtr(); }
    00120    virtual ~IxDataMember() = 0;
    00121
    00122    inline QString getKey() const                   { return m_sKey; }
    00123    inline QString getName() const                  { return (m_sName.isEmpty() ? m_sKey : m_sName); }
    00124    inline int getNameCount() const                 { return m_lstNames.count(); }
    00125    inline QString getNameParent() const            { return m_sNameParent; }
    00126    inline const char * getNamePtr() const          { return m_pName; }
    00127    inline QString getDescription() const           { return m_sDescription; }
    00128    inline QString getFormat() const                { return m_sFormat; }
    00129    inline long getVersion() const                  { return m_lVersion; }
    00130    inline bool getSerialize() const                { return m_bSerialize; }
    00131    inline bool getDao() const                      { return m_bDao; }
    00132    inline QVariant getDefaultValue() const         { return m_vDefaultValue; }
    00133    inline QVariant getMinValue() const             { return m_vMinValue; }
    00134    inline QVariant getMaxValue() const             { return m_vMaxValue; }
    00135    inline int getPrecision() const                 { return m_iPrecision; }
    00136    inline int getMinLength() const                 { return m_iMinLength; }
    00137    inline int getMaxLength() const                 { return m_iMaxLength; }
    00138    inline bool getRequired() const                 { return m_bRequired; }
    00139    inline bool getReadOnly() const                 { return m_bReadOnly; }
    00140    inline bool getAutoIncrement() const            { return m_bAutoIncrement; }
    00141    inline bool getNotNull() const                  { return m_bNotNull; }
    00142    inline bool getIsPrimaryKey() const             { return m_bIsPrimaryKey; }
    00143    inline IxDataMemberX * getParent() const        { return m_pParent; }
    00144    inline IxSqlRelation * getSqlRelation() const   { return m_pSqlRelation.get(); }
    00145    inline bool hasSqlRelation() const              { return (m_pSqlRelation.get() != NULL); }
    00146
    00147    inline void setName(const QString & sName)                  { m_sName = sName; updateNamePtr(); }
    00148    inline void setNameParent(const QString & sName)            { m_sNameParent = sName; }
    00149    inline void setDescription(const QString & sDesc)           { m_sDescription = sDesc; }
    00150    inline void setFormat(const QString & sFormat)              { m_sFormat = sFormat; }
    00151    inline void setSqlType(const QString & sSqlType)            { m_sSqlType = sSqlType; }
    00152    inline void setSqlAlias(const QString & sSqlAlias)          { m_sSqlAlias = sSqlAlias; }
    00153    inline void setVersion(long lVersion)                       { m_lVersion = lVersion; }
    00154    inline void setSerialize(bool bSerialize)                   { m_bSerialize = bSerialize; }
    00155    inline void setDao(bool bDao)                               { m_bDao = bDao; }
    00156    inline void setDefaultValue(const QVariant & var)           { m_vDefaultValue = var; }
    00157    inline void setPrecision(int iPrecision)                    { m_iPrecision = iPrecision; }
    00158    inline void setRequired(bool bRequired)                     { m_bRequired = bRequired; }
    00159    inline void setReadOnly(bool bReadOnly)                     { m_bReadOnly = bReadOnly; }
    00160    inline void setAutoIncrement(bool bAutoIncrement)           { m_bAutoIncrement = bAutoIncrement; }
    00161    inline void setIsPrimaryKey(bool bIsPrimaryKey)             { m_bIsPrimaryKey = bIsPrimaryKey; }
    00162    inline void setParent(IxDataMemberX * pParent)              { m_pParent = pParent; }
    00163    inline void setSqlRelation(IxSqlRelation * pSqlRelation)    { m_pSqlRelation.reset(pSqlRelation); }
    00164
    00165    void setMinValue(long lMinValue, const QString & sMessage = QString());
    00166    void setMinValue(double dMinValue, const QString & sMessage = QString());
    00167    void setMaxValue(long lMaxValue, const QString & sMessage = QString());
    00168    void setMaxValue(double dMaxValue, const QString & sMessage = QString());
    00169    void setMinLength(int iMinLength, const QString & sMessage = QString());
    00170    void setMaxLength(int iMaxLength, const QString & sMessage = QString());
    00171    void setNotNull(bool bNotNull, const QString & sMessage = QString());
    00172
    00173    QString getName(int iIndex, const QString & sOtherName = QString()) const;
    00174    QString getSqlAlias(const QString & sTable = QString(), bool bClauseWhere = false, int iIndexName = 0) const;
    00175    QString getSqlType(int iIndexName = -1) const;
    00176    QString getSqlTypeAndParams(int iIndexName = -1) const;
    00177    QString getSqlPlaceHolder(const QString & sAppend = QString(), int iIndexName = 0, const QString & sSep = QString(", "), const QString & sOtherName = QString()) const;
    00178    void setSqlPlaceHolder(QSqlQuery & query, void * pOwner, const QString & sAppend = QString(), const QString & sOtherName = QString()) const;
    00179    QString getSqlAliasEqualToPlaceHolder(const QString & sTable = QString(), bool bClauseWhere = false, const QString & sAppend = QString(), const QString & sSep = QString(" AND ")) const;
    00180    QString getSqlNameEqualToPlaceHolder(const QString & sAppend = QString(), const QString & sSep = QString(" AND ")) const;
    00181    QString getSqlTablePointNameAsAlias(const QString & sTable, const QString & sSep = QString(", "), const QString & sSuffixAlias = QString()) const;
    00182    QString getSqlName(const QString & sSep = QString(", "), const QString & sOtherName = QString()) const;
    00183    QString getSqlNameAndTypeAndParams(const QString & sSep = QString(", "), const QString & sOtherName = QString()) const;
    00184
    00185    virtual bool isEqual(const void * pOwner1, const void * pOwner2) const = 0;
    00186    virtual QString toString(const void * pOwner, const QString & sFormat, int iIndexName = -1) const = 0;
    00187    virtual qx_bool fromString(void * pOwner, const QString & s, const QString & sFormat, int iIndexName = -1) = 0;
    00188    virtual QVariant toVariant(const void * pOwner, const QString & sFormat, int iIndexName = -1) const = 0;
    00189    virtual qx_bool fromVariant(void * pOwner, const QVariant & v, const QString & sFormat, int iIndexName = -1) = 0;
    00190
    00191    inline QString toString(const void * pOwner, int iIndexName = -1) const             { return this->toString(pOwner, m_sFormat, iIndexName); }
    00192    inline qx_bool fromString(void * pOwner, const QString & s, int iIndexName = -1)    { return this->fromString(pOwner, s, m_sFormat, iIndexName); }
    00193    inline QVariant toVariant(const void * pOwner, int iIndexName = -1) const           { return this->toVariant(pOwner, m_sFormat, iIndexName); }
    00194    inline qx_bool fromVariant(void * pOwner, const QVariant & v, int iIndexName = -1)  { return this->fromVariant(pOwner, v, m_sFormat, iIndexName); }
    00195
    00196 protected:
    00197
    00198    virtual boost::any getDataPtr(const void * pOwner) const = 0;
    00199    virtual boost::any getDataPtr(void * pOwner) = 0;
    00200    virtual void * getDataVoidPtr(const void * pOwner) const = 0;
    00201    virtual void * getDataVoidPtr(void * pOwner) = 0;
    00202
    00203 public:
    00204
    00205    inline boost::any getValueAnyPtr(const void * pOwner) const    { return this->getDataPtr(pOwner); }
    00206    inline boost::any getValueAnyPtr(void * pOwner)                { return this->getDataPtr(pOwner); }
    00207    inline void * getValueVoidPtr(const void * pOwner) const       { return this->getDataVoidPtr(pOwner); }
    00208    inline void * getValueVoidPtr(void * pOwner)                   { return this->getDataVoidPtr(pOwner); }
    00209
    00210    template <typename T>
    00211    T * getValuePtr(void * pOwner, bool * bOk = NULL)
    00212    {
    00213       if (bOk) { (* bOk) = false; }
    00214       if (! m_bAccessDataPointer) { qDebug("[QxOrm] qx::IxDataMember::getValuePtr<T>() : '%s'", "cannot access data-member pointer"); return NULL; }
    00215       boost::any a = this->getDataPtr(pOwner);
    00216       try { T * t = boost::any_cast<T *>(a); if (bOk) { (* bOk) = (t != NULL); }; return t; }
    00217       catch (const boost::bad_any_cast & err) { Q_UNUSED(err); qDebug("[QxOrm] qx::IxDataMember::getValuePtr<T>() : '%s'", "bad any cast exception"); return NULL; }
    00218    }
    00219
    00220    template <typename T>
    00221    T getValue(void * pOwner, bool * bOk = NULL)
    00222    {
    00223       if (! m_bAccessDataPointer) { return qxCannotAccessDataPointer<T, 0>::getValue(this, pOwner, bOk); }
    00224       T * t = this->getValuePtr<T>(pOwner, bOk);
    00225       return (t ? (* t) : T());
    00226    }
    00227
    00228    template <typename T>
    00229    bool setValue(void * pOwner, const T & val)
    00230    {
    00231       if (! m_bAccessDataPointer) { return qxCannotAccessDataPointer<T, 0>::setValue(this, pOwner, val); }
    00232       T * t = this->getValuePtr<T>(pOwner);
    00233       if (t) { (* t) = val; }
    00234       return (t != NULL);
    00235    }
    00236
    00237 private:
    00238
    00239    template <typename T, int dummy>
    00240    struct qxCannotAccessDataPointer
    00241    {
    00242       static inline T getValue(IxDataMember * pData, void * pOwner, bool * bOk)
    00243       { Q_UNUSED(pData); Q_UNUSED(pOwner); qDebug("[QxOrm] qx::IxDataMember::qxCannotAccessDataPointer<T>::getValue() : '%s'", "type T not supported"); if (bOk) { (* bOk) = false; }; return T(); }
    00244       static inline bool setValue(IxDataMember * pData, void * pOwner, const T & val)
    00245       { Q_UNUSED(pData); Q_UNUSED(pOwner); Q_UNUSED(val); qDebug("[QxOrm] qx::IxDataMember::qxCannotAccessDataPointer<T>::setValue() : '%s'", "type T not supported"); return false; }
    00246    };
    00247
    00248    template <int dummy>
    00249    struct qxCannotAccessDataPointer<QVariant, dummy>
    00250    {
    00251       static inline QVariant getValue(IxDataMember * pData, void * pOwner, bool * bOk)
    00252       { if (bOk) { (* bOk) = (pData != NULL); }; return (pData ? pData->toVariant(pOwner, "") : QVariant()); }
    00253       static inline bool setValue(IxDataMember * pData, void * pOwner, const QVariant & val)
    00254       { return (pData ? pData->fromVariant(pOwner, val, "").getValue() : false); }
    00255    };
    00256
    00257    template <int dummy>
    00258    struct qxCannotAccessDataPointer<QString, dummy>
    00259    {
    00260       static inline QString getValue(IxDataMember * pData, void * pOwner, bool * bOk)
    00261       { if (bOk) { (* bOk) = (pData != NULL); }; return (pData ? pData->toString(pOwner, "") : QString()); }
    00262       static inline bool setValue(IxDataMember * pData, void * pOwner, const QString & val)
    00263       { return (pData ? pData->fromString(pOwner, val, "").getValue() : false); }
    00264    };
    00265
    00266 public:
    00267
    00268 #if _QX_SERIALIZE_POLYMORPHIC
    00269    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::polymorphic_iarchive, boost::archive::polymorphic_oarchive)
    00270 #endif // _QX_SERIALIZE_POLYMORPHIC
    00271
    00272 #if _QX_SERIALIZE_BINARY
    00273    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::binary_iarchive, boost::archive::binary_oarchive)
    00274 #endif // _QX_SERIALIZE_BINARY
    00275
    00276 #if _QX_SERIALIZE_TEXT
    00277    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::text_iarchive, boost::archive::text_oarchive)
    00278 #endif // _QX_SERIALIZE_TEXT
    00279
    00280 #if _QX_SERIALIZE_XML
    00281    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::xml_iarchive, boost::archive::xml_oarchive)
    00282 #endif // _QX_SERIALIZE_XML
    00283
    00284 #if _QX_SERIALIZE_PORTABLE_BINARY
    00285    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(eos::portable_iarchive, eos::portable_oarchive)
    00286 #endif // _QX_SERIALIZE_PORTABLE_BINARY
    00287
    00288 #if _QX_SERIALIZE_WIDE_BINARY
    00289    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::binary_wiarchive, boost::archive::binary_woarchive)
    00290 #endif // _QX_SERIALIZE_WIDE_BINARY
    00291
    00292 #if _QX_SERIALIZE_WIDE_TEXT
    00293    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::text_wiarchive, boost::archive::text_woarchive)
    00294 #endif // _QX_SERIALIZE_WIDE_TEXT
    00295
    00296 #if _QX_SERIALIZE_WIDE_XML
    00297    QX_IX_DATA_MEMBER_PURE_VIRTUAL_ARCHIVE(boost::archive::xml_wiarchive, boost::archive::xml_woarchive)
    00298 #endif // _QX_SERIALIZE_WIDE_XML
    00299
    00300 private:
    00301
    00302    inline void updateNamePtr()
    00303    {
    00304       QString sNamePtr = (m_sName.isEmpty() ? m_sKey : m_sName);
    00305       sNamePtr.replace("|", "-"); // valid xml tag
    00306       m_byteName = sNamePtr.toLatin1();
    00307       m_pName = m_byteName.constData();
    00308       m_lstNames = (m_sName.isEmpty() ? m_sKey.split("|") : m_sName.split("|"));
    00309    }
    00310
    00311    template <class Archive>
    00312    void serialize(Archive & ar, const unsigned int version);
    00313
    00314 };
    00315
    00316 typedef boost::shared_ptr<IxDataMember> IxDataMember_ptr;
    00317
    00318 } // namespace qx
    00319
    00320 QX_DLL_EXPORT_INLINE_FCT inline bool operator< (const qx::IxDataMember & i1, const qx::IxDataMember & i2);
    00321 QX_DLL_EXPORT_INLINE_FCT inline bool operator> (const qx::IxDataMember & i1, const qx::IxDataMember & i2);
    00322
    00323 #endif // _IX_DATA_MEMBER_H_