QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
Loading...
Searching...
No Matches
qgsvectorlayerjoininfo.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorlayerjoininfo.h
3 ---------------------
4 begin : January 2017
5 copyright : (C) 2017 by Martin Dobias
6 email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSVECTORLAYERJOININFO_H
16#define QGSVECTORLAYERJOININFO_H
17
18#include <QHash>
19#include <QString>
20#include <QStringList>
21
22#include "qgsfeature.h"
23
24#include "qgsvectorlayerref.h"
25
32class CORE_EXPORT QgsVectorLayerJoinInfo
33{
34 public:
35
40
42 void setJoinLayer( QgsVectorLayer *layer ) { mJoinLayerRef = QgsVectorLayerRef( layer ); }
44 QgsVectorLayer *joinLayer() const { return mJoinLayerRef.get(); }
45
47 void setJoinLayerId( const QString &layerId ) { mJoinLayerRef = QgsVectorLayerRef( layerId ); }
49 QString joinLayerId() const { return mJoinLayerRef.layerId; }
50
52 void setTargetFieldName( const QString &fieldName ) { mTargetFieldName = fieldName; }
54 QString targetFieldName() const { return mTargetFieldName; }
55
57 void setJoinFieldName( const QString &fieldName ) { mJoinFieldName = fieldName; }
59 QString joinFieldName() const { return mJoinFieldName; }
60
62 void setPrefix( const QString &prefix ) { mPrefix = prefix; }
64 QString prefix() const { return mPrefix; }
65
67 void setUsingMemoryCache( bool enabled );
68
73 bool isUsingMemoryCache() const;
74
79 bool isDynamicFormEnabled() const { return mDynamicForm; }
80
85 void setDynamicFormEnabled( bool enabled ) { mDynamicForm = enabled; }
86
91 bool isEditable() const { return mEditable; }
92
96 void setEditable( bool enabled );
97
102 bool hasUpsertOnEdit() const { return mUpsertOnEdit; }
103
108 void setUpsertOnEdit( bool enabled ) { mUpsertOnEdit = enabled; }
109
114 bool hasCascadedDelete() const { return mCascadedDelete; }
115
120 void setCascadedDelete( bool enabled ) { mCascadedDelete = enabled; }
121
127 QString prefixedFieldName( const QgsField &field ) const;
128
135 QgsFeature extractJoinedFeature( const QgsFeature &feature ) const;
136
142 Q_DECL_DEPRECATED void setJoinFieldNamesBlackList( const QStringList &blackList ) SIP_DEPRECATED { mBlockList = blackList; }
143
149 Q_DECL_DEPRECATED QStringList joinFieldNamesBlackList() const SIP_DEPRECATED { return mBlockList; }
150
157 void setJoinFieldNamesBlockList( const QStringList &list ) { mBlockList = list; }
158
165 QStringList joinFieldNamesBlockList() const { return mBlockList; }
166
172 bool hasSubset( bool blocklisted = true ) const;
173
182 static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, bool blocklisted = true );
183
192 static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, const QgsFields &joinLayerFields, bool blocklisted = true );
193
194 bool operator==( const QgsVectorLayerJoinInfo &other ) const
195 {
196 return mTargetFieldName == other.mTargetFieldName &&
197 mJoinLayerRef.layerId == other.mJoinLayerRef.layerId &&
198 mJoinFieldName == other.mJoinFieldName &&
199 mJoinFieldsSubset == other.mJoinFieldsSubset &&
200 mMemoryCache == other.mMemoryCache &&
201 mPrefix == other.mPrefix;
202 }
203
211 void setJoinFieldNamesSubset( QStringList *fieldNamesSubset SIP_TRANSFER ) { mJoinFieldsSubset = std::shared_ptr<QStringList>( fieldNamesSubset ); }
212
221 QStringList *joinFieldNamesSubset() const { return mJoinFieldsSubset.get(); }
222
223 protected:
230
234 QString mPrefix;
235
237 bool mMemoryCache = false;
238
240 std::shared_ptr<QStringList> mJoinFieldsSubset;
241
242 // caching support
243
246
248 bool cacheDirty = true;
249
250 bool mDynamicForm = false;
251
252 bool mEditable = false;
253
254 bool mUpsertOnEdit = false;
255
256 bool mCascadedDelete = false;
257
258 QStringList mBlockList;
259
261 QHash< QString, QgsAttributes> cachedAttributes;
262
263};
264
265
266#endif // QGSVECTORLAYERJOININFO_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:56
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:53
Container of fields for a vector layer.
Definition qgsfields.h:45
Manages joined fields for a vector layer.
Defines left outer join from our vector layer to some other vector layer.
QStringList * joinFieldNamesSubset() const
Returns the subset of fields to be used from joined layer.
QgsVectorLayerJoinInfo()=default
Constructor for QgsVectorLayerJoinInfo.
void setDynamicFormEnabled(bool enabled)
Sets whether the form has to be dynamically updated with joined fields when a feature is being create...
bool hasCascadedDelete() const
Returns whether a feature deleted on the target layer has to impact the joined layer by deleting the ...
bool operator==(const QgsVectorLayerJoinInfo &other) const
void setJoinLayerId(const QString &layerId)
Sets ID of the joined layer. It will need to be overwritten by setJoinLayer() to a reference to real ...
Q_DECL_DEPRECATED void setJoinFieldNamesBlackList(const QStringList &blackList)
Sets a list of fields to ignore whatever happens.
std::shared_ptr< QStringList > mJoinFieldsSubset
Subset of fields to use from joined layer. nullptr = use all fields.
bool isDynamicFormEnabled() const
Returns whether the form has to be dynamically updated with joined fields when a feature is being cre...
bool hasUpsertOnEdit() const
Returns whether a feature created on the target layer has to impact the joined layer by creating a ne...
bool mMemoryCache
True if the join is cached in virtual memory.
bool isEditable() const
Returns whether joined fields may be edited through the form of the target layer.
QString mPrefix
An optional prefix.
void setCascadedDelete(bool enabled)
Sets whether a feature deleted on the target layer has to impact the joined layer by deleting the cor...
void setJoinFieldName(const QString &fieldName)
Sets name of the field of joined layer that will be used for join.
void setJoinFieldNamesBlockList(const QStringList &list)
Sets a list of fields to ignore whatever happens.
QString mJoinFieldName
Join field in the source layer.
QString prefix() const
Returns prefix of fields from the joined layer. If nullptr, joined layer's name will be used.
void setTargetFieldName(const QString &fieldName)
Sets name of the field of our layer that will be used for join.
QStringList joinFieldNamesBlockList() const
Returns the list of fields to ignore.
QString joinFieldName() const
Returns name of the field of joined layer that will be used for join.
void setUpsertOnEdit(bool enabled)
Sets whether a feature created on the target layer has to impact the joined layer by creating a new f...
QString targetFieldName() const
Returns name of the field of our layer that will be used for join.
QString joinLayerId() const
ID of the joined layer - may be used to resolve reference to the joined layer.
void setPrefix(const QString &prefix)
Sets prefix of fields from the joined layer. If nullptr, joined layer's name will be used.
QgsVectorLayerRef mJoinLayerRef
Weak reference to the joined layer.
void setJoinLayer(QgsVectorLayer *layer)
Sets weak reference to the joined layer.
Q_DECL_DEPRECATED QStringList joinFieldNamesBlackList() const
Returns the list of fields to ignore.
QgsVectorLayer * joinLayer() const
Returns joined layer (may be nullptr if the reference was set by layer ID and not resolved yet)
QHash< QString, QgsAttributes > cachedAttributes
Cache for joined attributes to provide fast lookup (size is 0 if no memory caching)
QString mTargetFieldName
Join field in the target layer.
void setJoinFieldNamesSubset(QStringList *fieldNamesSubset)
Sets the subset of fields to be used from joined layer.
Represents a vector layer which manages a vector based data sets.
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_TRANSFER
Definition qgis_sip.h:36
_LayerRef< QgsVectorLayer > QgsVectorLayerRef
QString layerId
Original layer ID.