QxOrm 1.5.0
C++ Object Relational Mapping library
Loading...
Searching...
No Matches
IxSqlRelation.h
Go to the documentation of this file.
1/****************************************************************************
2**
3** https://www.qxorm.com/
4** Copyright (C) 2013 Lionel Marty (contact@qxorm.com)
5**
6** This file is part of the QxOrm library
7**
8** This software is provided 'as-is', without any express or implied
9** warranty. In no event will the authors be held liable for any
10** damages arising from the use of this software
11**
12** Commercial Usage
13** Licensees holding valid commercial QxOrm licenses may use this file in
14** accordance with the commercial license agreement provided with the
15** Software or, alternatively, in accordance with the terms contained in
16** a written agreement between you and Lionel Marty
17**
18** GNU General Public License Usage
19** Alternatively, this file may be used under the terms of the GNU
20** General Public License version 3.0 as published by the Free Software
21** Foundation and appearing in the file 'license.gpl3.txt' included in the
22** packaging of this file. Please review the following information to
23** ensure the GNU General Public License version 3.0 requirements will be
24** met : http://www.gnu.org/copyleft/gpl.html
25**
26** If you are unsure which license is appropriate for your use, or
27** if you have questions regarding the use of this file, please contact :
28** contact@qxorm.com
29**
30****************************************************************************/
31
32#ifndef _IX_SQL_RELATION_H_
33#define _IX_SQL_RELATION_H_
34
35#ifdef _MSC_VER
36#pragma once
37#endif
38
45
47
49#include <QxDao/QxSoftDelete.h>
50#include <QxDao/QxSqlJoin.h>
51
53
54namespace qx {
55
56class IxClass;
57class IxDataMember;
58class IxDataMemberX;
59class IxSqlRelation;
60
62typedef std::shared_ptr<IxSqlRelationX> IxSqlRelationX_ptr;
63
69{
70
71private:
72
73 struct IxSqlRelationImpl;
74 std::unique_ptr<IxSqlRelationImpl> m_pImpl;
75
76public:
77
79
81 virtual ~IxSqlRelation() = 0;
82
85
89 IxClass * getClass() const;
95
98
99 QString getKey() const;
100 QString getForeignKey() const;
101 QString getForeignKeyOwner() const;
102 QString getForeignKeyDataType() const;
103 QString getExtraTable() const;
104 long getDataCount() const;
105 long getRelationCount() const;
106 IxDataMember * getDataByKey(const QString & sKey) const;
107 IxDataMember * nextData(long & lIndex) const;
108 IxSqlRelation * nextRelation(long & lIndex) const;
109 QString table() const;
110 QString tableAlias(QxSqlRelationParams & params) const;
111 QString tableAliasOwner(QxSqlRelationParams & params) const;
113 bool traceSqlQuery() const;
114
115 virtual void init();
116 virtual QString getDescription() const = 0;
117 virtual QString createExtraTable() const = 0;
118 virtual bool getCartesianProduct() const = 0;
119 virtual QVariant getIdFromQuery(bool bEager, QxSqlRelationParams & params, int iOffset, int iNameIndex) const = 0;
120 virtual void updateOffset(bool bEager, QxSqlRelationParams & params) const = 0;
121 virtual void createTable(QxSqlRelationParams & params) const = 0;
122 virtual void lazySelect(QxSqlRelationParams & params) const = 0;
123 virtual void eagerSelect(QxSqlRelationParams & params) const = 0;
124 virtual void lazyFrom(QxSqlRelationParams & params) const = 0;
125 virtual void eagerFrom(QxSqlRelationParams & params) const = 0;
126 virtual void lazyJoin(QxSqlRelationParams & params) const = 0;
127 virtual void eagerJoin(QxSqlRelationParams & params) const = 0;
128 virtual void lazyWhere(QxSqlRelationParams & params) const = 0;
129 virtual void eagerWhere(QxSqlRelationParams & params) const = 0;
130 virtual void lazyWhereSoftDelete(QxSqlRelationParams & params) const = 0;
131 virtual void eagerWhereSoftDelete(QxSqlRelationParams & params) const = 0;
132 virtual void lazyFetch_ResolveInput(QxSqlRelationParams & params) const = 0;
133 virtual void eagerFetch_ResolveInput(QxSqlRelationParams & params) const = 0;
134 virtual void lazyFetch_ResolveOutput(QxSqlRelationParams & params) const = 0;
135 virtual void * eagerFetch_ResolveOutput(QxSqlRelationParams & params) const = 0;
136 virtual void lazyInsert(QxSqlRelationParams & params) const = 0;
137 virtual void lazyInsert_Values(QxSqlRelationParams & params) const = 0;
138 virtual void lazyUpdate(QxSqlRelationParams & params) const = 0;
139 virtual void lazyInsert_ResolveInput(QxSqlRelationParams & params) const = 0;
140 virtual void lazyUpdate_ResolveInput(QxSqlRelationParams & params) const = 0;
141 virtual QSqlError onBeforeSave(QxSqlRelationParams & params) const = 0;
142 virtual QSqlError onAfterSave(QxSqlRelationParams & params) const = 0;
143
144 bool verifyOffset(QxSqlRelationParams & params, bool bId) const QX_USED;
145
146 static void setTraceRelationInit(bool bTrace);
147
148protected:
149
150 QVariant getIdFromQuery_ManyToMany(bool bEager, QxSqlRelationParams & params, int iOffset, int iNameIndex) const;
151 QVariant getIdFromQuery_ManyToOne(bool bEager, QxSqlRelationParams & params, int iOffset, int iNameIndex) const;
152 QVariant getIdFromQuery_OneToMany(bool bEager, QxSqlRelationParams & params, int iOffset, int iNameIndex) const;
153 QVariant getIdFromQuery_OneToOne(bool bEager, QxSqlRelationParams & params, int iOffset, int iNameIndex) const;
154
155 void updateOffset_ManyToMany(bool bEager, QxSqlRelationParams & params) const;
156 void updateOffset_ManyToOne(bool bEager, QxSqlRelationParams & params) const;
157 void updateOffset_OneToMany(bool bEager, QxSqlRelationParams & params) const;
158 void updateOffset_OneToOne(bool bEager, QxSqlRelationParams & params) const;
159
164
169
174
179
183
184 bool addLazyRelation(QxSqlRelationParams & params, IxSqlRelation * pRelation) const;
185
186 bool canInit() const;
188 void setClass(IxClass * pClass, IxClass * pClassOwner);
190 void setForeignKey(const QString & s) const;
191 void setForeignKeyOwner(const QString & s) const;
192 void setForeignKeyDataType(const QString & s) const;
193 void setExtraTable(const QString & s) const;
194
195};
196
197} // namespace qx
198
199#endif // _IX_SQL_RELATION_H_
QxOrm thread-safe container (keep insertion order + quick access by index + quick access by key)
#define QX_USED
Definition QxMacro.h:244
#define QX_DLL_EXPORT
Definition QxMacro.h:182
Used by introspection engine (IxClass, IxDataMember, IxFunction, etc.) to add meta-data (property bag...
Soft delete (or logical delete) behavior to update a row into database (flag it as deleted) instead o...
Define how to join 2 tables into SQL query (LEFT OUTER JOIN, INNER JOIN, etc...)
Define list of parameters to transfer to relationships to manage SQL queries builded by QxOrm library...
qx::IxClass : common interface for all classes registered into QxOrm context
Definition IxClass.h:69
qx::IxDataMember : common interface for all class properties registered into QxOrm context
qx::IxDataMemberX : common interface for a list of IxDataMember class properties registered into QxOr...
qx::IxSqlRelation : common interface for all relationships defined between 2 classes (or between 2 ta...
IxClass * getClass() const
void lazyInsert_ManyToOne(QxSqlRelationParams &params) const
long getDataCount() const
bool addLazyRelation(QxSqlRelationParams &params, IxSqlRelation *pRelation) const
void setForeignKeyDataType(const QString &s) const
QString table() const
IxDataMemberX * getDataMemberX() const
QString getSqlJoin(qx::dao::sql_join::join_type e=qx::dao::sql_join::no_join) const
QxCollection< QString, IxDataMember * > * getLstDataMember() const
QVariant getIdFromQuery_OneToMany(bool bEager, QxSqlRelationParams &params, int iOffset, int iNameIndex) const
IxDataMember * getDataByKey(const QString &sKey) const
void eagerJoin_ManyToOne(QxSqlRelationParams &params) const
virtual QSqlError onAfterSave(QxSqlRelationParams &params) const =0
IxClass * getClassOwner() const
void eagerJoin_OneToOne(QxSqlRelationParams &params) const
virtual void eagerFrom(QxSqlRelationParams &params) const =0
void eagerWhereSoftDelete_OneToOne(QxSqlRelationParams &params) const
QSqlError deleteFromExtraTable_ManyToMany(QxSqlRelationParams &params) const
QString getExtraTable() const
void updateOffset_ManyToOne(bool bEager, QxSqlRelationParams &params) const
virtual void lazyInsert_ResolveInput(QxSqlRelationParams &params) const =0
virtual void lazyUpdate(QxSqlRelationParams &params) const =0
virtual void createTable(QxSqlRelationParams &params) const =0
QVariant getIdFromQuery_ManyToOne(bool bEager, QxSqlRelationParams &params, int iOffset, int iNameIndex) const
void createTable_ManyToOne(QxSqlRelationParams &params) const
QString createExtraTable_ManyToMany() const
IxSqlRelation(IxDataMember *p)
void eagerSelect_OneToMany(QxSqlRelationParams &params) const
std::unique_ptr< IxSqlRelationImpl > m_pImpl
Private implementation idiom.
virtual void eagerSelect(QxSqlRelationParams &params) const =0
void eagerSelect_OneToOne(QxSqlRelationParams &params) const
void eagerWhereSoftDelete_ManyToOne(QxSqlRelationParams &params) const
bool traceSqlQuery() const
void setIsSameDataOwner(int i)
void eagerSelect_ManyToOne(QxSqlRelationParams &params) const
QString tableAlias(QxSqlRelationParams &params) const
IxDataMember * getDataId() const
void eagerWhereSoftDelete_ManyToMany(QxSqlRelationParams &params) const
virtual void lazyFetch_ResolveOutput(QxSqlRelationParams &params) const =0
virtual void eagerWhere(QxSqlRelationParams &params) const =0
void updateOffset_OneToOne(bool bEager, QxSqlRelationParams &params) const
bool verifyOffset(QxSqlRelationParams &params, bool bId) const QX_USED
QString getForeignKeyDataType() const
void setExtraTable(const QString &s) const
void lazyUpdate_ManyToOne(QxSqlRelationParams &params) const
void lazySelect_ManyToOne(QxSqlRelationParams &params) const
bool canInit() const
QString getForeignKeyOwner() const
IxDataMember * nextData(long &lIndex) const
void eagerSelect_ManyToMany(QxSqlRelationParams &params) const
void updateOffset_ManyToMany(bool bEager, QxSqlRelationParams &params) const
void setClass(IxClass *pClass, IxClass *pClassOwner)
virtual void * eagerFetch_ResolveOutput(QxSqlRelationParams &params) const =0
IxSqlRelation * nextRelation(long &lIndex) const
static void setTraceRelationInit(bool bTrace)
virtual ~IxSqlRelation()=0
IxDataMember * getDataMember() const
IxDataMember * getDataIdOwner() const
virtual void lazyFrom(QxSqlRelationParams &params) const =0
virtual QSqlError onBeforeSave(QxSqlRelationParams &params) const =0
virtual bool getCartesianProduct() const =0
virtual void lazyInsert_Values(QxSqlRelationParams &params) const =0
void eagerJoin_ManyToMany(QxSqlRelationParams &params) const
virtual void eagerJoin(QxSqlRelationParams &params) const =0
void lazyInsert_Values_ManyToOne(QxSqlRelationParams &params) const
IxSqlRelationX * getLstRelation() const
QString getKey() const
QString getForeignKey() const
virtual void lazyJoin(QxSqlRelationParams &params) const =0
QVariant getIdFromQuery_OneToOne(bool bEager, QxSqlRelationParams &params, int iOffset, int iNameIndex) const
virtual QVariant getIdFromQuery(bool bEager, QxSqlRelationParams &params, int iOffset, int iNameIndex) const =0
virtual void lazyWhere(QxSqlRelationParams &params) const =0
void setRelationType(relation_type e)
virtual QString getDescription() const =0
void updateOffset_OneToMany(bool bEager, QxSqlRelationParams &params) const
void linkRelationKeyTo(IxDataMember *p)
virtual void init()
virtual QString createExtraTable() const =0
QVariant getIdFromQuery_ManyToMany(bool bEager, QxSqlRelationParams &params, int iOffset, int iNameIndex) const
virtual void eagerFetch_ResolveInput(QxSqlRelationParams &params) const =0
virtual void updateOffset(bool bEager, QxSqlRelationParams &params) const =0
void eagerWhereSoftDelete_OneToMany(QxSqlRelationParams &params) const
qx::dao::sql_join::join_type getSqlJoinType() const
virtual void lazyInsert(QxSqlRelationParams &params) const =0
relation_type getRelationType() const
void setForeignKeyOwner(const QString &s) const
IxDataMember * getLinkRelationKey() const
virtual void eagerWhereSoftDelete(QxSqlRelationParams &params) const =0
long getRelationCount() const
void setSqlJoinType(qx::dao::sql_join::join_type e)
void setForeignKey(const QString &s) const
virtual void lazyFetch_ResolveInput(QxSqlRelationParams &params) const =0
virtual void lazyWhereSoftDelete(QxSqlRelationParams &params) const =0
virtual void lazySelect(QxSqlRelationParams &params) const =0
void eagerJoin_OneToMany(QxSqlRelationParams &params) const
virtual void lazyUpdate_ResolveInput(QxSqlRelationParams &params) const =0
QString tableAliasOwner(QxSqlRelationParams &params) const
qx::QxCollection<Key, Value> : QxOrm thread-safe container (keep insertion order + quick access by in...
qx::QxPropertyBag : used by introspection engine (IxClass, IxDataMember, IxFunction,...
qx::QxSqlRelationParams : define list of parameters to transfer to relationships to manage SQL querie...
Root namespace for all QxOrm library features.
std::shared_ptr< IxSqlRelationX > IxSqlRelationX_ptr
QxCollection< QString, IxSqlRelation * > IxSqlRelationX