15#ifndef QGSVECTORLAYERJOININFO_H
16#define QGSVECTORLAYERJOININFO_H
63 void setPrefix(
const QString &prefix ) { mPrefix = prefix; }
65 QString
prefix()
const {
return mPrefix; }
68 void setUsingMemoryCache(
bool enabled );
74 bool isUsingMemoryCache()
const;
101 void setEditable(
bool enabled );
137 QString prefixedFieldName(
const QgsField &field )
const;
184 bool hasSubset(
bool blocklisted =
true )
const;
253 bool mMemoryCache =
false;
264 bool cacheDirty =
true;
266 bool mDynamicForm =
false;
268 bool mEditable =
false;
270 bool mUpsertOnEdit =
false;
272 bool mCascadedDelete =
false;
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
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.
_LayerRef< QgsVectorLayer > QgsVectorLayerRef
QString layerId
Original layer ID.