Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmremovenullgeometry.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : April 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #include "qgsalgorithmremovenullgeometry.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsRemoveNullGeometryAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "removenullgeometries" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QString QgsRemoveNullGeometryAlgorithm::displayName() const
      28                 :            : {
      29                 :          0 :   return QObject::tr( "Remove null geometries" );
      30                 :            : }
      31                 :            : 
      32                 :          0 : QStringList QgsRemoveNullGeometryAlgorithm::tags() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "remove,drop,delete,empty,geometry" ).split( ',' );
      35                 :          0 : }
      36                 :            : 
      37                 :          0 : QString QgsRemoveNullGeometryAlgorithm::group() const
      38                 :            : {
      39                 :          0 :   return QObject::tr( "Vector geometry" );
      40                 :            : }
      41                 :            : 
      42                 :          0 : QString QgsRemoveNullGeometryAlgorithm::groupId() const
      43                 :            : {
      44                 :          0 :   return QStringLiteral( "vectorgeometry" );
      45                 :            : }
      46                 :            : 
      47                 :          0 : void QgsRemoveNullGeometryAlgorithm::initAlgorithm( const QVariantMap & )
      48                 :            : {
      49                 :          0 :   addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
      50                 :          0 :   addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "REMOVE_EMPTY" ), QObject::tr( "Also remove empty geometries" ), false ) );
      51                 :            : 
      52                 :          0 :   addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Non null geometries" ),
      53                 :          0 :                 QgsProcessing::TypeVectorAnyGeometry, QVariant(), true ) );
      54                 :          0 :   QgsProcessingParameterFeatureSink *nullOutput = new QgsProcessingParameterFeatureSink( QStringLiteral( "NULL_OUTPUT" ),  QObject::tr( "Null geometries" ),
      55                 :          0 :       QgsProcessing::TypeVector, QVariant(), true );
      56                 :          0 :   nullOutput->setCreateByDefault( false );
      57                 :          0 :   addParameter( nullOutput );
      58                 :          0 : }
      59                 :            : 
      60                 :          0 : QString QgsRemoveNullGeometryAlgorithm::shortHelpString() const
      61                 :            : {
      62                 :          0 :   return QObject::tr( "This algorithm removes any features which do not have a geometry from a vector layer. "
      63                 :            :                       "All other features will be copied unchanged.\n\n"
      64                 :            :                       "Optionally, the features with null geometries can be saved to a separate output.\n\n"
      65                 :            :                       "If 'Also remove empty geometries' is checked, the algorithm removes features whose geometries "
      66                 :            :                       "have no coordinates, i.e., geometries that are empty. In that case, also the null "
      67                 :            :                       "output will reflect this option, containing both null and empty geometries." );
      68                 :            : }
      69                 :            : 
      70                 :          0 : QgsRemoveNullGeometryAlgorithm *QgsRemoveNullGeometryAlgorithm::createInstance() const
      71                 :            : {
      72                 :          0 :   return new QgsRemoveNullGeometryAlgorithm();
      73                 :            : }
      74                 :            : 
      75                 :          0 : QVariantMap QgsRemoveNullGeometryAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      76                 :            : {
      77                 :          0 :   std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
      78                 :          0 :   if ( !source )
      79                 :          0 :     throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
      80                 :            : 
      81                 :          0 :   const bool removeEmpty = parameterAsBoolean( parameters, QStringLiteral( "REMOVE_EMPTY" ), context );
      82                 :            : 
      83                 :          0 :   QString nonNullSinkId;
      84                 :          0 :   std::unique_ptr< QgsFeatureSink > nonNullSink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, nonNullSinkId, source->fields(),
      85                 :          0 :       source->wkbType(), source->sourceCrs() ) );
      86                 :            : 
      87                 :          0 :   QString nullSinkId;
      88                 :          0 :   std::unique_ptr< QgsFeatureSink > nullSink( parameterAsSink( parameters, QStringLiteral( "NULL_OUTPUT" ), context, nullSinkId, source->fields() ) );
      89                 :            : 
      90                 :          0 :   long count = source->featureCount();
      91                 :            : 
      92                 :          0 :   double step = count > 0 ? 100.0 / count : 1;
      93                 :          0 :   int current = 0;
      94                 :            : 
      95                 :          0 :   QgsFeature f;
      96                 :          0 :   QgsFeatureIterator it = source->getFeatures( QgsFeatureRequest(), QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks );
      97                 :          0 :   while ( it.nextFeature( f ) )
      98                 :            :   {
      99                 :          0 :     if ( feedback->isCanceled() )
     100                 :            :     {
     101                 :          0 :       break;
     102                 :            :     }
     103                 :            : 
     104                 :          0 :     if ( ( ( !removeEmpty && f.hasGeometry() ) || ( removeEmpty && !f.geometry().isEmpty() ) ) && nonNullSink )
     105                 :            :     {
     106                 :          0 :       nonNullSink->addFeature( f, QgsFeatureSink::FastInsert );
     107                 :          0 :     }
     108                 :          0 :     else if ( ( ( !removeEmpty && !f.hasGeometry() ) || ( removeEmpty && f.geometry().isEmpty() ) ) && nullSink )
     109                 :            :     {
     110                 :          0 :       nullSink->addFeature( f, QgsFeatureSink::FastInsert );
     111                 :          0 :     }
     112                 :            : 
     113                 :          0 :     feedback->setProgress( current * step );
     114                 :          0 :     current++;
     115                 :            :   }
     116                 :            : 
     117                 :          0 :   QVariantMap outputs;
     118                 :          0 :   if ( nonNullSink )
     119                 :          0 :     outputs.insert( QStringLiteral( "OUTPUT" ), nonNullSinkId );
     120                 :          0 :   if ( nullSink )
     121                 :          0 :     outputs.insert( QStringLiteral( "NULL_OUTPUT" ), nullSinkId );
     122                 :          0 :   return outputs;
     123                 :          0 : }
     124                 :            : 
     125                 :            : 
     126                 :            : ///@endcond
     127                 :            : 
     128                 :            :