28#include "moc_qgsvectorlayerjoinbuffer.cpp"
37 QList<QgsVectorLayer *> lst;
47static bool _hasCycleDFS(
QgsVectorLayer *n, QHash<QgsVectorLayer *, int> &mark )
49 if ( mark.value( n ) == 1 )
51 if ( mark.value( n ) == 0 )
54 const auto outEdges { _outEdges( n ) };
57 if ( _hasCycleDFS( m, mark ) )
68 QMutexLocker locker( &mMutex );
69 mVectorJoins.push_back( joinInfo );
73 QHash<QgsVectorLayer *, int> markDFS;
74 if ( mLayer && _hasCycleDFS( mLayer, markDFS ) )
77 mVectorJoins.pop_back();
87 connectJoinedLayer( vl );
93 mLayer->updateFields();
100 cacheJoinLayer( mVectorJoins.last() );
113 QMutexLocker locker( &mMutex );
114 for (
int i = 0; i < mVectorJoins.size(); ++i )
116 if ( mVectorJoins.at( i ).joinLayerId() == joinLayerId )
123 mVectorJoins.removeAt( i );
141 QgsVectorLayer *cacheLayer = joinInfo.
joinLayer();
146 if ( joinFieldIndex < 0 || joinFieldIndex >= cacheLayer->
fields().
count() )
151 QgsFeatureRequest request;
155 QVector<int> subsetIndices;
163 if ( !cacheLayerAttrs.contains( joinFieldIndex ) )
164 cacheLayerAttrs.append( joinFieldIndex );
168 QgsFeatureIterator fit = cacheLayer->
getFeatures( request );
173 QString key = attrs.at( joinFieldIndex ).toString();
176 QgsAttributes subsetAttrs( subsetIndices.count() );
177 for (
int i = 0; i < subsetIndices.count(); ++i )
178 subsetAttrs[i] = attrs.at( subsetIndices.at( i ) );
183 QgsAttributes attributesCache;
184 for (
int i = 0; i < attrs.size(); i++ )
186 if ( i == joinFieldIndex )
189 QString joinInfoPrefix = joinInfo.
prefix();
190 if ( joinInfoPrefix.isNull() )
191 joinInfoPrefix = QString(
"%1_" ).arg( cacheLayer->
name() );
194 const QString joinFieldName = joinInfoPrefix + cacheLayer->
fields().
names().at( i );
197 int fieldIndex = mLayer->fields().indexFromName( joinFieldName );
202 attributesCache.append( attrs.at( i ) );
219 QVector<int> subsetIndices;
220 for (
int i = 0; i < joinFieldsSubset.count(); ++i )
222 QString joinedFieldName = joinFieldsSubset.at( i );
223 int index = joinLayerFields.
lookupField( joinedFieldName );
226 subsetIndices.append( index );
230 QgsDebugError(
"Join layer subset field not found: " + joinedFieldName );
234 return subsetIndices;
241 QList< QgsVectorLayerJoinInfo>::const_iterator joinIt = mVectorJoins.constBegin();
242 for (
int joinIdx = 0; joinIt != mVectorJoins.constEnd(); ++joinIt, ++joinIdx )
251 QString joinFieldName = joinIt->joinFieldName();
253 QSet<QString> subset;
254 if ( joinIt->hasSubset() )
257 subset = qgis::listToSet( subsetNames );
260 if ( joinIt->prefix().isNull() )
262 prefix = joinLayer->
name() +
'_';
266 prefix = joinIt->prefix();
269 for (
int idx = 0; idx < joinFields.
count(); ++idx )
272 if ( joinIt->hasSubset() && !subset.contains( joinFields.
at( idx ).
name() ) )
277 if ( joinIt->hasSubset() || joinFields.
at( idx ).
name() != joinFieldName )
289 QMutexLocker locker( &mMutex );
290 QList< QgsVectorLayerJoinInfo >::iterator joinIt = mVectorJoins.begin();
291 for ( ; joinIt != mVectorJoins.end(); ++joinIt )
293 if ( joinIt->isUsingMemoryCache() && joinIt->cacheDirty )
294 cacheJoinLayer( *joinIt );
301 QDomElement vectorJoinsElem = document.createElement( QStringLiteral(
"vectorjoins" ) );
302 layer_node.appendChild( vectorJoinsElem );
303 QList< QgsVectorLayerJoinInfo >::const_iterator joinIt = mVectorJoins.constBegin();
304 for ( ; joinIt != mVectorJoins.constEnd(); ++joinIt )
309 QDomElement joinElem = document.createElement( QStringLiteral(
"join" ) );
311 joinElem.setAttribute( QStringLiteral(
"targetFieldName" ), joinIt->targetFieldName() );
313 joinElem.setAttribute( QStringLiteral(
"joinLayerId" ), joinIt->joinLayerId() );
314 joinElem.setAttribute( QStringLiteral(
"joinFieldName" ), joinIt->joinFieldName() );
316 joinElem.setAttribute( QStringLiteral(
"memoryCache" ), joinIt->isUsingMemoryCache() );
317 joinElem.setAttribute( QStringLiteral(
"dynamicForm" ), joinIt->isDynamicFormEnabled() );
318 joinElem.setAttribute( QStringLiteral(
"editable" ), joinIt->isEditable() );
319 joinElem.setAttribute( QStringLiteral(
"upsertOnEdit" ), joinIt->hasUpsertOnEdit() );
320 joinElem.setAttribute( QStringLiteral(
"cascadedDelete" ), joinIt->hasCascadedDelete() );
322 if ( joinIt->hasSubset() )
324 QDomElement subsetElem = document.createElement( QStringLiteral(
"joinFieldsSubset" ) );
327 const auto constSubsetNames = subsetNames;
328 for (
const QString &fieldName : constSubsetNames )
330 QDomElement fieldElem = document.createElement( QStringLiteral(
"field" ) );
331 fieldElem.setAttribute( QStringLiteral(
"name" ), fieldName );
332 subsetElem.appendChild( fieldElem );
335 joinElem.appendChild( subsetElem );
338 if ( !joinIt->prefix().isNull() )
340 joinElem.setAttribute( QStringLiteral(
"customPrefix" ), joinIt->prefix() );
341 joinElem.setAttribute( QStringLiteral(
"hasCustomPrefix" ), 1 );
344 vectorJoinsElem.appendChild( joinElem );
350 mVectorJoins.clear();
351 QDomElement vectorJoinsElem = layer_node.firstChildElement( QStringLiteral(
"vectorjoins" ) );
352 if ( !vectorJoinsElem.isNull() )
354 QDomNodeList joinList = vectorJoinsElem.elementsByTagName( QStringLiteral(
"join" ) );
355 for (
int i = 0; i < joinList.size(); ++i )
357 QDomElement infoElem = joinList.at( i ).toElement();
359 info.
setJoinFieldName( infoElem.attribute( QStringLiteral(
"joinFieldName" ) ) );
361 info.
setJoinLayerId( infoElem.attribute( QStringLiteral(
"joinLayerId" ) ) );
365 info.
setEditable( infoElem.attribute( QStringLiteral(
"editable" ) ).toInt() );
366 info.
setUpsertOnEdit( infoElem.attribute( QStringLiteral(
"upsertOnEdit" ) ).toInt() );
367 info.
setCascadedDelete( infoElem.attribute( QStringLiteral(
"cascadedDelete" ) ).toInt() );
369 QDomElement subsetElem = infoElem.firstChildElement( QStringLiteral(
"joinFieldsSubset" ) );
370 if ( !subsetElem.isNull() )
372 QStringList *fieldNames =
new QStringList;
373 QDomNodeList fieldNodes = infoElem.elementsByTagName( QStringLiteral(
"field" ) );
374 fieldNames->reserve( fieldNodes.count() );
375 for (
int i = 0; i < fieldNodes.count(); ++i )
376 *fieldNames << fieldNodes.at( i ).toElement().attribute( QStringLiteral(
"name" ) );
380 if ( infoElem.attribute( QStringLiteral(
"hasCustomPrefix" ) ).toInt() )
381 info.
setPrefix( infoElem.attribute( QStringLiteral(
"customPrefix" ) ) );
392 bool resolved =
false;
393 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
395 if ( it->joinLayer() )
398 if (
QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( project->
mapLayer( it->joinLayerId() ) ) )
400 it->setJoinLayer( joinedLayer );
401 connectJoinedLayer( joinedLayer );
415 int joinIndex = mVectorJoins.indexOf( *info );
416 if ( joinIndex == -1 )
419 for (
int i = 0; i < fields.
count(); ++i )
436 int sourceJoinIndex = originIndex / 1000;
437 sourceFieldIndex = originIndex % 1000;
439 if ( sourceJoinIndex < 0 || sourceJoinIndex >= mVectorJoins.count() )
442 return &( mVectorJoins[sourceJoinIndex] );
447 QList<const QgsVectorLayerJoinInfo *> infos;
449 const auto constMVectorJoins = mVectorJoins;
452 if ( infos.contains( &info ) )
455 if ( info.targetFieldName() == field.
name() )
456 infos.append( &info );
483 return joinedFeature;
503 return targetedFeature;
509 cloned->mVectorJoins = mVectorJoins;
513void QgsVectorLayerJoinBuffer::joinedLayerUpdatedFields()
518 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
519 Q_ASSERT( joinedLayer );
522 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
524 if ( joinedLayer == it->joinLayer() )
526 it->cachedAttributes.clear();
527 cacheJoinLayer( *it );
534void QgsVectorLayerJoinBuffer::joinedLayerModified()
536 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
537 Q_ASSERT( joinedLayer );
540 for ( QgsVectorJoinList::iterator it = mVectorJoins.begin(); it != mVectorJoins.end(); ++it )
542 if ( joinedLayer == it->joinLayer() )
544 it->cacheDirty =
true;
549void QgsVectorLayerJoinBuffer::joinedLayerWillBeDeleted()
551 QgsVectorLayer *joinedLayer = qobject_cast<QgsVectorLayer *>( sender() );
552 Q_ASSERT( joinedLayer );
557void QgsVectorLayerJoinBuffer::connectJoinedLayer(
QgsVectorLayer *vl )
575 if ( joinLayer && joinLayer->
isEditable() && info.isEditable() && info.hasUpsertOnEdit() )
579 for (
const QgsFeature &feature : std::as_const( features ) )
581 const QgsFeature joinFeature = info.extractJoinedFeature( feature );
585 const QVariant idFieldValue = feature.
attribute( info.targetFieldName() );
598 if ( existingFeature.
isValid() )
600 if ( info.hasSubset() )
603 const auto constSubsetNames = subsetNames;
604 for (
const QString &field : constSubsetNames )
606 QVariant newValue = joinFeature.
attribute( field );
614 for (
const auto &field : joinFields )
616 QVariant newValue = joinFeature.
attribute( field.name() );
617 int fieldIndex = joinLayer->
fields().
indexOf( field.name() );
625 bool notNullFields =
false;
627 for (
const auto &field : joinFields )
629 if ( field.name() == info.joinFieldName() )
634 notNullFields =
true;
640 joinFeatures << joinFeature;
660 QgsFeature feature = mLayer->getFeature( fid );
683 for (
auto it = newValues.constBegin(); it != newValues.constEnd(); ++it )
685 const int field = it.key();
686 const QVariant newValue = it.value();
689 if ( oldValues.contains( field ) )
690 oldValue = oldValues[field];
708 const auto constFids = fids;
714 if ( info.isEditable() && info.hasCascadedDelete() )
718 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.