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