QGIS API Documentation  3.8.0-Zanzibar (11aff65)
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( QStringLiteral( "; " ) );
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  QgsRectangle bboxA = layerFeatureA.geometry().boundingBox();
53  std::unique_ptr< QgsGeometryEngine > geomEngineA = QgsGeometryCheckerUtils::createGeomEngine( layerFeatureA.geometry().constGet(), mContext->tolerance );
54  if ( !geomEngineA->isValid() )
55  {
56  messages.append( tr( "Duplicate check failed for (%1): the geometry is invalid" ).arg( layerFeatureA.id() ) );
57  continue;
58  }
59  QMap<QString, QList<QgsFeatureId>> duplicates;
60 
61  QgsWkbTypes::GeometryType geomType = layerFeatureA.feature().geometry().type();
62  QgsGeometryCheckerUtils::LayerFeatures layerFeaturesB( featurePools, QList<QString>() << layerFeatureA.layer()->id() << layerIds, bboxA, {geomType}, mContext );
63  for ( const QgsGeometryCheckerUtils::LayerFeature &layerFeatureB : layerFeaturesB )
64  {
65  // > : only report overlaps within same layer once
66  if ( layerFeatureA.layer()->id() == layerFeatureB.layer()->id() && layerFeatureB.feature().id() >= layerFeatureA.feature().id() )
67  {
68  continue;
69  }
70  QString errMsg;
71  QgsAbstractGeometry *diffGeom = geomEngineA->symDifference( layerFeatureB.geometry().constGet(), &errMsg );
72  if ( errMsg.isEmpty() && diffGeom && diffGeom->isEmpty() )
73  {
74  duplicates[layerFeatureB.layer()->id()].append( layerFeatureB.feature().id() );
75  }
76  else if ( !errMsg.isEmpty() )
77  {
78  messages.append( tr( "Duplicate check failed for (%1, %2): %3" ).arg( layerFeatureA.id(), layerFeatureB.id(), errMsg ) );
79  }
80  delete diffGeom;
81  }
82  if ( !duplicates.isEmpty() )
83  {
84  errors.append( new QgsGeometryDuplicateCheckError( this, layerFeatureA, layerFeatureA.geometry().constGet()->centroid(), featurePools, duplicates ) );
85  }
86  }
87 }
88 
89 void QgsGeometryDuplicateCheck::fixError( const QMap<QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap<QString, int> & /*mergeAttributeIndices*/, Changes &changes ) const
90 {
91  QgsFeaturePool *featurePoolA = featurePools[ error->layerId() ];
92  QgsFeature featureA;
93  if ( !featurePoolA->getFeature( error->featureId(), featureA ) )
94  {
95  error->setObsolete();
96  return;
97  }
98 
99  if ( method == NoChange )
100  {
101  error->setFixed( method );
102  }
103  else if ( method == RemoveDuplicates )
104  {
105  QgsGeometryCheckerUtils::LayerFeature layerFeatureA( featurePoolA, featureA, mContext, true );
106  std::unique_ptr< QgsGeometryEngine > geomEngineA = QgsGeometryCheckerUtils::createGeomEngine( layerFeatureA.geometry().constGet(), mContext->tolerance );
107 
108  QgsGeometryDuplicateCheckError *duplicateError = static_cast<QgsGeometryDuplicateCheckError *>( error );
109  for ( const QString &layerIdB : duplicateError->duplicates().keys() )
110  {
111  QgsFeaturePool *featurePoolB = featurePools[ layerIdB ];
112  for ( QgsFeatureId idB : duplicateError->duplicates()[layerIdB] )
113  {
114  QgsFeature featureB;
115  if ( !featurePoolB->getFeature( idB, featureB ) )
116  {
117  continue;
118  }
119  QgsGeometryCheckerUtils::LayerFeature layerFeatureB( featurePoolB, featureB, mContext, true );
120  QgsAbstractGeometry *diffGeom = geomEngineA->symDifference( layerFeatureB.geometry().constGet() );
121  if ( diffGeom && diffGeom->isEmpty() )
122  {
123  featurePoolB->deleteFeature( featureB.id() );
124  changes[layerIdB][idB].append( Change( ChangeFeature, ChangeRemoved ) );
125  }
126 
127  delete diffGeom;
128  }
129  }
130  error->setFixed( method );
131  }
132  else
133  {
134  error->setFixFailed( tr( "Unknown method" ) );
135  }
136 }
137 
139 {
140  static QStringList methods = QStringList()
141  << tr( "No action" )
142  << tr( "Remove duplicates" );
143  return methods;
144 }
145 
147 {
148  return QStringLiteral( "QgsGeometryDuplicateCheck" );
149 }
150 
152 {
154 }
QgsFeatureId id
Definition: qgsfeature.h:64
void collectErrors(const QMap< QString, QgsFeaturePool *> &featurePools, QList< QgsGeometryCheckError *> &errors, QStringList &messages, QgsFeedback *feedback, const LayerFeatureIds &ids=LayerFeatureIds()) const override
The main worker method.
A rectangle specified with double values.
Definition: qgsrectangle.h:41
virtual bool isEmpty() const
Returns true if the geometry is empty.
QMap< QString, QgsFeatureIds > toMap() const
qint64 QgsFeatureId
Definition: qgsfeatureid.h:25
Contains a set of layers and feature ids in those layers to pass to a geometry check.
CheckType
The type of a check.
void setObsolete()
Set the error status to obsolete.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
static QgsGeometryCheck::CheckType factoryCheckType()
void setFixFailed(const QString &reason)
Set the error status to failed and specify the reason for failure.
Base class for feedback objects to be used for cancellation of something running in a worker thread...
Definition: qgsfeedback.h:44
The check controls geometries as a whole.
bool getFeature(QgsFeatureId id, QgsFeature &feature)
Retrieves the feature with the specified id into feature.
A layer feature combination to uniquely identify and access a feature in a set of layers...
void fixError(const QMap< QString, QgsFeaturePool *> &featurePools, QgsGeometryCheckError *error, int method, const QMap< QString, int > &mergeAttributeIndices, Changes &changes) const override
Fix the error error with the specified method.
Abstract base class for all geometries.
const QString & layerId() const
The id of the layer on which this error has been detected.
A list of layers and feature ids for each of these layers.
const QgsAbstractGeometry * constGet() const
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:139
QMap< QString, QList< QgsFeatureId > > duplicates() const
QMap< QString, QMap< QgsFeatureId, QList< QgsGeometryCheck::Change > > > Changes
A collection of changes.
A feature pool is based on a vector layer and caches features.
Descripts a change to fix a geometry.
QgsGeometry geometry() const
Returns the geometry of this feature.
void setFixed(int method)
Set the status to fixed and specify the method that has been used to fix the error.
virtual void deleteFeature(QgsFeatureId fid)=0
Removes a feature from this pool.
QgsGeometryDuplicateCheckError(const QgsGeometryCheck *check, const QgsGeometryCheckerUtils::LayerFeature &layerFeature, const QgsPointXY &errorLocation, const QMap< QString, QgsFeaturePool *> &featurePools, const QMap< QString, QList< QgsFeatureId >> &duplicates)
QgsFeatureId featureId() const
The id of the feature on which this error has been detected.
This represents an error reported by a geometry check.
static std::unique_ptr< QgsGeometryEngine > createGeomEngine(const QgsAbstractGeometry *geometry, double tolerance)
QStringList resolutionMethods() const override
Returns a list of descriptions for available resolutions for errors.