QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsvectorlayerutils.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorlayerutils.cpp
3 -----------------------
4 Date : October 2016
5 Copyright : (C) 2016 by Nyall Dawson
6 Email : nyall dot dawson 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
16#include <QRegularExpression>
17
19#include "qgsfeatureiterator.h"
20#include "qgsfeaturerequest.h"
21#include "qgsvectorlayerutils.h"
23#include "qgsproject.h"
24#include "qgsrelationmanager.h"
25#include "qgsfeedback.h"
26#include "qgsvectorlayer.h"
27#include "qgsthreadingutils.h"
31#include "qgspallabeling.h"
32#include "qgsrenderer.h"
33#include "qgssymbollayer.h"
35#include "qgsstyle.h"
36#include "qgsauxiliarystorage.h"
38#include "qgspainteffect.h"
39
40QgsFeatureIterator QgsVectorLayerUtils::getValuesIterator( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly )
41{
42 std::unique_ptr<QgsExpression> expression;
44
45 int attrNum = layer->fields().lookupField( fieldOrExpression );
46 if ( attrNum == -1 )
47 {
48 // try to use expression
49 expression.reset( new QgsExpression( fieldOrExpression ) );
51
52 if ( expression->hasParserError() || !expression->prepare( &context ) )
53 {
54 ok = false;
55 return QgsFeatureIterator();
56 }
57 }
58
59 QSet<QString> lst;
60 if ( !expression )
61 lst.insert( fieldOrExpression );
62 else
63 lst = expression->referencedColumns();
64
66 .setFlags( ( expression && expression->needsGeometry() ) ?
69 .setSubsetOfAttributes( lst, layer->fields() );
70
71 ok = true;
72 if ( !selectedOnly )
73 {
74 return layer->getFeatures( request );
75 }
76 else
77 {
78 return layer->getSelectedFeatures( request );
79 }
80}
81
82QList<QVariant> QgsVectorLayerUtils::getValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly, QgsFeedback *feedback )
83{
84 QList<QVariant> values;
85 QgsFeatureIterator fit = getValuesIterator( layer, fieldOrExpression, ok, selectedOnly );
86 if ( ok )
87 {
88 std::unique_ptr<QgsExpression> expression;
90
91 int attrNum = layer->fields().lookupField( fieldOrExpression );
92 if ( attrNum == -1 )
93 {
94 // use expression, already validated in the getValuesIterator() function
95 expression.reset( new QgsExpression( fieldOrExpression ) );
97 }
98
99 QgsFeature f;
100 while ( fit.nextFeature( f ) )
101 {
102 if ( expression )
103 {
104 context.setFeature( f );
105 QVariant v = expression->evaluate( &context );
106 values << v;
107 }
108 else
109 {
110 values << f.attribute( attrNum );
111 }
112 if ( feedback && feedback->isCanceled() )
113 {
114 ok = false;
115 return values;
116 }
117 }
118 }
119 return values;
120}
121
122QList<double> QgsVectorLayerUtils::getDoubleValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly, int *nullCount, QgsFeedback *feedback )
123{
124 QList<double> values;
125
126 if ( nullCount )
127 *nullCount = 0;
128
129 QList<QVariant> variantValues = getValues( layer, fieldOrExpression, ok, selectedOnly, feedback );
130 if ( !ok )
131 return values;
132
133 bool convertOk;
134 const auto constVariantValues = variantValues;
135 for ( const QVariant &value : constVariantValues )
136 {
137 double val = value.toDouble( &convertOk );
138 if ( convertOk )
139 values << val;
140 else if ( QgsVariantUtils::isNull( value ) )
141 {
142 if ( nullCount )
143 *nullCount += 1;
144 }
145 if ( feedback && feedback->isCanceled() )
146 {
147 ok = false;
148 return values;
149 }
150 }
151 return values;
152}
153
154bool QgsVectorLayerUtils::valueExists( const QgsVectorLayer *layer, int fieldIndex, const QVariant &value, const QgsFeatureIds &ignoreIds )
155{
156 if ( !layer )
157 return false;
158
159 QgsFields fields = layer->fields();
160
161 if ( fieldIndex < 0 || fieldIndex >= fields.count() )
162 return false;
163
164 // If it's a joined field search the value in the source layer
165 if ( fields.fieldOrigin( fieldIndex ) == QgsFields::FieldOrigin::OriginJoin )
166 {
167 int srcFieldIndex;
168 const QgsVectorLayerJoinInfo *joinInfo { layer->joinBuffer()->joinForFieldIndex( fieldIndex, fields, srcFieldIndex ) };
169 if ( ! joinInfo )
170 {
171 return false;
172 }
173 fieldIndex = srcFieldIndex;
174 layer = joinInfo->joinLayer();
175 if ( ! layer )
176 {
177 return false;
178 }
179 fields = layer->fields();
180 }
181
182 QString fieldName = fields.at( fieldIndex ).name();
183
184 // build up an optimised feature request
185 QgsFeatureRequest request;
186 request.setNoAttributes();
188
189 // at most we need to check ignoreIds.size() + 1 - the feature not in ignoreIds is the one we're interested in
190 int limit = ignoreIds.size() + 1;
191 request.setLimit( limit );
192
193 request.setFilterExpression( QStringLiteral( "%1=%2" ).arg( QgsExpression::quotedColumnRef( fieldName ),
194 QgsExpression::quotedValue( value ) ) );
195
196 QgsFeature feat;
197 QgsFeatureIterator it = layer->getFeatures( request );
198 while ( it.nextFeature( feat ) )
199 {
200 if ( ignoreIds.contains( feat.id() ) )
201 continue;
202
203 return true;
204 }
205
206 return false;
207}
208
209QVariant QgsVectorLayerUtils::createUniqueValue( const QgsVectorLayer *layer, int fieldIndex, const QVariant &seed )
210{
211 if ( !layer )
212 return QVariant();
213
214 QgsFields fields = layer->fields();
215
216 if ( fieldIndex < 0 || fieldIndex >= fields.count() )
217 return QVariant();
218
219 QgsField field = fields.at( fieldIndex );
220
221 if ( field.isNumeric() )
222 {
223 QVariant maxVal = layer->maximumValue( fieldIndex );
224 QVariant newVar( maxVal.toLongLong() + 1 );
225 if ( field.convertCompatible( newVar ) )
226 return newVar;
227 else
228 return QVariant();
229 }
230 else
231 {
232 switch ( field.type() )
233 {
234 case QVariant::String:
235 {
236 QString base;
237 if ( seed.isValid() )
238 base = seed.toString();
239
240 if ( !base.isEmpty() )
241 {
242 // strip any existing _1, _2 from the seed
243 const thread_local QRegularExpression rx( QStringLiteral( "(.*)_\\d+" ) );
244 QRegularExpressionMatch match = rx.match( base );
245 if ( match.hasMatch() )
246 {
247 base = match.captured( 1 );
248 }
249 }
250 else
251 {
252 // no base seed - fetch first value from layer
254 req.setLimit( 1 );
255 req.setSubsetOfAttributes( QgsAttributeList() << fieldIndex );
257 QgsFeature f;
258 layer->getFeatures( req ).nextFeature( f );
259 base = f.attribute( fieldIndex ).toString();
260 }
261
262 // try variants like base_1, base_2, etc until a new value found
263 QStringList vals = layer->uniqueStringsMatching( fieldIndex, base );
264
265 // might already be unique
266 if ( !base.isEmpty() && !vals.contains( base ) )
267 return base;
268
269 for ( int i = 1; i < 10000; ++i )
270 {
271 QString testVal = base + '_' + QString::number( i );
272 if ( !vals.contains( testVal ) )
273 return testVal;
274 }
275
276 // failed
277 return QVariant();
278 }
279
280 default:
281 // todo other types - dates? times?
282 break;
283 }
284 }
285
286 return QVariant();
287}
288
289QVariant QgsVectorLayerUtils::createUniqueValueFromCache( const QgsVectorLayer *layer, int fieldIndex, const QSet<QVariant> &existingValues, const QVariant &seed )
290{
291 if ( !layer )
292 return QVariant();
293
294 QgsFields fields = layer->fields();
295
296 if ( fieldIndex < 0 || fieldIndex >= fields.count() )
297 return QVariant();
298
299 QgsField field = fields.at( fieldIndex );
300
301 if ( field.isNumeric() )
302 {
303 QVariant maxVal = existingValues.isEmpty() ? 0 : *std::max_element( existingValues.begin(), existingValues.end(), []( const QVariant & a, const QVariant & b ) { return a.toLongLong() < b.toLongLong(); } );
304 QVariant newVar( maxVal.toLongLong() + 1 );
305 if ( field.convertCompatible( newVar ) )
306 return newVar;
307 else
308 return QVariant();
309 }
310 else
311 {
312 switch ( field.type() )
313 {
314 case QVariant::String:
315 {
316 QString base;
317 if ( seed.isValid() )
318 base = seed.toString();
319
320 if ( !base.isEmpty() )
321 {
322 // strip any existing _1, _2 from the seed
323 const thread_local QRegularExpression rx( QStringLiteral( "(.*)_\\d+" ) );
324 QRegularExpressionMatch match = rx.match( base );
325 if ( match.hasMatch() )
326 {
327 base = match.captured( 1 );
328 }
329 }
330 else
331 {
332 // no base seed - fetch first value from layer
334 base = existingValues.isEmpty() ? QString() : existingValues.constBegin()->toString();
335 }
336
337 // try variants like base_1, base_2, etc until a new value found
338 QStringList vals;
339 for ( const auto &v : std::as_const( existingValues ) )
340 {
341 if ( v.toString().startsWith( base ) )
342 vals.push_back( v.toString() );
343 }
344
345 // might already be unique
346 if ( !base.isEmpty() && !vals.contains( base ) )
347 return base;
348
349 for ( int i = 1; i < 10000; ++i )
350 {
351 QString testVal = base + '_' + QString::number( i );
352 if ( !vals.contains( testVal ) )
353 return testVal;
354 }
355
356 // failed
357 return QVariant();
358 }
359
360 default:
361 // todo other types - dates? times?
362 break;
363 }
364 }
365
366 return QVariant();
367
368}
369
370bool QgsVectorLayerUtils::attributeHasConstraints( const QgsVectorLayer *layer, int attributeIndex )
371{
372 if ( !layer )
373 return false;
374
375 if ( attributeIndex < 0 || attributeIndex >= layer->fields().count() )
376 return false;
377
378 const QgsFieldConstraints constraints = layer->fields().at( attributeIndex ).constraints();
379 return ( constraints.constraints() & QgsFieldConstraints::ConstraintNotNull ||
382}
383
384bool QgsVectorLayerUtils::validateAttribute( const QgsVectorLayer *layer, const QgsFeature &feature, int attributeIndex, QStringList &errors,
386{
387 if ( !layer )
388 return false;
389
390 if ( attributeIndex < 0 || attributeIndex >= layer->fields().count() )
391 return false;
392
393 QgsFields fields = layer->fields();
394 QgsField field = fields.at( attributeIndex );
395 const QVariant value = feature.attribute( attributeIndex );
396 bool valid = true;
397 errors.clear();
398
399 QgsFieldConstraints constraints = field.constraints();
400
401 if ( constraints.constraints() & QgsFieldConstraints::ConstraintExpression && !constraints.constraintExpression().isEmpty()
404 {
406 context.setFeature( feature );
407
408 QgsExpression expr( constraints.constraintExpression() );
409
410 valid = expr.evaluate( &context ).toBool();
411
412 if ( expr.hasParserError() )
413 {
414 errors << QObject::tr( "parser error: %1" ).arg( expr.parserErrorString() );
415 }
416 else if ( expr.hasEvalError() )
417 {
418 errors << QObject::tr( "evaluation error: %1" ).arg( expr.evalErrorString() );
419 }
420 else if ( !valid )
421 {
422 errors << QObject::tr( "%1 check failed" ).arg( constraints.constraintDescription() );
423 }
424 }
425
426 bool notNullConstraintViolated { false };
427
431 {
432 bool exempt = false;
433 if ( fields.fieldOrigin( attributeIndex ) == QgsFields::OriginProvider
435 {
436 int providerIdx = fields.fieldOriginIndex( attributeIndex );
437 exempt = layer->dataProvider()->skipConstraintCheck( providerIdx, QgsFieldConstraints::ConstraintNotNull, value );
438 }
439
440 if ( !exempt )
441 {
442 valid = valid && !QgsVariantUtils::isNull( value );
443
444 if ( QgsVariantUtils::isNull( value ) )
445 {
446 errors << QObject::tr( "value is NULL" );
447 notNullConstraintViolated = true;
448 }
449 }
450 }
451
452 // if a NOT NULL constraint is violated we don't need to check for UNIQUE
453 if ( ! notNullConstraintViolated )
454 {
455
459 {
460 bool exempt = false;
461 if ( fields.fieldOrigin( attributeIndex ) == QgsFields::OriginProvider
463 {
464 int providerIdx = fields.fieldOriginIndex( attributeIndex );
465 exempt = layer->dataProvider()->skipConstraintCheck( providerIdx, QgsFieldConstraints::ConstraintUnique, value );
466 }
467
468 if ( !exempt )
469 {
470
471 bool alreadyExists = QgsVectorLayerUtils::valueExists( layer, attributeIndex, value, QgsFeatureIds() << feature.id() );
472 valid = valid && !alreadyExists;
473
474 if ( alreadyExists )
475 {
476 errors << QObject::tr( "value is not unique" );
477 }
478 }
479 }
480 }
481
482 return valid;
483}
484
486 const QgsAttributeMap &attributes, QgsExpressionContext *context )
487{
488 QgsFeatureList features { createFeatures( layer, QgsFeaturesDataList() << QgsFeatureData( geometry, attributes ), context ) };
489 return features.isEmpty() ? QgsFeature() : features.first();
490}
491
493{
494 if ( !layer )
495 return QgsFeatureList();
496
497 QgsFeatureList result;
498 result.reserve( featuresData.length() );
499
500 QgsExpressionContext *evalContext = context;
501 std::unique_ptr< QgsExpressionContext > tempContext;
502 if ( !evalContext )
503 {
504 // no context passed, so we create a default one
506 evalContext = tempContext.get();
507 }
508
509 QgsFields fields = layer->fields();
510
511 // Cache unique values
512 QMap<int, QSet<QVariant>> uniqueValueCache;
513
514 auto checkUniqueValue = [ & ]( const int fieldIdx, const QVariant & value )
515 {
516 if ( ! uniqueValueCache.contains( fieldIdx ) )
517 {
518 // If the layer is filtered, get unique values from an unfiltered clone
519 if ( ! layer->subsetString().isEmpty() )
520 {
521 std::unique_ptr<QgsVectorLayer> unfilteredClone { layer->clone( ) };
522 unfilteredClone->setSubsetString( QString( ) );
523 uniqueValueCache[ fieldIdx ] = unfilteredClone->uniqueValues( fieldIdx );
524 }
525 else
526 {
527 uniqueValueCache[ fieldIdx ] = layer->uniqueValues( fieldIdx );
528 }
529 }
530 return uniqueValueCache[ fieldIdx ].contains( value );
531 };
532
533 for ( const auto &fd : std::as_const( featuresData ) )
534 {
535
536 QgsFeature newFeature( fields );
537 newFeature.setValid( true );
538 newFeature.setGeometry( fd.geometry() );
539
540 // initialize attributes
541 newFeature.initAttributes( fields.count() );
542 for ( int idx = 0; idx < fields.count(); ++idx )
543 {
544 QVariant v;
545 bool checkUnique = true;
546 const bool hasUniqueConstraint { static_cast<bool>( fields.at( idx ).constraints().constraints() & QgsFieldConstraints::ConstraintUnique ) };
547
548 // in order of priority:
549 // 1. passed attribute value and if field does not have a unique constraint like primary key
550 if ( fd.attributes().contains( idx ) )
551 {
552 v = fd.attributes().value( idx );
553 }
554
555 // 2. client side default expression
556 // note - deliberately not using else if!
557 QgsDefaultValue defaultValueDefinition = layer->defaultValueDefinition( idx );
558 if ( ( QgsVariantUtils::isNull( v ) || ( hasUniqueConstraint
559 && checkUniqueValue( idx, v ) )
560 || defaultValueDefinition.applyOnUpdate() )
561 && defaultValueDefinition.isValid() )
562 {
563 // client side default expression set - takes precedence over all. Why? Well, this is the only default
564 // which QGIS users have control over, so we assume that they're deliberately overriding any
565 // provider defaults for some good reason and we should respect that
566 v = layer->defaultValue( idx, newFeature, evalContext );
567 }
568
569 // 3. provider side default value clause
570 // note - not an else if deliberately. Users may return null from a default value expression to fallback to provider defaults
571 if ( ( QgsVariantUtils::isNull( v ) || ( hasUniqueConstraint
572 && checkUniqueValue( idx, v ) ) )
573 && fields.fieldOrigin( idx ) == QgsFields::OriginProvider )
574 {
575 int providerIndex = fields.fieldOriginIndex( idx );
576 QString providerDefault = layer->dataProvider()->defaultValueClause( providerIndex );
577 if ( !providerDefault.isEmpty() )
578 {
579 v = providerDefault;
580 checkUnique = false;
581 }
582 }
583
584 // 4. provider side default literal
585 // note - deliberately not using else if!
586 if ( ( QgsVariantUtils::isNull( v ) || ( checkUnique
587 && hasUniqueConstraint
588 && checkUniqueValue( idx, v ) ) )
589 && fields.fieldOrigin( idx ) == QgsFields::OriginProvider )
590 {
591 int providerIndex = fields.fieldOriginIndex( idx );
592 v = layer->dataProvider()->defaultValue( providerIndex );
593 if ( v.isValid() )
594 {
595 //trust that the provider default has been sensibly set not to violate any constraints
596 checkUnique = false;
597 }
598 }
599
600 // 5. passed attribute value
601 // note - deliberately not using else if!
602 if ( QgsVariantUtils::isNull( v ) && fd.attributes().contains( idx ) )
603 {
604 v = fd.attributes().value( idx );
605 }
606
607 // last of all... check that unique constraints are respected if the value is valid
608 if ( v.isValid() )
609 {
610 // we can't handle not null or expression constraints here, since there's no way to pick a sensible
611 // value if the constraint is violated
612 if ( checkUnique && hasUniqueConstraint )
613 {
614 if ( checkUniqueValue( idx, v ) )
615 {
616 // unique constraint violated
617 QVariant uniqueValue = QgsVectorLayerUtils::createUniqueValueFromCache( layer, idx, uniqueValueCache[ idx ], v );
618 if ( uniqueValue.isValid() )
619 v = uniqueValue;
620 }
621 }
622 if ( hasUniqueConstraint )
623 {
624 uniqueValueCache[ idx ].insert( v );
625 }
626 }
627 newFeature.setAttribute( idx, v );
628 }
629 result.append( newFeature );
630 }
631 return result;
632}
633
634QgsFeature QgsVectorLayerUtils::duplicateFeature( QgsVectorLayer *layer, const QgsFeature &feature, QgsProject *project, QgsDuplicateFeatureContext &duplicateFeatureContext, const int maxDepth, int depth, QList<QgsVectorLayer *> referencedLayersBranch )
635{
636 if ( !layer )
637 return QgsFeature();
638
639 if ( !layer->isEditable() )
640 return QgsFeature();
641
642 //get context from layer
644 context.setFeature( feature );
645
646 QgsFeature newFeature = createFeature( layer, feature.geometry(), feature.attributes().toMap(), &context );
647 layer->addFeature( newFeature );
648
649 const QList<QgsRelation> relations = project->relationManager()->referencedRelations( layer );
650 referencedLayersBranch << layer;
651
652 const int effectiveMaxDepth = maxDepth > 0 ? maxDepth : 100;
653
654 for ( const QgsRelation &relation : relations )
655 {
656 //check if composition (and not association)
657 if ( relation.strength() == Qgis::RelationshipStrength::Composition && !referencedLayersBranch.contains( relation.referencingLayer() ) && depth < effectiveMaxDepth )
658 {
659 //get features connected over this relation
660 QgsFeatureIterator relatedFeaturesIt = relation.getRelatedFeatures( feature );
661 QgsFeatureIds childFeatureIds;
662 QgsFeature childFeature;
663 while ( relatedFeaturesIt.nextFeature( childFeature ) )
664 {
665 //set childlayer editable
666 relation.referencingLayer()->startEditing();
667 //change the fk of the child to the id of the new parent
668 const auto pairs = relation.fieldPairs();
669 for ( const QgsRelation::FieldPair &fieldPair : pairs )
670 {
671 childFeature.setAttribute( fieldPair.first, newFeature.attribute( fieldPair.second ) );
672 }
673 //call the function for the child
674 childFeatureIds.insert( duplicateFeature( relation.referencingLayer(), childFeature, project, duplicateFeatureContext, maxDepth, depth + 1, referencedLayersBranch ).id() );
675 }
676
677 //store for feedback
678 duplicateFeatureContext.setDuplicatedFeatures( relation.referencingLayer(), childFeatureIds );
679 }
680 }
681
682
683 return newFeature;
684}
685
686std::unique_ptr<QgsVectorLayerFeatureSource> QgsVectorLayerUtils::getFeatureSource( QPointer<QgsVectorLayer> layer, QgsFeedback *feedback )
687{
688 std::unique_ptr<QgsVectorLayerFeatureSource> featureSource;
689
690 auto getFeatureSource = [ layer, &featureSource, feedback ]
691 {
692 Q_ASSERT( QThread::currentThread() == qApp->thread() || feedback );
693 QgsVectorLayer *lyr = layer.data();
694
695 if ( lyr )
696 {
697 featureSource.reset( new QgsVectorLayerFeatureSource( lyr ) );
698 }
699 };
700
702
703 return featureSource;
704}
705
707{
708 if ( !feature.fields().isEmpty() )
709 {
710 QgsAttributes attributes;
711 attributes.reserve( fields.size() );
712 // feature has a field mapping, so we can match attributes to field names
713 for ( const QgsField &field : fields )
714 {
715 int index = feature.fields().lookupField( field.name() );
716 attributes.append( index >= 0 ? feature.attribute( index ) : QVariant( field.type() ) );
717 }
718 feature.setAttributes( attributes );
719 }
720 else
721 {
722 // no field name mapping in feature, just use order
723 const int lengthDiff = feature.attributes().count() - fields.count();
724 if ( lengthDiff > 0 )
725 {
726 // truncate extra attributes
727 QgsAttributes attributes = feature.attributes().mid( 0, fields.count() );
728 feature.setAttributes( attributes );
729 }
730 else if ( lengthDiff < 0 )
731 {
732 // add missing null attributes
733 QgsAttributes attributes = feature.attributes();
734 attributes.reserve( fields.count() );
735 for ( int i = feature.attributes().count(); i < fields.count(); ++i )
736 {
737 attributes.append( QVariant( fields.at( i ).type() ) );
738 }
739 feature.setAttributes( attributes );
740 }
741 }
742 feature.setFields( fields );
743}
744
746{
747 Qgis::WkbType inputWkbType( layer->wkbType( ) );
748 QgsFeatureList resultFeatures;
749 QgsFeature newF( feature );
750 // Fix attributes
752
753 if ( sinkFlags & QgsFeatureSink::RegeneratePrimaryKey )
754 {
755 // drop incoming primary key values, let them be regenerated
756 const QgsAttributeList pkIndexes = layer->dataProvider()->pkAttributeIndexes();
757 for ( int index : pkIndexes )
758 {
759 if ( index >= 0 )
760 newF.setAttribute( index, QVariant() );
761 }
762 }
763
764 // Does geometry need transformations?
766 bool newFHasGeom = newFGeomType !=
768 newFGeomType != Qgis::GeometryType::Null;
769 bool layerHasGeom = inputWkbType !=
771 inputWkbType != Qgis::WkbType::Unknown;
772 // Drop geometry if layer is geometry-less
773 if ( ( newFHasGeom && !layerHasGeom ) || !newFHasGeom )
774 {
775 QgsFeature _f = QgsFeature( layer->fields() );
776 _f.setAttributes( newF.attributes() );
777 resultFeatures.append( _f );
778 }
779 else
780 {
781 // Geometry need fixing?
782 const QVector< QgsGeometry > geometries = newF.geometry().coerceToType( inputWkbType );
783
784 if ( geometries.count() != 1 )
785 {
786 QgsAttributeMap attrMap;
787 for ( int j = 0; j < newF.fields().count(); j++ )
788 {
789 attrMap[j] = newF.attribute( j );
790 }
791 resultFeatures.reserve( geometries.size() );
792 for ( const QgsGeometry &geometry : geometries )
793 {
794 QgsFeature _f( createFeature( layer, geometry, attrMap ) );
795 resultFeatures.append( _f );
796 }
797 }
798 else
799 {
800 newF.setGeometry( geometries.at( 0 ) );
801 resultFeatures.append( newF );
802 }
803 }
804 return resultFeatures;
805}
806
808{
809 QgsFeatureList resultFeatures;
810 for ( const QgsFeature &f : features )
811 {
812 const QgsFeatureList features( makeFeatureCompatible( f, layer, sinkFlags ) );
813 for ( const auto &_f : features )
814 {
815 resultFeatures.append( _f );
816 }
817 }
818 return resultFeatures;
819}
820
822{
823 QList<QgsVectorLayer *> layers;
824 QMap<QgsVectorLayer *, QgsFeatureIds>::const_iterator i;
825 for ( i = mDuplicatedFeatures.begin(); i != mDuplicatedFeatures.end(); ++i )
826 layers.append( i.key() );
827 return layers;
828}
829
831{
832 return mDuplicatedFeatures[layer];
833}
834
835void QgsVectorLayerUtils::QgsDuplicateFeatureContext::setDuplicatedFeatures( QgsVectorLayer *layer, const QgsFeatureIds &ids )
836{
837 if ( mDuplicatedFeatures.contains( layer ) )
838 mDuplicatedFeatures[layer] += ids;
839 else
840 mDuplicatedFeatures.insert( layer, ids );
841}
842/*
843QMap<QgsVectorLayer *, QgsFeatureIds> QgsVectorLayerUtils::QgsDuplicateFeatureContext::duplicateFeatureContext() const
844{
845 return mDuplicatedFeatures;
846}
847*/
848
850 mGeometry( geometry ),
851 mAttributes( attributes )
852{}
853
855{
856 return mGeometry;
857}
858
860{
861 return mAttributes;
862}
863
864bool _fieldIsEditable( const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature )
865{
866 return layer->isEditable() &&
867 !layer->editFormConfig().readOnly( fieldIndex ) &&
868 // Provider permissions
869 layer->dataProvider() &&
871 ( layer->dataProvider()->capabilities() & QgsVectorDataProvider::AddFeatures && ( FID_IS_NULL( feature.id() ) || FID_IS_NEW( feature.id() ) ) ) ) &&
872 // Field must not be read only
873 !layer->fields().at( fieldIndex ).isReadOnly();
874}
875
876bool QgsVectorLayerUtils::fieldIsReadOnly( const QgsVectorLayer *layer, int fieldIndex )
877{
878 if ( layer->fields().fieldOrigin( fieldIndex ) == QgsFields::OriginJoin )
879 {
880 int srcFieldIndex;
881 const QgsVectorLayerJoinInfo *info = layer->joinBuffer()->joinForFieldIndex( fieldIndex, layer->fields(), srcFieldIndex );
882
883 if ( !info || !info->isEditable() || !info->joinLayer() )
884 return true;
885
886 return fieldIsReadOnly( info->joinLayer(), srcFieldIndex );
887 }
888 else
889 {
890 // any of these properties makes the field read only
891 if ( !layer->isEditable() ||
892 layer->editFormConfig().readOnly( fieldIndex ) ||
893 !layer->dataProvider() ||
896 layer->fields().at( fieldIndex ).isReadOnly() )
897 return true;
898
899 return false;
900 }
901}
902
904{
905 // editability will vary feature-by-feature only for joined fields
906 if ( layer->fields().fieldOrigin( fieldIndex ) == QgsFields::OriginJoin )
907 {
908 int srcFieldIndex;
909 const QgsVectorLayerJoinInfo *info = layer->joinBuffer()->joinForFieldIndex( fieldIndex, layer->fields(), srcFieldIndex );
910
911 if ( !info || !info->isEditable() || info->hasUpsertOnEdit() )
912 return false;
913
914 // join does not have upsert capabilities, so the ability to edit the joined field will
915 // vary feature-by-feature, depending on whether the join target feature already exists
916 return true;
917 }
918 else
919 {
920 return false;
921 }
922}
923
924bool QgsVectorLayerUtils::fieldIsEditable( const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature )
925{
926 if ( layer->fields().fieldOrigin( fieldIndex ) == QgsFields::OriginJoin )
927 {
928 int srcFieldIndex;
929 const QgsVectorLayerJoinInfo *info = layer->joinBuffer()->joinForFieldIndex( fieldIndex, layer->fields(), srcFieldIndex );
930
931 if ( !info || !info->isEditable() )
932 return false;
933
934 // check that joined feature exist, else it is not editable
935 if ( !info->hasUpsertOnEdit() )
936 {
937 const QgsFeature joinedFeature = layer->joinBuffer()->joinedFeatureOf( info, feature );
938 if ( !joinedFeature.isValid() )
939 return false;
940 }
941
942 return _fieldIsEditable( info->joinLayer(), srcFieldIndex, feature );
943 }
944 else
945 return _fieldIsEditable( layer, fieldIndex, feature );
946}
947
948
949QHash<QString, QgsMaskedLayers> QgsVectorLayerUtils::labelMasks( const QgsVectorLayer *layer )
950{
951 class LabelMasksVisitor : public QgsStyleEntityVisitorInterface
952 {
953 public:
954 bool visitEnter( const QgsStyleEntityVisitorInterface::Node &node ) override
955 {
957 {
958 currentRule = node.identifier;
959 return true;
960 }
961 return false;
962 }
963 bool visit( const QgsStyleEntityVisitorInterface::StyleLeaf &leaf ) override
964 {
965 if ( leaf.entity && leaf.entity->type() == QgsStyle::LabelSettingsEntity )
966 {
967 auto labelSettingsEntity = static_cast<const QgsStyleLabelSettingsEntity *>( leaf.entity );
968 const QgsTextMaskSettings &maskSettings = labelSettingsEntity->settings().format().mask();
969 if ( maskSettings.enabled() )
970 {
971 // transparency is considered has effects because it implies rasterization when masking
972 // is involved
973 const bool hasEffects = maskSettings.opacity() < 1 ||
974 ( maskSettings.paintEffect() && maskSettings.paintEffect()->enabled() );
975 for ( const auto &r : maskSettings.maskedSymbolLayers() )
976 {
977 QgsMaskedLayer &maskedLayer = maskedLayers[currentRule][r.layerId()];
978 maskedLayer.symbolLayerIds.insert( r.symbolLayerIdV2() );
979 maskedLayer.hasEffects = hasEffects;
980 }
981 }
982 }
983 return true;
984 }
985
986 QHash<QString, QgsMaskedLayers> maskedLayers;
987 // Current label rule, empty string for a simple labeling
988 QString currentRule;
989 };
990
991 if ( ! layer->labeling() )
992 return {};
993
994 LabelMasksVisitor visitor;
995 layer->labeling()->accept( &visitor );
996 return std::move( visitor.maskedLayers );
997}
998
1000{
1001 if ( ! layer->renderer() )
1002 return {};
1003
1004 class SymbolLayerVisitor : public QgsStyleEntityVisitorInterface
1005 {
1006 public:
1007 bool visitEnter( const QgsStyleEntityVisitorInterface::Node &node ) override
1008 {
1010 }
1011
1012 // Returns true if the visited symbol has effects
1013 bool visitSymbol( const QgsSymbol *symbol )
1014 {
1015 // transparency is considered has effects because it implies rasterization when masking
1016 // is involved
1017 bool symbolHasEffect = symbol->opacity() < 1;
1018 for ( int idx = 0; idx < symbol->symbolLayerCount(); idx++ )
1019 {
1020 const QgsSymbolLayer *sl = symbol->symbolLayer( idx );
1021 bool slHasEffects = sl->paintEffect() && sl->paintEffect()->enabled();
1022 symbolHasEffect |= slHasEffects;
1023
1024 // recurse over sub symbols
1025 const QgsSymbol *subSymbol = const_cast<QgsSymbolLayer *>( sl )->subSymbol();
1026 if ( subSymbol )
1027 slHasEffects |= visitSymbol( subSymbol );
1028
1029 for ( const auto &mask : sl->masks() )
1030 {
1031 QgsMaskedLayer &maskedLayer = maskedLayers[mask.layerId()];
1032 maskedLayer.hasEffects |= slHasEffects;
1033 maskedLayer.symbolLayerIds.insert( mask.symbolLayerIdV2() );
1034 }
1035 }
1036
1037 return symbolHasEffect;
1038 }
1039
1040 bool visit( const QgsStyleEntityVisitorInterface::StyleLeaf &leaf ) override
1041 {
1042 if ( leaf.entity && leaf.entity->type() == QgsStyle::SymbolEntity )
1043 {
1044 auto symbolEntity = static_cast<const QgsStyleSymbolEntity *>( leaf.entity );
1045 if ( symbolEntity->symbol() )
1046 visitSymbol( symbolEntity->symbol() );
1047 }
1048 return true;
1049 }
1050 QgsMaskedLayers maskedLayers;
1051 };
1052
1053 SymbolLayerVisitor visitor;
1054 layer->renderer()->accept( &visitor );
1055 return visitor.maskedLayers;
1056}
1057
1059{
1061
1062 QgsExpression exp( layer->displayExpression() );
1063 context.setFeature( feature );
1064 exp.prepare( &context );
1065 QString displayString = exp.evaluate( &context ).toString();
1066
1067 return displayString;
1068}
1069
1071{
1072 if ( !layer )
1073 return false;
1074
1075 const QList<QgsRelation> relations = project->relationManager()->referencedRelations( layer );
1076 for ( const QgsRelation &relation : relations )
1077 {
1078 switch ( relation.strength() )
1079 {
1081 {
1082 QgsFeatureIds childFeatureIds;
1083
1084 const auto constFids = fids;
1085 for ( const QgsFeatureId fid : constFids )
1086 {
1087 //get features connected over this relation
1088 QgsFeatureIterator relatedFeaturesIt = relation.getRelatedFeatures( layer->getFeature( fid ) );
1089 QgsFeature childFeature;
1090 while ( relatedFeaturesIt.nextFeature( childFeature ) )
1091 {
1092 childFeatureIds.insert( childFeature.id() );
1093 }
1094 }
1095
1096 if ( childFeatureIds.count() > 0 )
1097 {
1098 if ( context.layers().contains( relation.referencingLayer() ) )
1099 {
1100 QgsFeatureIds handledFeatureIds = context.duplicatedFeatures( relation.referencingLayer() );
1101 // add feature ids
1102 handledFeatureIds.unite( childFeatureIds );
1103 context.setDuplicatedFeatures( relation.referencingLayer(), handledFeatureIds );
1104 }
1105 else
1106 {
1107 // add layer and feature id
1108 context.setDuplicatedFeatures( relation.referencingLayer(), childFeatureIds );
1109 }
1110 }
1111 break;
1112 }
1113
1115 break;
1116 }
1117 }
1118
1119 if ( layer->joinBuffer()->containsJoins() )
1120 {
1121 const QgsVectorJoinList joins = layer->joinBuffer()->vectorJoins();
1122 for ( const QgsVectorLayerJoinInfo &info : joins )
1123 {
1124 if ( qobject_cast< QgsAuxiliaryLayer * >( info.joinLayer() ) && flags & IgnoreAuxiliaryLayers )
1125 continue;
1126
1127 if ( info.isEditable() && info.hasCascadedDelete() )
1128 {
1129 QgsFeatureIds joinFeatureIds;
1130 const auto constFids = fids;
1131 for ( const QgsFeatureId &fid : constFids )
1132 {
1133 const QgsFeature joinFeature = layer->joinBuffer()->joinedFeatureOf( &info, layer->getFeature( fid ) );
1134 if ( joinFeature.isValid() )
1135 joinFeatureIds.insert( joinFeature.id() );
1136 }
1137
1138 if ( joinFeatureIds.count() > 0 )
1139 {
1140 if ( context.layers().contains( info.joinLayer() ) )
1141 {
1142 QgsFeatureIds handledFeatureIds = context.duplicatedFeatures( info.joinLayer() );
1143 // add feature ids
1144 handledFeatureIds.unite( joinFeatureIds );
1145 context.setDuplicatedFeatures( info.joinLayer(), handledFeatureIds );
1146 }
1147 else
1148 {
1149 // add layer and feature id
1150 context.setDuplicatedFeatures( info.joinLayer(), joinFeatureIds );
1151 }
1152 }
1153 }
1154 }
1155 }
1156
1157 return !context.layers().isEmpty();
1158}
1159
1160QString QgsVectorLayerUtils::guessFriendlyIdentifierField( const QgsFields &fields, bool *foundFriendly )
1161{
1162 if ( foundFriendly )
1163 *foundFriendly = false;
1164
1165 if ( fields.isEmpty() )
1166 return QString();
1167
1168 // Check the fields and keep the first one that matches.
1169 // We assume that the user has organized the data with the
1170 // more "interesting" field names first. As such, name should
1171 // be selected before oldname, othername, etc.
1172 // This candidates list is a prioritized list of candidates ranked by "interestingness"!
1173 // See discussion at https://github.com/qgis/QGIS/pull/30245 - this list must NOT be translated,
1174 // but adding hardcoded localized variants of the strings is encouraged.
1175 static QStringList sCandidates{ QStringLiteral( "name" ),
1176 QStringLiteral( "title" ),
1177 QStringLiteral( "heibt" ),
1178 QStringLiteral( "desc" ),
1179 QStringLiteral( "nom" ),
1180 QStringLiteral( "street" ),
1181 QStringLiteral( "road" ),
1182 QStringLiteral( "label" ),
1183 // German candidates
1184 QStringLiteral( "titel" ), //#spellok
1185 QStringLiteral( "beschreibung" ),
1186 QStringLiteral( "strasse" ),
1187 QStringLiteral( "beschriftung" ) };
1188
1189 // anti-names
1190 // this list of strings indicates parts of field names which make the name "less interesting".
1191 // For instance, we'd normally like to default to a field called "name" or "title", but if instead we
1192 // find one called "typename" or "typeid", then that's most likely a classification of the feature and not the
1193 // best choice to default to
1194 static QStringList sAntiCandidates{ QStringLiteral( "type" ),
1195 QStringLiteral( "class" ),
1196 QStringLiteral( "cat" ),
1197 // German anti-candidates
1198 QStringLiteral( "typ" ),
1199 QStringLiteral( "klasse" ),
1200 QStringLiteral( "kategorie" )
1201 };
1202
1203 QString bestCandidateName;
1204 QString bestCandidateNameWithAntiCandidate;
1205
1206 for ( const QString &candidate : sCandidates )
1207 {
1208 for ( const QgsField &field : fields )
1209 {
1210 const QString fldName = field.name();
1211 if ( fldName.contains( candidate, Qt::CaseInsensitive ) )
1212 {
1213 bool isAntiCandidate = false;
1214 for ( const QString &antiCandidate : sAntiCandidates )
1215 {
1216 if ( fldName.contains( antiCandidate, Qt::CaseInsensitive ) )
1217 {
1218 isAntiCandidate = true;
1219 break;
1220 }
1221 }
1222
1223 if ( isAntiCandidate )
1224 {
1225 if ( bestCandidateNameWithAntiCandidate.isEmpty() )
1226 {
1227 bestCandidateNameWithAntiCandidate = fldName;
1228 }
1229 }
1230 else
1231 {
1232 bestCandidateName = fldName;
1233 break;
1234 }
1235 }
1236 }
1237
1238 if ( !bestCandidateName.isEmpty() )
1239 break;
1240 }
1241
1242 QString candidateName = bestCandidateName.isEmpty() ? bestCandidateNameWithAntiCandidate : bestCandidateName;
1243 if ( !candidateName.isEmpty() )
1244 {
1245 // Special case for layers got from WFS using the OGR GMLAS field parsing logic.
1246 // Such layers contain a "id" field (the gml:id attribute of the object),
1247 // as well as a gml_name (a <gml:name>) element. However this gml:name is often
1248 // absent, partly because it is a property of the base class in GML schemas, and
1249 // that a lot of readers are not able to deduce its potential presence.
1250 // So try to look at another field whose name would end with _name
1251 // And fallback to using the "id" field that should always be filled.
1252 if ( candidateName == QLatin1String( "gml_name" ) &&
1253 fields.indexOf( QLatin1String( "id" ) ) >= 0 )
1254 {
1255 candidateName.clear();
1256 // Try to find a field ending with "_name", which is not "gml_name"
1257 for ( const QgsField &field : std::as_const( fields ) )
1258 {
1259 const QString fldName = field.name();
1260 if ( fldName != QLatin1String( "gml_name" ) && fldName.endsWith( QLatin1String( "_name" ) ) )
1261 {
1262 candidateName = fldName;
1263 break;
1264 }
1265 }
1266 if ( candidateName.isEmpty() )
1267 {
1268 // Fallback to "id"
1269 candidateName = QStringLiteral( "id" );
1270 }
1271 }
1272
1273 if ( foundFriendly )
1274 *foundFriendly = true;
1275 return candidateName;
1276 }
1277 else
1278 {
1279 // no good matches found by name, so scan through and look for the first string field
1280 for ( const QgsField &field : fields )
1281 {
1282 if ( field.type() == QVariant::String )
1283 return field.name();
1284 }
1285
1286 // no string fields found - just return first field
1287 return fields.at( 0 ).name();
1288 }
1289}
@ Composition
Fix relation, related elements are part of the parent and a parent copy will copy any children or del...
@ Association
Loose relation, related elements are not part of the parent and a parent copy will not copy any child...
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ NoFlags
No flags are set.
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition: qgis.h:255
@ Unknown
Unknown types.
@ Null
No geometry.
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition: qgis.h:182
@ NoGeometry
No geometry.
@ Unknown
Unknown.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the labeling...
A vector of attributes.
Definition: qgsattributes.h:59
CORE_EXPORT QgsAttributeMap toMap() const
Returns a QgsAttributeMap of the attribute values.
The QgsDefaultValue class provides a container for managing client side default values for fields.
bool isValid() const
Returns if this default value should be applied.
bool readOnly(int idx) const
This returns true if the field is manually set to read only or if the field does not support editing ...
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
void appendScopes(const QList< QgsExpressionContextScope * > &scopes)
Appends a list of scopes to the end of the context.
Class for parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
bool hasParserError() const
Returns true if an error occurred when parsing the input expression.
QString evalErrorString() const
Returns evaluation error.
QString parserErrorString() const
Returns parser error.
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes)
bool hasEvalError() const
Returns true if an error occurred when evaluating last input.
QVariant evaluate()
Evaluate the feature and return the result.
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.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
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.
QFlags< SinkFlag > SinkFlags
@ RegeneratePrimaryKey
This flag indicates, that a primary key field cannot be guaranteed to be unique and the sink should i...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
bool setAttribute(int field, const QVariant &attr)
Sets an attribute's value by field index.
Definition: qgsfeature.cpp:262
QgsAttributes attributes
Definition: qgsfeature.h:65
QgsFields fields
Definition: qgsfeature.h:66
void initAttributes(int fieldCount)
Initialize this feature with the given number of fields.
Definition: qgsfeature.cpp:235
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
Definition: qgsfeature.cpp:160
void setFields(const QgsFields &fields, bool initAttributes=false)
Assigns a field map with the feature to allow attribute access by attribute name.
Definition: qgsfeature.cpp:195
QgsGeometry geometry
Definition: qgsfeature.h:67
void setValid(bool validity)
Sets the validity of the feature.
Definition: qgsfeature.cpp:221
bool isValid() const
Returns the validity of this feature.
Definition: qgsfeature.cpp:216
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Definition: qgsfeature.cpp:335
void setGeometry(const QgsGeometry &geometry)
Set the feature's geometry.
Definition: qgsfeature.cpp:167
Q_GADGET QgsFeatureId id
Definition: qgsfeature.h:64
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:44
bool isCanceled() const
Tells whether the operation has been canceled already.
Definition: qgsfeedback.h:53
Stores information about constraints which may be present on a field.
ConstraintStrength
Strength of constraints.
@ ConstraintStrengthNotSet
Constraint is not set.
ConstraintOrigin
Origin of constraints.
@ ConstraintOriginNotSet
Constraint is not set.
@ ConstraintOriginProvider
Constraint was set at data provider.
ConstraintStrength constraintStrength(Constraint constraint) const
Returns the strength of a field constraint, or ConstraintStrengthNotSet if the constraint is not pres...
ConstraintOrigin constraintOrigin(Constraint constraint) const
Returns the origin of a field constraint, or ConstraintOriginNotSet if the constraint is not present ...
QString constraintExpression() const
Returns the constraint expression for the field, if set.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
@ ConstraintExpression
Field has an expression constraint set. See constraintExpression().
QString constraintDescription() const
Returns the descriptive name for the constraint expression.
Q_GADGET Constraints constraints
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:53
QString name
Definition: qgsfield.h:62
bool convertCompatible(QVariant &v, QString *errorMessage=nullptr) const
Converts the provided variant to a compatible format.
Definition: qgsfield.cpp:452
Q_GADGET bool isNumeric
Definition: qgsfield.h:56
QVariant::Type type
Definition: qgsfield.h:60
QgsFieldConstraints constraints
Definition: qgsfield.h:65
bool isReadOnly
Definition: qgsfield.h:67
Container of fields for a vector layer.
Definition: qgsfields.h:45
int indexOf(const QString &fieldName) const
Gets the field index from the field name.
Definition: qgsfields.cpp:207
@ OriginJoin
Field comes from a joined layer (originIndex / 1000 = index of the join, originIndex % 1000 = index w...
Definition: qgsfields.h:52
@ OriginProvider
Field comes from the underlying data provider of the vector layer (originIndex = index in provider's ...
Definition: qgsfields.h:51
int count() const
Returns number of items.
Definition: qgsfields.cpp:133
FieldOrigin fieldOrigin(int fieldIdx) const
Returns the field's origin (value from an enumeration).
Definition: qgsfields.cpp:189
bool isEmpty() const
Checks whether the container is empty.
Definition: qgsfields.cpp:128
int size() const
Returns number of items.
Definition: qgsfields.cpp:138
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Definition: qgsfields.cpp:163
int fieldOriginIndex(int fieldIdx) const
Returns the field's origin index (its meaning is specific to each type of origin).
Definition: qgsfields.cpp:197
int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
Definition: qgsfields.cpp:359
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:162
QVector< QgsGeometry > coerceToType(Qgis::WkbType type, double defaultZ=0, double defaultM=0) const
Attempts to coerce this geometry into the specified destination type.
Qgis::WkbType wkbType() const
Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
bool enabled() const
Returns whether the effect is enabled.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:107
QgsRelationManager * relationManager
Definition: qgsproject.h:117
QList< QgsRelation > referencedRelations(const QgsVectorLayer *layer=nullptr) const
Gets all relations where this layer is the referenced part (i.e.
Defines a relation between matching fields of the two involved tables of a relation.
Definition: qgsrelation.h:67
virtual QgsStyle::StyleEntity type() const =0
Returns the type of style entity.
An interface for classes which can visit style entity (e.g.
@ SymbolRule
Rule based symbology or label child rule.
A label settings entity for QgsStyle databases.
Definition: qgsstyle.h:1465
A symbol entity for QgsStyle databases.
Definition: qgsstyle.h:1372
@ LabelSettingsEntity
Label settings.
Definition: qgsstyle.h:185
@ SymbolEntity
Symbols.
Definition: qgsstyle.h:180
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the layer.
virtual QList< QgsSymbolLayerReference > masks() const
Returns masks defined by this symbol layer.
Abstract base class for all rendered symbols.
Definition: qgssymbol.h:94
QgsSymbolLayer * symbolLayer(int layer)
Returns the symbol layer at the specified index.
Definition: qgssymbol.cpp:760
qreal opacity() const
Returns the opacity for the symbol.
Definition: qgssymbol.h:495
int symbolLayerCount() const
Returns the total number of symbol layers contained in the symbol.
Definition: qgssymbol.h:215
Container for settings relating to a selective masking around a text.
QList< QgsSymbolLayerReference > maskedSymbolLayers() const
Returns a list of references to symbol layers that are masked by this buffer.
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the mask.
double opacity() const
Returns the mask's opacity.
bool enabled() const
Returns whether the mask is enabled.
static bool runOnMainThread(const Func &func, QgsFeedback *feedback=nullptr)
Guarantees that func is executed on the main thread.
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
@ ChangeAttributeValues
Allows modification of attribute values.
@ AddFeatures
Allows adding features.
virtual QgsAttributeList pkAttributeIndexes() const
Returns list of indexes of fields that make up the primary key.
virtual QString defaultValueClause(int fieldIndex) const
Returns any default value clauses which are present at the provider for a specified field index.
virtual QVariant defaultValue(int fieldIndex) const
Returns any literal default values which are present at the provider for a specified field index.
virtual Q_INVOKABLE QgsVectorDataProvider::Capabilities capabilities() const
Returns flags containing the supported capabilities.
virtual bool skipConstraintCheck(int fieldIndex, QgsFieldConstraints::Constraint constraint, const QVariant &value=QVariant()) const
Returns true if a constraint check should be skipped for a specified field (e.g., if the value return...
Partial snapshot of vector layer's state (only the members necessary for access to features)
const QgsVectorLayerJoinInfo * joinForFieldIndex(int index, const QgsFields &fields, int &sourceFieldIndex) const
Finds the vector join for a layer field index.
bool containsJoins() const
Quick way to test if there is any join at all.
QgsFeature joinedFeatureOf(const QgsVectorLayerJoinInfo *info, const QgsFeature &feature) const
Returns the joined feature corresponding to the feature.
const QgsVectorJoinList & vectorJoins() const
Defines left outer join from our vector layer to some other vector layer.
bool hasUpsertOnEdit() const
Returns whether a feature created on the target layer has to impact the joined layer by creating a ne...
bool isEditable() const
Returns whether joined fields may be edited through the form of the target layer.
QgsVectorLayer * joinLayer() const
Returns joined layer (may be nullptr if the reference was set by layer ID and not resolved yet)
Contains mainly the QMap with QgsVectorLayer and QgsFeatureIds do list all the duplicated features.
QgsFeatureIds duplicatedFeatures(QgsVectorLayer *layer) const
Returns the duplicated features in the given layer.
QList< QgsVectorLayer * > layers() const
Returns all the layers on which features have been duplicated.
Encapsulate geometry and attributes for new features, to be passed to createFeatures.
QgsGeometry geometry() const
Returns geometry.
QgsAttributeMap attributes() const
Returns attributes.
QgsFeatureData(const QgsGeometry &geometry=QgsGeometry(), const QgsAttributeMap &attributes=QgsAttributeMap())
Constructs a new QgsFeatureData with given geometry and attributes.
static QgsFeature duplicateFeature(QgsVectorLayer *layer, const QgsFeature &feature, QgsProject *project, QgsDuplicateFeatureContext &duplicateFeatureContext, const int maxDepth=0, int depth=0, QList< QgsVectorLayer * > referencedLayersBranch=QList< QgsVectorLayer * >())
Duplicates a feature and it's children (one level deep).
QList< QgsVectorLayerUtils::QgsFeatureData > QgsFeaturesDataList
Alias for list of QgsFeatureData.
static bool valueExists(const QgsVectorLayer *layer, int fieldIndex, const QVariant &value, const QgsFeatureIds &ignoreIds=QgsFeatureIds())
Returns true if the specified value already exists within a field.
static QgsFeatureList makeFeatureCompatible(const QgsFeature &feature, const QgsVectorLayer *layer, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags())
Converts input feature to be compatible with the given layer.
static QgsMaskedLayers symbolLayerMasks(const QgsVectorLayer *)
Returns all masks that may be defined on symbol layers for a given vector layer.
static QString guessFriendlyIdentifierField(const QgsFields &fields, bool *foundFriendly=nullptr)
Given a set of fields, attempts to pick the "most useful" field for user-friendly identification of f...
static QgsFeatureIterator getValuesIterator(const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly)
Create a feature iterator for a specified field name or expression.
static bool fieldEditabilityDependsOnFeature(const QgsVectorLayer *layer, int fieldIndex)
Returns true if the editability of the field at index fieldIndex from layer may vary feature by featu...
static QgsFeatureList makeFeaturesCompatible(const QgsFeatureList &features, const QgsVectorLayer *layer, QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags())
Converts input features to be compatible with the given layer.
static std::unique_ptr< QgsVectorLayerFeatureSource > getFeatureSource(QPointer< QgsVectorLayer > layer, QgsFeedback *feedback=nullptr)
Gets the feature source from a QgsVectorLayer pointer.
static QString getFeatureDisplayString(const QgsVectorLayer *layer, const QgsFeature &feature)
static QgsFeature createFeature(const QgsVectorLayer *layer, const QgsGeometry &geometry=QgsGeometry(), const QgsAttributeMap &attributes=QgsAttributeMap(), QgsExpressionContext *context=nullptr)
Creates a new feature ready for insertion into a layer.
static bool fieldIsEditable(const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature)
Tests whether a field is editable for a particular feature.
static bool attributeHasConstraints(const QgsVectorLayer *layer, int attributeIndex)
Returns true if a feature attribute has active constraints.
static QList< double > getDoubleValues(const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly=false, int *nullCount=nullptr, QgsFeedback *feedback=nullptr)
Fetches all double values from a specified field name or expression.
QFlags< CascadedFeatureFlag > CascadedFeatureFlags
static bool fieldIsReadOnly(const QgsVectorLayer *layer, int fieldIndex)
static QHash< QString, QgsMaskedLayers > labelMasks(const QgsVectorLayer *)
Returns masks defined in labeling options of a layer.
static QgsFeatureList createFeatures(const QgsVectorLayer *layer, const QgsFeaturesDataList &featuresData, QgsExpressionContext *context=nullptr)
Creates a set of new features ready for insertion into a layer.
static QVariant createUniqueValue(const QgsVectorLayer *layer, int fieldIndex, const QVariant &seed=QVariant())
Returns a new attribute value for the specified field index which is guaranteed to be unique.
static bool impactsCascadeFeatures(const QgsVectorLayer *layer, const QgsFeatureIds &fids, const QgsProject *project, QgsDuplicateFeatureContext &context, QgsVectorLayerUtils::CascadedFeatureFlags flags=QgsVectorLayerUtils::CascadedFeatureFlags())
static QList< QVariant > getValues(const QgsVectorLayer *layer, const QString &fieldOrExpression, bool &ok, bool selectedOnly=false, QgsFeedback *feedback=nullptr)
Fetches all values from a specified field name or expression.
static QVariant createUniqueValueFromCache(const QgsVectorLayer *layer, int fieldIndex, const QSet< QVariant > &existingValues, const QVariant &seed=QVariant())
Returns a new attribute value for the specified field index which is guaranteed to be unique within r...
static bool validateAttribute(const QgsVectorLayer *layer, const QgsFeature &feature, int attributeIndex, QStringList &errors, QgsFieldConstraints::ConstraintStrength strength=QgsFieldConstraints::ConstraintStrengthNotSet, QgsFieldConstraints::ConstraintOrigin origin=QgsFieldConstraints::ConstraintOriginNotSet)
Tests a feature attribute value to check whether it passes all constraints which are present on the c...
static void matchAttributesToFields(QgsFeature &feature, const QgsFields &fields)
Matches the attributes in feature to the specified fields.
@ IgnoreAuxiliaryLayers
Ignore auxiliary layers.
Represents a vector layer which manages a vector based data sets.
QVariant maximumValue(int index) const FINAL
Returns the maximum value for an attribute column or an invalid variant in case of error.
QgsDefaultValue defaultValueDefinition(int index) const
Returns the definition of the expression used when calculating the default value for a field.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
QgsExpressionContext createExpressionContext() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
const QgsAbstractVectorLayerLabeling * labeling() const
Access to const labeling configuration.
bool isEditable() const FINAL
Returns true if the provider is in editing mode.
Q_INVOKABLE Qgis::WkbType wkbType() const FINAL
Returns the WKBType or WKBUnknown in case of error.
QgsFeatureRenderer * renderer()
Returns the feature renderer used for rendering the features in the layer in 2D map views.
QString subsetString
QString displayExpression
QgsFeatureIterator getSelectedFeatures(QgsFeatureRequest request=QgsFeatureRequest()) const
Returns an iterator of the selected features.
QgsVectorDataProvider * dataProvider() FINAL
Returns the layer's data provider, it may be nullptr.
QgsVectorLayerJoinBuffer * joinBuffer()
Returns the join buffer object.
QgsVectorLayer * clone() const override
Returns a new instance equivalent to this one.
QgsFeature getFeature(QgsFeatureId fid) const
Queries the layer for the feature with the given id.
QStringList uniqueStringsMatching(int index, const QString &substring, int limit=-1, QgsFeedback *feedback=nullptr) const
Returns unique string values of an attribute which contain a specified subset string.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) FINAL
Adds a single feature to the sink.
virtual bool setSubsetString(const QString &subset)
Sets the string (typically sql) used to define a subset of the layer.
QVariant defaultValue(int index, const QgsFeature &feature=QgsFeature(), QgsExpressionContext *context=nullptr) const
Returns the calculated default value for the specified field index.
QgsEditFormConfig editFormConfig
QSet< QVariant > uniqueValues(int fieldIndex, int limit=-1) const FINAL
Calculates a list of unique values contained within an attribute in the layer.
static Qgis::GeometryType geometryType(Qgis::WkbType type)
Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a Polyg...
Definition: qgswkbtypes.h:862
QMap< int, QVariant > QgsAttributeMap
Definition: qgsattributes.h:42
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:917
#define FID_IS_NULL(fid)
Definition: qgsfeatureid.h:30
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37
#define FID_IS_NEW(fid)
Definition: qgsfeatureid.h:31
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28
QList< int > QgsAttributeList
Definition: qgsfield.h:27
QList< QgsVectorLayerJoinInfo > QgsVectorJoinList
bool _fieldIsEditable(const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature)
QHash< QString, QgsMaskedLayer > QgsMaskedLayers
masked layers where key is the layer id
QSet< QString > symbolLayerIds
Contains information relating to a node (i.e.
QString identifier
A string identifying the node.
QgsStyleEntityVisitorInterface::NodeType type
Node type.
Contains information relating to the style entity currently being visited.
const QgsStyleEntityInterface * entity
Reference to style entity being visited.