QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
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 #include "qgsgeometryengine.h"
19 #include "qgsspatialindex.h"
20 #include "qgsgeometry.h"
21 #include "qgsfeaturepool.h"
22 #include "qgsvectorlayer.h"
23 
24 QString QgsGeometryDuplicateCheckError::duplicatesString( const QMap<QString, QgsFeaturePool *> &featurePools, const QMap<QString, QList<QgsFeatureId>> &duplicates )
25 {
26  QStringList str;
27  for ( auto it = duplicates.constBegin(); it != duplicates.constEnd(); ++it )
28  {
29  str.append( featurePools[it.key()]->layer()->name() + ":" );
30  QStringList ids;
31  ids.reserve( it.value().length() );
32  for ( QgsFeatureId id : it.value() )
33  {
34  ids.append( QString::number( id ) );
35  }
36  str.back() += ids.join( ',' );
37  }
38  return str.join( QLatin1String( "; " ) );
39 }
40 
41 
42 void QgsGeometryDuplicateCheck::collectErrors( const QMap<QString, QgsFeaturePool *> &featurePools, QList<QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids ) const
43 {
44  QMap<QString, QgsFeatureIds> featureIds = ids.isEmpty() ? allLayerFeatureIds( featurePools ) : ids.toMap();
45  QgsGeometryCheckerUtils::LayerFeatures layerFeaturesA( featurePools, featureIds, compatibleGeometryTypes(), feedback, mContext, true );
46  QList<QString> layerIds = featureIds.keys();
47  for ( const QgsGeometryCheckerUtils::LayerFeature &layerFeatureA : layerFeaturesA )
48  {
49  // Ensure each pair of layers only gets compared once: remove the current layer from the layerIds, but add it to the layerList for layerFeaturesB
50  layerIds.removeOne( layerFeatureA.layer()->id() );
51 
52  QgsGeometry geomA = layerFeatureA.geometry();
53  QgsRectangle bboxA = geomA.boundingBox();
54  std::unique_ptr< QgsGeometryEngine > geomEngineA = QgsGeometryCheckerUtils::createGeomEngine( geomA.constGet(), mContext->tolerance );
55  if ( !geomEngineA->isValid() )
56  {
57  messages.append( tr( "Duplicate check failed for (%1): the geometry is invalid" ).arg( layerFeatureA.id() ) );
58  continue;
59  }
60  QMap<QString, QList<QgsFeatureId>> duplicates;
61 
62  QgsWkbTypes::GeometryType geomType = geomA.type();
63  QgsGeometryCheckerUtils::LayerFeatures layerFeaturesB( featurePools, QList<QString>() << layerFeatureA.layer()->id() << layerIds, bboxA, {geomType}, mContext );
64  for ( const QgsGeometryCheckerUtils::LayerFeature &layerFeatureB : layerFeaturesB )
65  {
66  // > : only report overlaps within same layer once
67  if ( layerFeatureA.layer()->id() == layerFeatureB.layer()->id() && layerFeatureB.feature().id() >= layerFeatureA.feature().id() )
68  {
69  continue;
70  }
71  QString errMsg;
72  QgsGeometry geomB = layerFeatureB.geometry();
73  std::unique_ptr<QgsAbstractGeometry> diffGeom( geomEngineA->symDifference( geomB.constGet(), &errMsg ) );
74  if ( errMsg.isEmpty() && diffGeom && diffGeom->isEmpty() )
75  {
76  duplicates[layerFeatureB.layer()->id()].append( layerFeatureB.feature().id() );
77  }
78  else if ( !errMsg.isEmpty() )
79  {
80  messages.append( tr( "Duplicate check failed for (%1, %2): %3" ).arg( layerFeatureA.id(), layerFeatureB.id(), errMsg ) );
81  }
82  }
83  if ( !duplicates.isEmpty() )
84  {
85  errors.append( new QgsGeometryDuplicateCheckError( this, layerFeatureA, geomA.constGet()->centroid(), featurePools, duplicates ) );
86  }
87  }
88 }
89 
90 void QgsGeometryDuplicateCheck::fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> & /*mergeAttributeIndices*/, Changes &changes ) const
91 {
92  QgsFeaturePool *featurePoolA = featurePools[ error->layerId() ];
93  QgsFeature featureA;
94  if ( !featurePoolA->getFeature( error->featureId(), featureA ) )
95  {
96  error->setObsolete();
97  return;
98  }
99 
100  if ( method == NoChange )
101  {
102  error->setFixed( method );
103  }
104  else if ( method == RemoveDuplicates )
105  {
106  QgsGeometryCheckerUtils::LayerFeature layerFeatureA( featurePoolA, featureA, mContext, true );
107  std::unique_ptr< QgsGeometryEngine > geomEngineA = QgsGeometryCheckerUtils::createGeomEngine( layerFeatureA.geometry().constGet(), mContext->tolerance );
108 
109  QgsGeometryDuplicateCheckError *duplicateError = static_cast<QgsGeometryDuplicateCheckError *>( error );
110  const QMap<QString, QList<QgsFeatureId>> duplicates = duplicateError->duplicates();
111  for ( auto it = duplicates.constBegin(); it != duplicates.constEnd(); ++it )
112  {
113  const QString layerIdB = it.key();
114  QgsFeaturePool *featurePoolB = featurePools[ layerIdB ];
115  const QList< QgsFeatureId > ids = it.value();
116  for ( QgsFeatureId idB : ids )
117  {
118  QgsFeature featureB;
119  if ( !featurePoolB->getFeature( idB, featureB ) )
120  {
121  continue;
122  }
123  QgsGeometryCheckerUtils::LayerFeature layerFeatureB( featurePoolB, featureB, mContext, true );
124  QgsAbstractGeometry *diffGeom = geomEngineA->symDifference( layerFeatureB.geometry().constGet() );
125  if ( diffGeom && diffGeom->isEmpty() )
126  {
127  featurePoolB->deleteFeature( featureB.id() );
128  changes[layerIdB][idB].append( Change( ChangeFeature, ChangeRemoved ) );
129  }
130 
131  delete diffGeom;
132  }
133  }
134  error->setFixed( method );
135  }
136  else
137  {
138  error->setFixFailed( tr( "Unknown method" ) );
139  }
140 }
141 
143 {
144  static QStringList methods = QStringList()
145  << tr( "No action" )
146  << tr( "Remove duplicates" );
147  return methods;
148 }
149 
151 {
152  return QStringLiteral( "QgsGeometryDuplicateCheck" );
153 }
154 
156 {
158 }
QgsGeometryCheckError::setFixFailed
void setFixFailed(const QString &reason)
Set the error status to failed and specify the reason for failure.
Definition: qgsgeometrycheckerror.cpp:109
QgsGeometryCheck::Change
Descripts a change to fix a geometry.
Definition: qgsgeometrycheck.h:177
QgsFeature::id
Q_GADGET QgsFeatureId id
Definition: qgsfeature.h:64
QgsGeometryDuplicateCheckError
Definition: qgsgeometryduplicatecheck.h:29
QgsGeometryCheck::ChangeFeature
@ ChangeFeature
This change happens on feature level.
Definition: qgsgeometrycheck.h:131
QgsGeometryDuplicateCheck::NoChange
@ NoChange
Definition: qgsgeometryduplicatecheck.h:80
QgsGeometryCheckError::setObsolete
void setObsolete()
Set the error status to obsolete.
Definition: qgsgeometrycheckerror.h:166
QgsGeometryCheckError::featureId
QgsFeatureId featureId() const
The id of the feature on which this error has been detected.
Definition: qgsgeometrycheckerror.h:90
QgsGeometryCheck::Changes
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
Definition: qgsgeometrycheck.h:213
QgsGeometryCheck::allLayerFeatureIds
QMap< QString, QgsFeatureIds > allLayerFeatureIds(const QMap< QString, QgsFeaturePool * > &featurePools) const
Returns all layers and feature ids.
Definition: qgsgeometrycheck.cpp:82
QgsGeometryCheckerUtils::LayerFeature::geometry
QgsGeometry geometry() const
Returns the geometry of this feature.
Definition: qgsgeometrycheckerutils.cpp:70
QgsGeometryCheck::LayerFeatureIds::isEmpty
bool isEmpty() const
Definition: qgsgeometrycheck.h:117
QgsGeometryDuplicateCheckError::duplicates
QMap< QString, QList< QgsFeatureId > > duplicates() const
Definition: qgsgeometryduplicatecheck.h:39
QgsGeometryDuplicateCheck::resolutionMethods
Q_DECL_DEPRECATED QStringList resolutionMethods() const override
Returns a list of descriptions for available resolutions for errors.
Definition: qgsgeometryduplicatecheck.cpp:142
QgsGeometryDuplicateCheck::compatibleGeometryTypes
QList< QgsWkbTypes::GeometryType > compatibleGeometryTypes() const override
A list of geometry types for which this check can be performed.
Definition: qgsgeometryduplicatecheck.h:68
QgsGeometryDuplicateCheck::fixError
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.
Definition: qgsgeometryduplicatecheck.cpp:90
QgsFeaturePool::getFeature
bool getFeature(QgsFeatureId id, QgsFeature &feature)
Retrieves the feature with the specified id into feature.
Definition: qgsfeaturepool.cpp:39
QgsRectangle
A rectangle specified with double values.
Definition: qgsrectangle.h:42
QgsGeometryCheck::LayerFeatureIds::toMap
QMap< QString, QgsFeatureIds > toMap() const
Definition: qgsgeometrycheck.h:112
qgsfeaturepool.h
QgsGeometryCheck::ChangeRemoved
@ ChangeRemoved
Something has been removed.
Definition: qgsgeometrycheck.h:145
QgsGeometryDuplicateCheck::factoryId
static QString factoryId()
Definition: qgsgeometryduplicatecheck.cpp:150
qgsgeometryengine.h
qgsgeometrycheckcontext.h
QgsFeaturePool::deleteFeature
virtual void deleteFeature(QgsFeatureId fid)=0
Removes a feature from this pool.
QgsGeometryCheckError::setFixed
void setFixed(int method)
Set the status to fixed and specify the method that has been used to fix the error.
Definition: qgsgeometrycheckerror.cpp:98
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:44
QgsGeometryCheckerUtils::LayerFeature
A layer feature combination to uniquely identify and access a feature in a set of layers.
Definition: qgsgeometrycheckerutils.h:52
qgsgeometryduplicatecheck.h
QgsGeometryCheck::LayerFeatureIds
A list of layers and feature ids for each of these layers.
Definition: qgsgeometrycheck.h:105
QgsAbstractGeometry::isEmpty
virtual bool isEmpty() const
Returns true if the geometry is empty.
Definition: qgsabstractgeometry.cpp:298
QgsGeometry::constGet
const QgsAbstractGeometry * constGet() const SIP_HOLDGIL
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
Definition: qgsgeometry.cpp:128
QgsAbstractGeometry
Abstract base class for all geometries.
Definition: qgsabstractgeometry.h:74
QgsGeometryDuplicateCheck::factoryCheckType
static QgsGeometryCheck::CheckType factoryCheckType()
Definition: qgsgeometryduplicatecheck.cpp:155
QgsGeometryCheck::mContext
const QgsGeometryCheckContext * mContext
Definition: qgsgeometrycheck.h:358
qgsvectorlayer.h
qgsgeometry.h
QgsWkbTypes::GeometryType
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:141
QgsAbstractGeometry::centroid
virtual QgsPoint centroid() const
Returns the centroid of the geometry.
Definition: qgsabstractgeometry.cpp:167
QgsGeometry
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:124
QgsGeometryCheckerUtils::LayerFeatures
Contains a set of layers and feature ids in those layers to pass to a geometry check.
Definition: qgsgeometrycheckerutils.h:113
QgsGeometryCheck::CheckType
CheckType
The type of a check.
Definition: qgsgeometrycheck.h:155
QgsGeometryCheckContext::tolerance
const double tolerance
The tolerance to allow for in geometry checks.
Definition: qgsgeometrycheckcontext.h:48
QgsGeometryDuplicateCheck::RemoveDuplicates
@ RemoveDuplicates
Definition: qgsgeometryduplicatecheck.h:80
QgsGeometryCheckerUtils::createGeomEngine
static std::unique_ptr< QgsGeometryEngine > createGeomEngine(const QgsAbstractGeometry *geometry, double tolerance)
Definition: qgsgeometrycheckerutils.cpp:263
QgsGeometry::boundingBox
QgsRectangle boundingBox() const
Returns the bounding box of the geometry.
Definition: qgsgeometry.cpp:996
qgsspatialindex.h
QgsFeature
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:56
QgsGeometryCheckError::layerId
const QString & layerId() const
The id of the layer on which this error has been detected.
Definition: qgsgeometrycheckerror.h:85
QgsGeometryCheck::FeatureCheck
@ FeatureCheck
The check controls geometries as a whole.
Definition: qgsgeometrycheck.h:157
QgsGeometry::type
QgsWkbTypes::GeometryType type
Definition: qgsgeometry.h:127
QgsGeometryDuplicateCheck::collectErrors
void collectErrors(const QMap< QString, QgsFeaturePool * > &featurePools, QList< QgsGeometryCheckError * > &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids=LayerFeatureIds()) const override
The main worker method.
Definition: qgsgeometryduplicatecheck.cpp:42
QgsGeometryCheckError
This represents an error reported by a geometry check.
Definition: qgsgeometrycheckerror.h:36
QgsFeaturePool
A feature pool is based on a vector layer and caches features.
Definition: qgsfeaturepool.h:38
QgsFeatureId
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28