29#include "moc_qgsvectorlayerjoinbuffer.cpp"
31using namespace Qt::StringLiterals;
40 QList<QgsVectorLayer *> lst;
50static bool _hasCycleDFS(
QgsVectorLayer *n, QHash<QgsVectorLayer *, int> &mark )
52 if ( mark.value( n ) == 1 )
54 if ( mark.value( n ) == 0 )
57 const auto outEdges { _outEdges( n ) };
60 if ( _hasCycleDFS( m, mark ) )
71 QMutexLocker locker( &mMutex );
72 mVectorJoins.push_back( joinInfo );
76 QHash<QgsVectorLayer *, int> markDFS;
77 if ( mLayer && _hasCycleDFS( mLayer, markDFS ) )
80 mVectorJoins.pop_back();
90 connectJoinedLayer( vl );
96 mLayer->updateFields();
103 cacheJoinLayer( mVectorJoins.last() );
116 QMutexLocker locker( &mMutex );
117 for (
int i = 0; i < mVectorJoins.size(); ++i )
119 if ( mVectorJoins.at( i ).joinLayerId() == joinLayerId )
126 mVectorJoins.removeAt( i );
144 QgsVectorLayer *cacheLayer = joinInfo.
joinLayer();
149 if ( joinFieldIndex < 0 || joinFieldIndex >= cacheLayer->
fields().
count() )
154 QgsFeatureRequest request;
158 QVector<int> subsetIndices;
166 if ( !cacheLayerAttrs.contains( joinFieldIndex ) )
167 cacheLayerAttrs.append( joinFieldIndex );
171 QgsFeatureIterator fit = cacheLayer->
getFeatures( request );
176 QString key = attrs.at( joinFieldIndex ).toString();
179 QgsAttributes subsetAttrs( subsetIndices.count() );
180 for (
int i = 0; i < subsetIndices.count(); ++i )
181 subsetAttrs[i] = attrs.at( subsetIndices.at( i ) );
186 QgsAttributes attributesCache;
187 for (
int i = 0; i < attrs.size(); i++ )
189 if ( i == joinFieldIndex )
192 QString joinInfoPrefix = joinInfo.
prefix();
193 if ( joinInfoPrefix.isNull() )
194 joinInfoPrefix = QString(
"%1_" ).arg( cacheLayer->
name() );
197 const QString joinFieldName = joinInfoPrefix + cacheLayer->
fields().
names().at( i );
200 int fieldIndex = mLayer->fields().indexFromName( joinFieldName );
205 attributesCache.append( attrs.at( i ) );
222 QVector<int> subsetIndices;
223 for (
int i = 0; i < joinFieldsSubset.count(); ++i )
225 QString joinedFieldName = joinFieldsSubset.at( i );
226 int index = joinLayerFields.
lookupField( joinedFieldName );
229 subsetIndices.append( index );
233 QgsDebugError(
"Join layer subset field not found: " + joinedFieldName );
237 return subsetIndices;
244 QList< QgsVectorLayerJoinInfo>::const_iterator joinIt = mVectorJoins.constBegin();
245 for (
int joinIdx = 0; joinIt != mVectorJoins.constEnd(); ++joinIt, ++joinIdx )
254 QString joinFieldName = joinIt->joinFieldName();
256 QSet<QString> subset;
257 if ( joinIt->hasSubset() )
260 subset = qgis::listToSet( subsetNames );
263 if ( joinIt->prefix().isNull() )
265 prefix = joinLayer->
name() +
'_';
269 prefix = joinIt->prefix();
272 for (
int idx = 0; idx < joinFields.
count(); ++idx )
275 if ( joinIt->hasSubset() && !subset.contains( joinFields.
at( idx ).
name() ) )
280 if ( joinIt->hasSubset() || joinFields.
at( idx ).
name() != joinFieldName )
292 QMutexLocker locker( &mMutex );
293 QList< QgsVectorLayerJoinInfo >::iterator joinIt = mVectorJoins.begin();
294 for ( ; joinIt != mVectorJoins.end(); ++joinIt )
296 if ( joinIt->isUsingMemoryCache() && joinIt->cacheDirty )
297 cacheJoinLayer( *joinIt );
304 QDomElement vectorJoinsElem = document.createElement( u
"vectorjoins"_s );
305 layer_node.appendChild( vectorJoinsElem );
306 QList< QgsVectorLayerJoinInfo >::const_iterator joinIt = mVectorJoins.constBegin();
307 for ( ; joinIt != mVectorJoins.constEnd(); ++joinIt )
312 QDomElement joinElem = document.createElement( u
"join"_s );
314 joinElem.setAttribute( u
"targetFieldName"_s, joinIt->targetFieldName() );
316 joinElem.setAttribute( u
"joinLayerId"_s, joinIt->joinLayerId() );
317 joinElem.setAttribute( u
"joinFieldName"_s, joinIt->joinFieldName() );
319 joinElem.setAttribute( u
"memoryCache"_s, joinIt->isUsingMemoryCache() );
320 joinElem.setAttribute( u
"dynamicForm"_s, joinIt->isDynamicFormEnabled() );
321 joinElem.setAttribute( u
"editable"_s, joinIt->isEditable() );
322 joinElem.setAttribute( u
"upsertOnEdit"_s, joinIt->hasUpsertOnEdit() );
323 joinElem.setAttribute( u
"cascadedDelete"_s, joinIt->hasCascadedDelete() );
325 if ( joinIt->hasSubset() )
327 QDomElement subsetElem = document.createElement( u
"joinFieldsSubset"_s );
330 const auto constSubsetNames = subsetNames;
331 for (
const QString &fieldName : constSubsetNames )
333 QDomElement fieldElem = document.createElement( u
"field"_s );
334 fieldElem.setAttribute( u
"name"_s, fieldName );
335 subsetElem.appendChild( fieldElem );
338 joinElem.appendChild( subsetElem );
341 if ( !joinIt->prefix().isNull() )
343 joinElem.setAttribute( u
"customPrefix"_s, joinIt->prefix() );
344 joinElem.setAttribute( u
"hasCustomPrefix"_s, 1 );
347 vectorJoinsElem.appendChild( joinElem );
353 mVectorJoins.clear();
354 QDomElement vectorJoinsElem = layer_node.firstChildElement( u
"vectorjoins"_s );
355 if ( !vectorJoinsElem.isNull() )
357 QDomNodeList joinList = vectorJoinsElem.elementsByTagName( u
"join"_s );
358 for (
int i = 0; i < joinList.size(); ++i )
360 QDomElement infoElem = joinList.at( i ).toElement();
368 info.
setEditable( infoElem.attribute( u
"editable"_s ).toInt() );
369 info.
setUpsertOnEdit( infoElem.attribute( u
"upsertOnEdit"_s ).toInt() );
372 QDomElement subsetElem = infoElem.firstChildElement( u
"joinFieldsSubset"_s );
373 if ( !subsetElem.isNull() )
375 QStringList *fieldNames =
new QStringList;
376 QDomNodeList fieldNodes = infoElem.elementsByTagName( u
"field"_s );
377 fieldNames->reserve( fieldNodes.count() );
378 for (
int i = 0; i < fieldNodes.count(); ++i )
379 *fieldNames << fieldNodes.at( i ).toElement().attribute( u
"name"_s );
383 if ( infoElem.attribute( u
"hasCustomPrefix"_s ).toInt() )
384 info.
setPrefix( infoElem.attribute( u
"customPrefix"_s ) );
395 bool resolved =
false;
396 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
398 if ( it->joinLayer() )
401 if (
QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( project->
mapLayer( it->joinLayerId() ) ) )
403 it->setJoinLayer( joinedLayer );
404 connectJoinedLayer( joinedLayer );
418 int joinIndex = mVectorJoins.indexOf( *info );
419 if ( joinIndex == -1 )
422 for (
int i = 0; i < fields.
count(); ++i )
439 int sourceJoinIndex = originIndex / 1000;
440 sourceFieldIndex = originIndex % 1000;
442 if ( sourceJoinIndex < 0 || sourceJoinIndex >= mVectorJoins.count() )
445 return &( mVectorJoins[sourceJoinIndex] );
450 QList<const QgsVectorLayerJoinInfo *> infos;
452 const auto constMVectorJoins = mVectorJoins;
455 if ( infos.contains( &info ) )
458 if ( info.targetFieldName() == field.
name() )
459 infos.append( &info );
486 return joinedFeature;
506 return targetedFeature;
512 cloned->mVectorJoins = mVectorJoins;
516void QgsVectorLayerJoinBuffer::joinedLayerUpdatedFields()
521 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
522 Q_ASSERT( joinedLayer );
525 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
527 if ( joinedLayer == it->joinLayer() )
529 it->cachedAttributes.clear();
530 cacheJoinLayer( *it );
537void QgsVectorLayerJoinBuffer::joinedLayerModified()
539 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
540 Q_ASSERT( joinedLayer );
543 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
545 if ( joinedLayer == it->joinLayer() )
547 it->cacheDirty =
true;
552void QgsVectorLayerJoinBuffer::joinedLayerWillBeDeleted()
554 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
555 Q_ASSERT( joinedLayer );
560void QgsVectorLayerJoinBuffer::connectJoinedLayer(
QgsVectorLayer *vl )
578 if ( joinLayer && joinLayer->
isEditable() && info.isEditable() && info.hasUpsertOnEdit() )
582 for (
const QgsFeature &feature : std::as_const( features ) )
584 const QgsFeature joinFeature = info.extractJoinedFeature( feature );
588 const QVariant idFieldValue = feature.
attribute( info.targetFieldName() );
601 if ( existingFeature.
isValid() )
603 if ( info.hasSubset() )
606 const auto constSubsetNames = subsetNames;
607 for (
const QString &field : constSubsetNames )
609 QVariant newValue = joinFeature.
attribute( field );
617 for (
const auto &field : joinFields )
619 QVariant newValue = joinFeature.
attribute( field.name() );
620 int fieldIndex = joinLayer->
fields().
indexOf( field.name() );
628 bool notNullFields =
false;
630 for (
const auto &field : joinFields )
632 if ( field.name() == info.joinFieldName() )
637 notNullFields =
true;
643 joinFeatures << joinFeature;
663 QgsFeature feature = mLayer->getFeature( fid );
686 for (
auto it = newValues.constBegin(); it != newValues.constEnd(); ++it )
688 const int field = it.key();
689 const QVariant newValue = it.value();
692 if ( oldValues.contains( field ) )
693 oldValue = oldValues[field];
711 const auto constFids = fids;
717 if ( info.isEditable() && info.hasCascadedDelete() )
721 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.
Allows managing 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.
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.
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 dataset.
bool isEditable() const final
Returns true if the provider is in editing mode.
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).
QgsAuxiliaryLayer * auxiliaryLayer()
Returns the current auxiliary layer.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const final
Queries the layer for features specified in request.
void updatedFields()
Emitted whenever the fields available from this layer have been changed.
const QList< QgsVectorLayerJoinInfo > vectorJoins() const
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) final
Adds a list of features to the sink.
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.