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