35 QList<QgsVectorLayer *> lst;
45static bool _hasCycleDFS(
QgsVectorLayer *n, QHash<QgsVectorLayer *, int> &mark )
47 if ( mark.value( n ) == 1 )
49 if ( mark.value( n ) == 0 )
52 const auto outEdges { _outEdges( n ) };
55 if ( _hasCycleDFS( m, mark ) )
66 QMutexLocker locker( &mMutex );
67 mVectorJoins.push_back( joinInfo );
71 QHash<QgsVectorLayer *, int> markDFS;
72 if ( mLayer && _hasCycleDFS( mLayer, markDFS ) )
75 mVectorJoins.pop_back();
85 connectJoinedLayer( vl );
95 cacheJoinLayer( mVectorJoins.last() );
108 QMutexLocker locker( &mMutex );
109 for (
int i = 0; i < mVectorJoins.size(); ++i )
111 if ( mVectorJoins.at( i ).joinLayerId() == joinLayerId )
118 mVectorJoins.removeAt( i );
141 if ( joinFieldIndex < 0 || joinFieldIndex >= cacheLayer->
fields().
count() )
150 QVector<int> subsetIndices;
158 if ( !cacheLayerAttrs.contains( joinFieldIndex ) )
159 cacheLayerAttrs.append( joinFieldIndex );
168 QString key = attrs.at( joinFieldIndex ).toString();
172 for (
int i = 0; i < subsetIndices.count(); ++i )
173 subsetAttrs[i] = attrs.at( subsetIndices.at( i ) );
179 for (
int i = 0; i < attrs.size(); i++ )
181 if ( i == joinFieldIndex )
184 QString joinInfoPrefix = joinInfo.
prefix();
185 if ( joinInfoPrefix.isNull() )
186 joinInfoPrefix = QString(
"%1_" ).arg( cacheLayer->
name() );
189 const QString joinFieldName = joinInfoPrefix + cacheLayer->
fields().
names().at( i );
197 attributesCache.append( attrs.at( i ) );
214 QVector<int> subsetIndices;
215 for (
int i = 0; i < joinFieldsSubset.count(); ++i )
217 QString joinedFieldName = joinFieldsSubset.at( i );
218 int index = joinLayerFields.
lookupField( joinedFieldName );
221 subsetIndices.append( index );
225 QgsDebugError(
"Join layer subset field not found: " + joinedFieldName );
229 return subsetIndices;
236 QList< QgsVectorLayerJoinInfo>::const_iterator joinIt = mVectorJoins.constBegin();
237 for (
int joinIdx = 0; joinIt != mVectorJoins.constEnd(); ++joinIt, ++joinIdx )
246 QString joinFieldName = joinIt->joinFieldName();
248 QSet<QString> subset;
249 if ( joinIt->hasSubset() )
252 subset = qgis::listToSet( subsetNames );
255 if ( joinIt->prefix().isNull() )
257 prefix = joinLayer->
name() +
'_';
261 prefix = joinIt->prefix();
264 for (
int idx = 0; idx < joinFields.
count(); ++idx )
267 if ( joinIt->hasSubset() && !subset.contains( joinFields.
at( idx ).
name() ) )
272 if ( joinIt->hasSubset() || joinFields.
at( idx ).
name() != joinFieldName )
284 QMutexLocker locker( &mMutex );
285 QList< QgsVectorLayerJoinInfo >::iterator joinIt = mVectorJoins.begin();
286 for ( ; joinIt != mVectorJoins.end(); ++joinIt )
288 if ( joinIt->isUsingMemoryCache() && joinIt->cacheDirty )
289 cacheJoinLayer( *joinIt );
296 QDomElement vectorJoinsElem = document.createElement( QStringLiteral(
"vectorjoins" ) );
297 layer_node.appendChild( vectorJoinsElem );
298 QList< QgsVectorLayerJoinInfo >::const_iterator joinIt = mVectorJoins.constBegin();
299 for ( ; joinIt != mVectorJoins.constEnd(); ++joinIt )
304 QDomElement joinElem = document.createElement( QStringLiteral(
"join" ) );
306 joinElem.setAttribute( QStringLiteral(
"targetFieldName" ), joinIt->targetFieldName() );
308 joinElem.setAttribute( QStringLiteral(
"joinLayerId" ), joinIt->joinLayerId() );
309 joinElem.setAttribute( QStringLiteral(
"joinFieldName" ), joinIt->joinFieldName() );
311 joinElem.setAttribute( QStringLiteral(
"memoryCache" ), joinIt->isUsingMemoryCache() );
312 joinElem.setAttribute( QStringLiteral(
"dynamicForm" ), joinIt->isDynamicFormEnabled() );
313 joinElem.setAttribute( QStringLiteral(
"editable" ), joinIt->isEditable() );
314 joinElem.setAttribute( QStringLiteral(
"upsertOnEdit" ), joinIt->hasUpsertOnEdit() );
315 joinElem.setAttribute( QStringLiteral(
"cascadedDelete" ), joinIt->hasCascadedDelete() );
317 if ( joinIt->hasSubset() )
319 QDomElement subsetElem = document.createElement( QStringLiteral(
"joinFieldsSubset" ) );
322 const auto constSubsetNames = subsetNames;
323 for (
const QString &fieldName : constSubsetNames )
325 QDomElement fieldElem = document.createElement( QStringLiteral(
"field" ) );
326 fieldElem.setAttribute( QStringLiteral(
"name" ), fieldName );
327 subsetElem.appendChild( fieldElem );
330 joinElem.appendChild( subsetElem );
333 if ( !joinIt->prefix().isNull() )
335 joinElem.setAttribute( QStringLiteral(
"customPrefix" ), joinIt->prefix() );
336 joinElem.setAttribute( QStringLiteral(
"hasCustomPrefix" ), 1 );
339 vectorJoinsElem.appendChild( joinElem );
345 mVectorJoins.clear();
346 QDomElement vectorJoinsElem = layer_node.firstChildElement( QStringLiteral(
"vectorjoins" ) );
347 if ( !vectorJoinsElem.isNull() )
349 QDomNodeList joinList = vectorJoinsElem.elementsByTagName( QStringLiteral(
"join" ) );
350 for (
int i = 0; i < joinList.size(); ++i )
352 QDomElement infoElem = joinList.at( i ).toElement();
354 info.
setJoinFieldName( infoElem.attribute( QStringLiteral(
"joinFieldName" ) ) );
356 info.
setJoinLayerId( infoElem.attribute( QStringLiteral(
"joinLayerId" ) ) );
360 info.
setEditable( infoElem.attribute( QStringLiteral(
"editable" ) ).toInt() );
361 info.
setUpsertOnEdit( infoElem.attribute( QStringLiteral(
"upsertOnEdit" ) ).toInt() );
362 info.
setCascadedDelete( infoElem.attribute( QStringLiteral(
"cascadedDelete" ) ).toInt() );
364 QDomElement subsetElem = infoElem.firstChildElement( QStringLiteral(
"joinFieldsSubset" ) );
365 if ( !subsetElem.isNull() )
367 QStringList *fieldNames =
new QStringList;
368 QDomNodeList fieldNodes = infoElem.elementsByTagName( QStringLiteral(
"field" ) );
369 fieldNames->reserve( fieldNodes.count() );
370 for (
int i = 0; i < fieldNodes.count(); ++i )
371 *fieldNames << fieldNodes.at( i ).toElement().attribute( QStringLiteral(
"name" ) );
375 if ( infoElem.attribute( QStringLiteral(
"hasCustomPrefix" ) ).toInt() )
376 info.
setPrefix( infoElem.attribute( QStringLiteral(
"customPrefix" ) ) );
387 bool resolved =
false;
388 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
390 if ( it->joinLayer() )
393 if (
QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( project->
mapLayer( it->joinLayerId() ) ) )
395 it->setJoinLayer( joinedLayer );
396 connectJoinedLayer( joinedLayer );
410 int joinIndex = mVectorJoins.indexOf( *info );
411 if ( joinIndex == -1 )
414 for (
int i = 0; i < fields.
count(); ++i )
431 int sourceJoinIndex = originIndex / 1000;
432 sourceFieldIndex = originIndex % 1000;
434 if ( sourceJoinIndex < 0 || sourceJoinIndex >= mVectorJoins.count() )
437 return &( mVectorJoins[sourceJoinIndex] );
442 QList<const QgsVectorLayerJoinInfo *> infos;
444 const auto constMVectorJoins = mVectorJoins;
447 if ( infos.contains( &info ) )
450 if ( info.targetFieldName() == field.
name() )
451 infos.append( &info );
478 return joinedFeature;
498 return targetedFeature;
504 cloned->mVectorJoins = mVectorJoins;
508void QgsVectorLayerJoinBuffer::joinedLayerUpdatedFields()
513 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
514 Q_ASSERT( joinedLayer );
517 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
519 if ( joinedLayer == it->joinLayer() )
521 it->cachedAttributes.clear();
522 cacheJoinLayer( *it );
529void QgsVectorLayerJoinBuffer::joinedLayerModified()
531 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
532 Q_ASSERT( joinedLayer );
535 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
537 if ( joinedLayer == it->joinLayer() )
539 it->cacheDirty =
true;
544void QgsVectorLayerJoinBuffer::joinedLayerWillBeDeleted()
546 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
547 Q_ASSERT( joinedLayer );
552void QgsVectorLayerJoinBuffer::connectJoinedLayer(
QgsVectorLayer *vl )
570 if ( joinLayer && joinLayer->
isEditable() && info.isEditable() && info.hasUpsertOnEdit() )
574 for (
const QgsFeature &feature : std::as_const( features ) )
576 const QgsFeature joinFeature = info.extractJoinedFeature( feature );
580 const QVariant idFieldValue = feature.
attribute( info.targetFieldName() );
593 if ( existingFeature.
isValid() )
595 if ( info.hasSubset() )
598 const auto constSubsetNames = subsetNames;
599 for (
const QString &field : constSubsetNames )
601 QVariant newValue = joinFeature.
attribute( field );
609 for (
const auto &field : joinFields )
611 QVariant newValue = joinFeature.
attribute( field.name() );
612 int fieldIndex = joinLayer->
fields().
indexOf( field.name() );
620 bool notNullFields =
false;
622 for (
const auto &field : joinFields )
624 if ( field.name() == info.joinFieldName() )
629 notNullFields =
true;
635 joinFeatures << joinFeature;
678 for (
auto it = newValues.constBegin(); it != newValues.constEnd(); ++it )
680 const int field = it.key();
681 const QVariant newValue = it.value();
684 if ( oldValues.contains( field ) )
685 oldValue = oldValues[field];
703 const auto constFids = fids;
709 if ( info.isEditable() && info.hasCascadedDelete() )
713 info.joinLayer()->deleteFeature( joinFeature.
id(), context );
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ Join
Field originates from a joined layer.
Class allowing to manage the auxiliary storage for a vector layer.
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QMetaType::Type fieldType=QMetaType::Type::UnknownType)
Create an expression allowing to evaluate if a field is equal to a value.
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setLimit(long long limit)
Set the maximum number of features to request.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsFeatureRequest & setNoAttributes()
Set that no attributes will be fetched.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Q_INVOKABLE bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
void setFields(const QgsFields &fields, bool initAttributes=false)
Assigns a field map with the feature to allow attribute access by attribute name.
bool isValid() const
Returns the validity of this feature.
Q_INVOKABLE QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Encapsulate a field in an attribute table or data source.
void setName(const QString &name)
Set the field name.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
Q_INVOKABLE int indexFromName(const QString &fieldName) const
Gets the field index from the field name.
Q_INVOKABLE int indexOf(const QString &fieldName) const
Gets the field index from the field name.
Qgis::FieldOrigin fieldOrigin(int fieldIdx) const
Returns the field's origin (value from an enumeration).
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
int fieldOriginIndex(int fieldIdx) const
Returns the field's origin index (its meaning is specific to each type of origin).
Q_INVOKABLE int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
void willBeDeleted()
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid...
void layerModified()
Emitted when modifications has been done on layer.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
Manages joined fields for a vector layer.
void resolveReferences(QgsProject *project)
Resolves layer IDs of joined layers using given project's available layers.
QgsFeature targetedFeatureOf(const QgsVectorLayerJoinInfo *info, const QgsFeature &feature) const
Returns the targeted feature corresponding to the joined feature.
bool addJoin(const QgsVectorLayerJoinInfo &joinInfo)
Joins another vector layer to this layer.
void readXml(const QDomNode &layer_node)
Reads joins from project file.
QgsVectorLayerJoinBuffer(QgsVectorLayer *layer=nullptr)
void writeXml(QDomNode &layer_node, QDomDocument &document) const
Saves mVectorJoins to xml under the layer node.
int joinedFieldsOffset(const QgsVectorLayerJoinInfo *info, const QgsFields &fields)
Find out what is the first index of the join within fields.
const QgsVectorLayerJoinInfo * joinForFieldIndex(int index, const QgsFields &fields, int &sourceFieldIndex) const
Finds the vector join for a layer field index.
bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
Changes attribute value in joined layers.
bool deleteFeatures(const QgsFeatureIds &fids, QgsVectorLayer::DeleteContext *context=nullptr) const
Deletes a list of features from joined layers.
QList< const QgsVectorLayerJoinInfo * > joinsWhereFieldIsId(const QgsField &field) const
Returns joins where the field of a target layer is considered as an id.
bool removeJoin(const QString &joinLayerId)
Removes a vector layer join.
bool containsJoins() const
Quick way to test if there is any join at all.
bool changeAttributeValues(QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues=QgsAttributeMap())
Changes attributes' values in joined layers.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features in joined layers.
QgsVectorLayerJoinBuffer * clone() const
Create a copy of the join buffer.
void joinedFieldsChanged()
Emitted whenever the list of joined fields changes (e.g.
void createJoinCaches()
Calls cacheJoinLayer() for all vector joins.
void updateFields(QgsFields &fields)
Updates field map with joined attributes.
static QVector< int > joinSubsetIndices(QgsVectorLayer *joinLayer, const QStringList &joinFieldsSubset)
Returns a vector of indices for use in join based on field names from the layer.
bool deleteFeature(QgsFeatureId fid, QgsVectorLayer::DeleteContext *context=nullptr) const
Deletes a feature from joined layers.
QgsFeature joinedFeatureOf(const QgsVectorLayerJoinInfo *info, const QgsFeature &feature) const
Returns the joined feature corresponding to the feature.
const QgsVectorJoinList & vectorJoins() const
bool isAuxiliaryJoin(const QgsVectorLayerJoinInfo &info) const
Returns true if the join information is about auxiliary layer, false otherwise.
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.
void setDynamicFormEnabled(bool enabled)
Sets whether the form has to be dynamically updated with joined fields when a feature is being create...
void setUsingMemoryCache(bool enabled)
Sets whether values from the joined layer should be cached in memory to speed up lookups.
void setJoinLayerId(const QString &layerId)
Sets ID of the joined layer. It will need to be overwritten by setJoinLayer() to a reference to real ...
void setEditable(bool enabled)
Sets whether the form of the target layer allows editing joined fields.
bool cacheDirty
True if the cached join attributes need to be updated.
bool isEditable() const
Returns whether joined fields may be edited through the form of the target layer.
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.
bool isUsingMemoryCache() const
Returns whether values from the joined layer should be cached in memory to speed up lookups.
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.
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.
bool hasSubset(bool blocklisted=true) const
Returns true if blocklisted fields is not empty or if a subset of names has been set.
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)
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.
Q_INVOKABLE bool changeAttributeValue(QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant(), bool skipDefaultValues=false, QgsVectorLayerToolsContext *context=nullptr)
Changes an attribute value for a feature (but does not immediately commit the changes).
void updateFields()
Will regenerate the fields property of this layer by obtaining all fields from the dataProvider,...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL
Adds a list of features to the sink.
QgsAuxiliaryLayer * auxiliaryLayer()
Returns the current auxiliary layer.
bool isEditable() const FINAL
Returns true if the provider is in editing mode.
void updatedFields()
Emitted whenever the fields available from this layer have been changed.
const QList< QgsVectorLayerJoinInfo > vectorJoins() const
Q_INVOKABLE QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
QMap< int, QVariant > QgsAttributeMap
QList< QgsFeature > QgsFeatureList
QSet< QgsFeatureId > QgsFeatureIds
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
QList< int > QgsAttributeList
#define QgsDebugError(str)
QList< QgsVectorLayerJoinInfo > QgsVectorJoinList
Context for cascade delete features.