QGIS API Documentation 3.99.0-Master (d270888f95f)
Loading...
Searching...
No Matches
qgsgeometryduplicatecheck.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsgeometryduplicatecheck.cpp
3 ---------------------
4 begin : September 2015
5 copyright : (C) 2014 by Sandro Mani / Sourcepole AG
6 email : smani at sourcepole dot ch
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
17
18#include "qgsfeaturepool.h"
19#include "qgsfeedback.h"
20#include "qgsgeometry.h"
22#include "qgsgeometryengine.h"
23#include "qgsspatialindex.h"
24#include "qgsvectorlayer.h"
25
26#include <QString>
27
28using namespace Qt::StringLiterals;
29
30QString QgsGeometryDuplicateCheckError::duplicatesString( const QMap<QString, QgsFeaturePool *> &featurePools, const QMap<QString, QList<QgsFeatureId>> &duplicates )
31{
32 QStringList str;
33 for ( auto it = duplicates.constBegin(); it != duplicates.constEnd(); ++it )
34 {
35 str.append( featurePools[it.key()]->layerName() + ":" );
36 QStringList ids;
37 ids.reserve( it.value().length() );
38 for ( const QgsFeatureId id : it.value() )
39 {
40 ids.append( QString::number( id ) );
41 }
42 str.back() += ids.join( ',' );
43 }
44 return str.join( "; "_L1 );
45}
46
47
48QgsGeometryCheck::Result QgsGeometryDuplicateCheck::collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids ) const
49{
50 QMap<QString, QSet<QVariant>> uniqueIds;
51 const QMap<QString, QgsFeatureIds> featureIds = ids.isEmpty() ? allLayerFeatureIds( featurePools ) : ids.toMap();
52 const QgsGeometryCheckerUtils::LayerFeatures layerFeaturesA( featurePools, featureIds, compatibleGeometryTypes(), feedback, mContext, true );
53 QList<QString> layerIds = featureIds.keys();
54 for ( const QgsGeometryCheckerUtils::LayerFeature &layerFeatureA : layerFeaturesA )
55 {
56 if ( feedback && feedback->isCanceled() )
57 {
59 }
60
61 if ( context()->uniqueIdFieldIndex != -1 )
62 {
63 QgsGeometryCheck::Result result = checkUniqueId( layerFeatureA, uniqueIds );
65 {
66 return result;
67 }
68 }
69
70 // Ensure each pair of layers only gets compared once: remove the current layer from the layerIds, but add it to the layerList for layerFeaturesB
71 layerIds.removeOne( layerFeatureA.layer()->id() );
72
73 const QgsGeometry geomA = layerFeatureA.geometry();
74 const QgsRectangle bboxA = geomA.boundingBox();
75 std::unique_ptr<QgsGeometryEngine> geomEngineA( QgsGeometry::createGeometryEngine( geomA.constGet(), mContext->tolerance, Qgis::GeosCreationFlags() ) );
76 if ( !geomEngineA->isValid() )
77 {
78 messages.append( tr( "Duplicate check failed for (%1): the geometry is invalid" ).arg( layerFeatureA.id() ) );
79 continue;
80 }
81 QMap<QString, QList<QgsFeatureId>> duplicates;
82
83 const Qgis::GeometryType geomType = geomA.type();
84 const QgsGeometryCheckerUtils::LayerFeatures layerFeaturesB( featurePools, QList<QString>() << layerFeatureA.layer()->id() << layerIds, bboxA, { geomType }, mContext );
85 for ( const QgsGeometryCheckerUtils::LayerFeature &layerFeatureB : layerFeaturesB )
86 {
87 if ( feedback && feedback->isCanceled() )
88 {
90 }
91
92 // only report overlaps within same layer once
93 if ( layerFeatureA.layer()->id() == layerFeatureB.layer()->id() && layerFeatureB.feature().id() >= layerFeatureA.feature().id() )
94 {
95 continue;
96 }
97
98 const QgsGeometry geomB = layerFeatureB.geometry();
99 QString errMsg;
100 const bool equal = geomEngineA->isEqual( geomB.constGet(), &errMsg );
101 if ( equal && errMsg.isEmpty() )
102 {
103 duplicates[layerFeatureB.layer()->id()].append( layerFeatureB.feature().id() );
104 }
105 else if ( !errMsg.isEmpty() )
106 {
107 messages.append( tr( "Duplicate check failed for (%1, %2): %3" ).arg( layerFeatureA.id(), layerFeatureB.id(), errMsg ) );
108 }
109 }
110 if ( !duplicates.isEmpty() )
111 {
112 errors.append( new QgsGeometryDuplicateCheckError( this, layerFeatureA, geomA.constGet()->centroid(), featurePools, duplicates ) );
113 }
114 }
116}
117
118void QgsGeometryDuplicateCheck::fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> & /*mergeAttributeIndices*/, Changes &changes ) const
119{
120 QgsFeaturePool *featurePoolA = featurePools[error->layerId()];
121 QgsFeature featureA;
122 if ( !featurePoolA->getFeature( error->featureId(), featureA ) )
123 {
124 error->setObsolete();
125 return;
126 }
127
128 if ( method == NoChange )
129 {
130 error->setFixed( method );
131 }
132 else if ( method == RemoveDuplicates )
133 {
134 const QgsGeometryCheckerUtils::LayerFeature layerFeatureA( featurePoolA, featureA, mContext, true );
135 std::unique_ptr<QgsGeometryEngine> geomEngineA( QgsGeometry::createGeometryEngine( layerFeatureA.geometry().constGet(), mContext->tolerance ) );
136
137 QgsGeometryDuplicateCheckError *duplicateError = static_cast<QgsGeometryDuplicateCheckError *>( error );
138 const QMap<QString, QList<QgsFeatureId>> duplicates = duplicateError->duplicates();
139 for ( auto it = duplicates.constBegin(); it != duplicates.constEnd(); ++it )
140 {
141 const QString layerIdB = it.key();
142 QgsFeaturePool *featurePoolB = featurePools[layerIdB];
143 const QList<QgsFeatureId> ids = it.value();
144 for ( const QgsFeatureId idB : ids )
145 {
146 QgsFeature featureB;
147 if ( !featurePoolB->getFeature( idB, featureB ) )
148 {
149 continue;
150 }
151 const QgsGeometryCheckerUtils::LayerFeature layerFeatureB( featurePoolB, featureB, mContext, true );
152 std::unique_ptr<QgsAbstractGeometry> diffGeom( geomEngineA->symDifference( layerFeatureB.geometry().constGet() ) );
153 if ( !diffGeom || diffGeom->isEmpty() )
154 {
155 featurePoolB->deleteFeature( featureB.id() );
156 changes[layerIdB][idB].append( Change( ChangeFeature, ChangeRemoved ) );
157 }
158 }
159 }
160 error->setFixed( method );
161 }
162 else
163 {
164 error->setFixFailed( tr( "Unknown method" ) );
165 }
166}
167
169{
170 static const QStringList methods = QStringList()
171 << tr( "No action" )
172 << tr( "Remove duplicates" );
173 return methods;
174}
175
177{
178 return u"QgsGeometryDuplicateCheck"_s;
179}
180
QFlags< GeosCreationFlag > GeosCreationFlags
Geos geometry creation behavior flags.
Definition qgis.h:2216
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:365
virtual QgsPoint centroid() const
Returns the centroid of the geometry.
A feature pool is based on a vector layer and caches features.
virtual void deleteFeature(QgsFeatureId fid)=0
Removes a feature from this pool.
bool getFeature(QgsFeatureId id, QgsFeature &feature)
Retrieves the feature with the specified id into feature.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
QgsFeatureId id
Definition qgsfeature.h:68
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:55
This represents an error reported by a geometry check.
QgsFeatureId featureId() const
The id of the feature on which this error has been detected.
void setFixed(int method)
Set the status to fixed and specify the method that has been used to fix the error.
void setFixFailed(const QString &reason)
Set the error status to failed and specify the reason for failure.
void setObsolete()
Set the error status to obsolete.
const QString & layerId() const
The id of the layer on which this error has been detected.
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
const QgsGeometryCheckContext * mContext
@ ChangeFeature
This change happens on feature level.
CheckType
The type of a check.
@ FeatureCheck
The check controls geometries as a whole.
QMap< QString, QgsFeatureIds > allLayerFeatureIds(const QMap< QString, QgsFeaturePool * > &featurePools) const
Returns all layers and feature ids.
Result checkUniqueId(const QgsGeometryCheckerUtils::LayerFeature layerFeature, QMap< QString, QSet< QVariant > > &uniqueIds) const
Checks that there are no duplicated unique IDs.
Result
Result of the geometry checker operation.
@ Canceled
User canceled calculation.
@ Success
Operation completed successfully.
@ ChangeRemoved
Something has been removed.
const QgsGeometryCheckContext * context() const
Returns the context.
A layer feature combination to uniquely identify and access a feature in a set of layers.
QgsGeometry geometry() const
Returns the geometry of this feature.
Contains a set of layers and feature ids in those layers to pass to a geometry check.
A duplicate geometry check error.
QMap< QString, QList< QgsFeatureId > > duplicates() const
Returns the duplicates.
static QgsGeometryCheck::CheckType factoryCheckType()
QList< Qgis::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
Q_DECL_DEPRECATED QStringList resolutionMethods() const override
Returns a list of descriptions for available resolutions for errors.
QgsGeometryCheck::Result collectErrors(const QMap< QString, QgsFeaturePool * > &featurePools, QList< QgsGeometryCheckError * > &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids=LayerFeatureIds()) const override
The main worker method.
void fixError(const QMap< QString, QgsFeaturePool * > &featurePools, QgsGeometryCheckError *error, int method, const QMap< QString, int > &mergeAttributeIndices, Changes &changes) const override
Fixes the error error with the specified method.
A geometry is the spatial representation of a feature.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
Qgis::GeometryType type
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
static QgsGeometryEngine * createGeometryEngine(const QgsAbstractGeometry *geometry, double precision=0.0, Qgis::GeosCreationFlags flags=Qgis::GeosCreationFlag::SkipEmptyInteriorRings)
Creates and returns a new geometry engine representing the specified geometry using precision on a gr...
A rectangle specified with double values.
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Descripts a change to fix a geometry.
A list of layers and feature ids for each of these layers.
QMap< QString, QgsFeatureIds > toMap() const