32#ifndef _IX_PERSISTABLE_H_
33#define _IX_PERSISTABLE_H_
61class IxPersistableCollection;
126 virtual QSqlError
qxFetchById(
const QVariant &
id = QVariant(),
const QStringList & columns = QStringList(),
const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL) = 0;
141 virtual QSqlError
qxFetchAll(
qx::IxPersistableCollection * list = NULL,
const QStringList & columns = QStringList(),
const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL) = 0;
170 virtual QSqlError
qxInsert(
const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL,
bool bUseExecBatch =
false) = 0;
185 virtual QSqlError
qxUpdate(
const qx::QxSqlQuery & query =
qx::QxSqlQuery(),
const QStringList & columns = QStringList(),
const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL,
bool bUseExecBatch =
false) = 0;
216 virtual QSqlError
qxDeleteById(
const QVariant &
id = QVariant(), QSqlDatabase * pDatabase = NULL,
bool bUseExecBatch =
false) = 0;
230 virtual QSqlError
qxDeleteAll(QSqlDatabase * pDatabase = NULL) = 0;
258 virtual QSqlError
qxDestroyById(
const QVariant &
id = QVariant(), QSqlDatabase * pDatabase = NULL,
bool bUseExecBatch =
false) = 0;
310 virtual qx_bool qxExist(
const QVariant &
id = QVariant(), QSqlDatabase * pDatabase = NULL) = 0;
335 virtual QString
toJson(
const QString & format = QString())
const = 0;
336 virtual QJsonValue
toJson_(
const QString & format = QString())
const = 0;
337 virtual qx_bool fromJson(
const QString & json,
const QString & format = QString()) = 0;
338 virtual qx_bool fromJson_(
const QJsonValue & json,
const QString & format = QString()) = 0;
343 static std::shared_ptr<qx::IxPersistableCollection>
qxFetchAll(
const QString & className,
const QStringList & columns = QStringList(),
const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL,
bool bAsList =
false);
344 static std::shared_ptr<qx::IxPersistableCollection>
qxFetchByQuery(
const QString & className,
const qx::QxSqlQuery & query,
const QStringList & columns = QStringList(),
const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL,
bool bAsList =
false);
345 static std::shared_ptr<qx::IxPersistableCollection>
qxExecuteQuery(
const QString & className,
qx::QxSqlQuery & query, QSqlDatabase * pDatabase = NULL,
bool bAsList =
false);
361struct is_ix_persistable
362{
enum {
value = std::is_base_of<qx::IxPersistable, T>::value }; };
368#define QX_PERSISTABLE_JSON_HPP(className) \
369virtual QString toJson(const QString & format = QString()) const; \
370virtual QJsonValue toJson_(const QString & format = QString()) const; \
371virtual qx_bool fromJson(const QString & json, const QString & format = QString()); \
372virtual qx_bool fromJson_(const QJsonValue & json, const QString & format = QString());
374#define QX_PERSISTABLE_JSON_HPP(className)
377#define QX_PERSISTABLE_HPP(className) \
379virtual long qxCount(const qx::QxSqlQuery & query = qx::QxSqlQuery(), QSqlDatabase * pDatabase = NULL, const QStringList & relation = QStringList()); \
380virtual QSqlError qxCount(long & lCount, const qx::QxSqlQuery & query = qx::QxSqlQuery(), QSqlDatabase * pDatabase = NULL, const QStringList & relation = QStringList()); \
381virtual QSqlError qxFetchById(const QVariant & id = QVariant(), const QStringList & columns = QStringList(), const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL); \
382virtual QSqlError qxFetchAll(qx::IxPersistableCollection * list = NULL, const QStringList & columns = QStringList(), const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL); \
383virtual QSqlError qxFetchByQuery(const qx::QxSqlQuery & query, qx::IxPersistableCollection * list = NULL, const QStringList & columns = QStringList(), const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL); \
384virtual QSqlError qxInsert(const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL, bool bUseExecBatch = false); \
385virtual QSqlError qxUpdate(const qx::QxSqlQuery & query = qx::QxSqlQuery(), const QStringList & columns = QStringList(), const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL, bool bUseExecBatch = false); \
386virtual QSqlError qxSave(const QStringList & relation = QStringList(), QSqlDatabase * pDatabase = NULL, qx::dao::save_mode::e_save_mode eSaveRecursiveMode = qx::dao::save_mode::e_none); \
387virtual QSqlError qxDeleteById(const QVariant & id = QVariant(), QSqlDatabase * pDatabase = NULL, bool bUseExecBatch = false); \
388virtual QSqlError qxDeleteAll(QSqlDatabase * pDatabase = NULL); \
389virtual QSqlError qxDeleteByQuery(const qx::QxSqlQuery & query, QSqlDatabase * pDatabase = NULL); \
390virtual QSqlError qxDestroyById(const QVariant & id = QVariant(), QSqlDatabase * pDatabase = NULL, bool bUseExecBatch = false); \
391virtual QSqlError qxDestroyAll(QSqlDatabase * pDatabase = NULL); \
392virtual QSqlError qxDestroyByQuery(const qx::QxSqlQuery & query, QSqlDatabase * pDatabase = NULL); \
393virtual QSqlError qxExecuteQuery(qx::QxSqlQuery & query, QSqlDatabase * pDatabase = NULL); \
394virtual QSqlError qxExecuteQuery(qx::QxSqlQuery & query, qx::IxPersistableCollection * list = NULL, QSqlDatabase * pDatabase = NULL); \
395virtual qx_bool qxExist(const QVariant & id = QVariant(), QSqlDatabase * pDatabase = NULL); \
396virtual qx::QxInvalidValueX qxValidate(const QStringList & groups = QStringList()); \
397virtual std::shared_ptr<qx::IxPersistableCollection> qxNewPersistableCollection(bool bAsList = false) const; \
398virtual qx::IxClass * qxClass() const; \
399QX_PERSISTABLE_JSON_HPP(className)
402#define QX_PERSISTABLE_CAST_COLLECTION(className) \
403if (! list) { return QSqlError(); } \
404qx::QxPersistableCollectionHelper< className >::type_coll * list_typed = static_cast< qx::QxPersistableCollectionHelper< className >::type * >(list);
406#define QX_PERSISTABLE_CAST_COLLECTION(className) \
407if (! list) { return QSqlError(); } \
408qx::QxPersistableCollectionHelper< className >::type_coll * list_typed = dynamic_cast< qx::QxPersistableCollectionHelper< className >::type * >(list);
412#define QX_PERSISTABLE_JSON_CPP(className) \
413QString className::toJson(const QString & format) const { return qx::serialization::json::to_string((* this), 1, format); } \
414QJsonValue className::toJson_(const QString & format) const { return qx::cvt::to_json((* this), format); } \
415qx_bool className::fromJson(const QString & json, const QString & format) { return qx::serialization::json::from_string((* this), json, 1, format); } \
416qx_bool className::fromJson_(const QJsonValue & json, const QString & format) { return qx::cvt::from_json(json, (* this), format); }
418#define QX_PERSISTABLE_JSON_CPP(className)
421#define QX_PERSISTABLE_CPP(className) \
423long className::qxCount(const qx::QxSqlQuery & query, QSqlDatabase * pDatabase, const QStringList & relation) \
425 if (relation.count() == 0) { return qx::dao::count< className >(query, pDatabase); } \
426 else { long lCount(0); qx::dao::count_with_relation< className >(lCount, relation, query, pDatabase); return lCount; } \
429QSqlError className::qxCount(long & lCount, const qx::QxSqlQuery & query, QSqlDatabase * pDatabase, const QStringList & relation) \
431 if (relation.count() == 0) { return qx::dao::count< className >(lCount, query, pDatabase); } \
432 else { return qx::dao::count_with_relation< className >(lCount, relation, query, pDatabase); } \
435QSqlError className::qxFetchById(const QVariant & id, const QStringList & columns, const QStringList & relation, QSqlDatabase * pDatabase) \
439 qx::IxDataMemberX * pDataMemberX = qx::QxClass< className >::getSingleton()->getDataMemberX(); \
440 qx::IxDataMember * pDataMemberId = (pDataMemberX ? pDataMemberX->getId_WithDaoStrategy() : NULL); \
441 if (! pDataMemberId) { qDebug("[QxOrm] problem with 'qxFetchById()' method : '%s'", "data member id not registered"); qAssert(false); } \
442 if (! pDataMemberId) { return QSqlError("[QxOrm] problem with 'qxFetchById()' method : 'data member id not registered'", "", QSqlError::UnknownError); } \
443 pDataMemberId->fromVariant(this, id, -1, qx::cvt::context::e_database); \
446 if (relation.count() == 0) { err = qx::dao::fetch_by_id((* this), pDatabase, columns); } \
447 else { err = qx::dao::fetch_by_id_with_relation(relation, (* this), pDatabase); } \
451QSqlError className::qxFetchAll(qx::IxPersistableCollection * list, const QStringList & columns, const QStringList & relation, QSqlDatabase * pDatabase) \
453 QX_PERSISTABLE_CAST_COLLECTION(className) \
454 if (! list_typed) { qDebug("[QxOrm] problem with 'qxFetchAll()' method : '%s'", "dynamic_cast failed using collection qx::QxCollection< type_primary_key, std::shared_ptr<type> >"); qAssert(false); } \
455 if (! list_typed) { return QSqlError("[QxOrm] problem with 'qxFetchAll()' method : 'dynamic_cast failed using collection qx::QxCollection< type_primary_key, std::shared_ptr<type> >'", "", QSqlError::UnknownError); } \
457 if (relation.count() == 0) { err = qx::dao::fetch_all((* list_typed), pDatabase, columns); } \
458 else { err = qx::dao::fetch_all_with_relation(relation, (* list_typed), pDatabase); } \
462QSqlError className::qxFetchByQuery(const qx::QxSqlQuery & query, qx::IxPersistableCollection * list, const QStringList & columns, const QStringList & relation, QSqlDatabase * pDatabase) \
464 QX_PERSISTABLE_CAST_COLLECTION(className) \
465 if (! list_typed) { qDebug("[QxOrm] problem with 'qxFetchByQuery()' method : '%s'", "dynamic_cast failed using collection qx::QxCollection< type_primary_key, std::shared_ptr<type> >"); qAssert(false); } \
466 if (! list_typed) { return QSqlError("[QxOrm] problem with 'qxFetchByQuery()' method : 'dynamic_cast failed using collection qx::QxCollection< type_primary_key, std::shared_ptr<type> >'", "", QSqlError::UnknownError); } \
468 if (relation.count() == 0) { err = qx::dao::fetch_by_query(query, (* list_typed), pDatabase, columns); } \
469 else { err = qx::dao::fetch_by_query_with_relation(relation, query, (* list_typed), pDatabase); } \
473QSqlError className::qxInsert(const QStringList & relation, QSqlDatabase * pDatabase, bool bUseExecBatch) \
476 if (relation.count() == 0) { err = qx::dao::insert((* this), pDatabase, bUseExecBatch); } \
477 else { err = qx::dao::insert_with_relation(relation, (* this), pDatabase); } \
481QSqlError className::qxUpdate(const qx::QxSqlQuery & query, const QStringList & columns, const QStringList & relation, QSqlDatabase * pDatabase, bool bUseExecBatch) \
484 if (relation.count() == 0) { err = qx::dao::update_by_query(query, (* this), pDatabase, columns, bUseExecBatch); } \
485 else { err = qx::dao::update_by_query_with_relation(relation, query, (* this), pDatabase); } \
489QSqlError className::qxSave(const QStringList & relation, QSqlDatabase * pDatabase, qx::dao::save_mode::e_save_mode eSaveRecursiveMode) \
492 if (eSaveRecursiveMode != qx::dao::save_mode::e_none) { err = qx::dao::save_with_relation_recursive((* this), eSaveRecursiveMode, pDatabase); } \
493 else if (relation.count() == 0) { err = qx::dao::save((* this), pDatabase); } \
494 else { err = qx::dao::save_with_relation(relation, (* this), pDatabase); } \
498QSqlError className::qxDeleteById(const QVariant & id, QSqlDatabase * pDatabase, bool bUseExecBatch) \
502 qx::IxDataMemberX * pDataMemberX = qx::QxClass< className >::getSingleton()->getDataMemberX(); \
503 qx::IxDataMember * pDataMemberId = (pDataMemberX ? pDataMemberX->getId_WithDaoStrategy() : NULL); \
504 if (! pDataMemberId) { qDebug("[QxOrm] problem with 'qxDeleteById()' method : '%s'", "data member id not registered"); qAssert(false); } \
505 if (! pDataMemberId) { return QSqlError("[QxOrm] problem with 'qxDeleteById()' method : 'data member id not registered'", "", QSqlError::UnknownError); } \
506 pDataMemberId->fromVariant(this, id, -1, qx::cvt::context::e_database); \
508 return qx::dao::delete_by_id((* this), pDatabase, bUseExecBatch); \
511QSqlError className::qxDeleteAll(QSqlDatabase * pDatabase) \
513 return qx::dao::delete_all< className >(pDatabase); \
516QSqlError className::qxDeleteByQuery(const qx::QxSqlQuery & query, QSqlDatabase * pDatabase) \
518 return qx::dao::delete_by_query< className >(query, pDatabase); \
521QSqlError className::qxDestroyById(const QVariant & id, QSqlDatabase * pDatabase, bool bUseExecBatch) \
525 qx::IxDataMemberX * pDataMemberX = qx::QxClass< className >::getSingleton()->getDataMemberX(); \
526 qx::IxDataMember * pDataMemberId = (pDataMemberX ? pDataMemberX->getId_WithDaoStrategy() : NULL); \
527 if (! pDataMemberId) { qDebug("[QxOrm] problem with 'qxDestroyById()' method : '%s'", "data member id not registered"); qAssert(false); } \
528 if (! pDataMemberId) { return QSqlError("[QxOrm] problem with 'qxDestroyById()' method : 'data member id not registered'", "", QSqlError::UnknownError); } \
529 pDataMemberId->fromVariant(this, id, -1, qx::cvt::context::e_database); \
531 return qx::dao::destroy_by_id((* this), pDatabase, bUseExecBatch); \
534QSqlError className::qxDestroyAll(QSqlDatabase * pDatabase) \
536 return qx::dao::destroy_all< className >(pDatabase); \
539QSqlError className::qxDestroyByQuery(const qx::QxSqlQuery & query, QSqlDatabase * pDatabase) \
541 return qx::dao::destroy_by_query< className >(query, pDatabase); \
544QSqlError className::qxExecuteQuery(qx::QxSqlQuery & query, QSqlDatabase * pDatabase) \
546 return qx::dao::execute_query(query, (* this), pDatabase); \
549QSqlError className::qxExecuteQuery(qx::QxSqlQuery & query, qx::IxPersistableCollection * list, QSqlDatabase * pDatabase) \
551 QX_PERSISTABLE_CAST_COLLECTION(className) \
552 if (! list_typed) { qDebug("[QxOrm] problem with 'qxExecuteQuery()' method : '%s'", "dynamic_cast failed using collection qx::QxCollection< type_primary_key, std::shared_ptr<type> >"); qAssert(false); } \
553 if (! list_typed) { return QSqlError("[QxOrm] problem with 'qxExecuteQuery()' method : 'dynamic_cast failed using collection qx::QxCollection< type_primary_key, std::shared_ptr<type> >'", "", QSqlError::UnknownError); } \
554 return qx::dao::execute_query(query, (* list_typed), pDatabase); \
557qx_bool className::qxExist(const QVariant & id, QSqlDatabase * pDatabase) \
561 qx::IxDataMemberX * pDataMemberX = qx::QxClass< className >::getSingleton()->getDataMemberX(); \
562 qx::IxDataMember * pDataMemberId = (pDataMemberX ? pDataMemberX->getId_WithDaoStrategy() : NULL); \
563 if (! pDataMemberId) { qDebug("[QxOrm] problem with 'qxExist()' method : '%s'", "data member id not registered"); qAssert(false); } \
564 if (! pDataMemberId) { return qx_bool(false); } \
565 pDataMemberId->fromVariant(this, id, -1, qx::cvt::context::e_database); \
567 return qx::dao::exist((* this), pDatabase); \
570qx::QxInvalidValueX className::qxValidate(const QStringList & groups) \
572 return qx::validate((* this), groups); \
575std::shared_ptr<qx::IxPersistableCollection> className::qxNewPersistableCollection(bool bAsList) const \
577 if (bAsList) { std::shared_ptr<qx::IxPersistableCollection> coll = std::make_shared<qx::QxPersistableList< className > >(); return coll; } \
578 else { std::shared_ptr<qx::IxPersistableCollection> coll = std::make_shared<qx::QxPersistableCollectionHelper< className >::type>(); return coll; } \
581qx::IxClass * className::qxClass() const \
583 return qx::QxClass< className >::getSingleton(); \
586QX_PERSISTABLE_JSON_CPP(className)
590#include <QxDao/IxPersistableCollection.h>
Concrete class registered into QxOrm context.
QxOrm thread-safe container (keep insertion order + quick access by index + quick access by key)
Provide template functions to map C++ class registered into QxOrm context with table database (ORM - ...
Define a user SQL query added to default SQL query builded by QxOrm library, and used by qx::dao::xxx...
To improve performance, if you know that you are just inserting or updating items in database.
Implementation of qx::validate<T>() function (validator engine)
qx::IxClass : common interface for all classes registered into QxOrm context
qx::IxPersistableCollection : common interface (abstract class) for collection persistent classes bas...
qx::IxPersistable : common interface (abstract class) for persistents classes using QX_PERSISTABLE_HP...
static std::shared_ptr< qx::IxPersistableCollection > qxFetchAll(const QString &className, const QStringList &columns=QStringList(), const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL, bool bAsList=false)
virtual QSqlError qxDestroyAll(QSqlDatabase *pDatabase=NULL)=0
Delete all lines of a table (database) mapped to current C++ class (registered into QxOrm context)
virtual QSqlError qxDeleteByQuery(const qx::QxSqlQuery &query, QSqlDatabase *pDatabase=NULL)=0
Delete all lines of a table (database) mapped to current C++ class (registered into QxOrm context) an...
virtual qx_bool fromJson(const QString &json, const QString &format=QString())=0
virtual QSqlError qxExecuteQuery(qx::QxSqlQuery &query, qx::IxPersistableCollection *list=NULL, QSqlDatabase *pDatabase=NULL)=0
Execute a custom SQL query or a stored procedure, all columns that can be mapped to the instance of t...
virtual QSqlError qxExecuteQuery(qx::QxSqlQuery &query, QSqlDatabase *pDatabase=NULL)=0
Execute a custom SQL query or a stored procedure, all columns that can be mapped to the instance of t...
virtual QSqlError qxSave(const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL, qx::dao::save_mode::e_save_mode eSaveRecursiveMode=qx::dao::save_mode::e_none)=0
Insert (if no exist) or update (if already exist) current instance into database.
virtual QSqlError qxDestroyByQuery(const qx::QxSqlQuery &query, QSqlDatabase *pDatabase=NULL)=0
Delete all lines of a table (database) mapped to current C++ class (registered into QxOrm context) an...
virtual QSqlError qxDeleteById(const QVariant &id=QVariant(), QSqlDatabase *pDatabase=NULL, bool bUseExecBatch=false)=0
Delete current instance from database.
virtual qx::IxClass * qxClass() const =0
Access to introspection engine (or reflection engine) of QxOrm library.
virtual qx_bool fromJson_(const QJsonValue &json, const QString &format=QString())=0
static std::shared_ptr< qx::IxPersistableCollection > qxFetchByQuery(const QString &className, const qx::QxSqlQuery &query, const QStringList &columns=QStringList(), const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL, bool bAsList=false)
virtual std::shared_ptr< qx::IxPersistableCollection > qxNewPersistableCollection(bool bAsList=false) const =0
Create a new collection smart-pointer to fetch a list of items of current class type.
virtual long qxCount(const qx::QxSqlQuery &query=qx::QxSqlQuery(), QSqlDatabase *pDatabase=NULL, const QStringList &relation=QStringList())=0
Return the number of lines in the table (database) mapped to the current C++ class (registered into Q...
virtual QSqlError qxFetchById(const QVariant &id=QVariant(), const QStringList &columns=QStringList(), const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL)=0
Fetch current instance (retrieve all its properties) mapped to a table in the database (current insta...
virtual QSqlError qxFetchAll(qx::IxPersistableCollection *list=NULL, const QStringList &columns=QStringList(), const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL)=0
Fetch a list of objects (retrieve all elements and properties associated) of current type (container ...
virtual QString toJson(const QString &format=QString()) const =0
virtual QJsonValue toJson_(const QString &format=QString()) const =0
virtual QSqlError qxUpdate(const qx::QxSqlQuery &query=qx::QxSqlQuery(), const QStringList &columns=QStringList(), const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL, bool bUseExecBatch=false)=0
Update current instance into database (you can add a user SQL query to the default SQL query builded ...
virtual QSqlError qxCount(long &lCount, const qx::QxSqlQuery &query=qx::QxSqlQuery(), QSqlDatabase *pDatabase=NULL, const QStringList &relation=QStringList())=0
Return the number of lines in the table (database) mapped to the current C++ class (registered into Q...
virtual QSqlError qxInsert(const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL, bool bUseExecBatch=false)=0
Insert current instance into database.
static std::shared_ptr< qx::IxPersistableCollection > qxExecuteQuery(const QString &className, qx::QxSqlQuery &query, QSqlDatabase *pDatabase=NULL, bool bAsList=false)
virtual QSqlError qxDeleteAll(QSqlDatabase *pDatabase=NULL)=0
Delete all lines of a table (database) mapped to current C++ class (registered into QxOrm context)
virtual QSqlError qxFetchByQuery(const qx::QxSqlQuery &query, qx::IxPersistableCollection *list=NULL, const QStringList &columns=QStringList(), const QStringList &relation=QStringList(), QSqlDatabase *pDatabase=NULL)=0
Fetch a list of objects (retrieve all elements and properties associated) of current type (container ...
virtual qx_bool qxExist(const QVariant &id=QVariant(), QSqlDatabase *pDatabase=NULL)=0
Search if current instance already exists into database.
virtual QSqlError qxDestroyById(const QVariant &id=QVariant(), QSqlDatabase *pDatabase=NULL, bool bUseExecBatch=false)=0
Delete current instance from database.
virtual qx::QxInvalidValueX qxValidate(const QStringList &groups=QStringList())=0
Check if current instance is valid or not.
qx_bool : boolean type with code and description message when an error occured
qx::QxInvalidValueX : list of invalid values
qx::QxSqlQuery : define a user SQL query added to default SQL query builded by QxOrm library,...
qx::trait::get_class_name<T>::get() : return class name of type T under const char * format,...
#define QX_REGISTER_CLASS_NAME(className)
Root namespace for all QxOrm library features.
std::shared_ptr< qx::IxPersistable > IxPersistable_ptr