Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmfilter.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : April 2018
       5                 :            :     copyright            : (C) 2018 by Matthias Kuhn
       6                 :            :     email                : matthias@opengis.ch
       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 "qgsalgorithmfilter.h"
      19                 :            : #include "qgsapplication.h"
      20                 :            : 
      21                 :            : ///@cond PRIVATE
      22                 :            : 
      23                 :          0 : QString QgsFilterAlgorithm::name() const
      24                 :            : {
      25                 :          0 :   return QStringLiteral( "filter" );
      26                 :            : }
      27                 :            : 
      28                 :          0 : QString QgsFilterAlgorithm::displayName() const
      29                 :            : {
      30                 :          0 :   return QObject::tr( "Feature filter" );
      31                 :            : }
      32                 :            : 
      33                 :          0 : QStringList QgsFilterAlgorithm::tags() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "filter,proxy,redirect,route" ).split( ',' );
      36                 :          0 : }
      37                 :            : 
      38                 :          0 : QString QgsFilterAlgorithm::group() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "Vector table" );
      41                 :            : }
      42                 :            : 
      43                 :          0 : QString QgsFilterAlgorithm::groupId() const
      44                 :            : {
      45                 :          0 :   return QStringLiteral( "vectortable" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : QgsProcessingAlgorithm::Flags QgsFilterAlgorithm::flags() const
      49                 :            : {
      50                 :          0 :   return FlagHideFromToolbox;
      51                 :            : }
      52                 :            : 
      53                 :          0 : QString QgsFilterAlgorithm::shortHelpString() const
      54                 :            : {
      55                 :          0 :   return QObject::tr( "This algorithm filters features from the input layer and redirects them to one or several outputs." );
      56                 :            : }
      57                 :            : 
      58                 :          0 : QgsFilterAlgorithm *QgsFilterAlgorithm::createInstance() const
      59                 :            : {
      60                 :          0 :   return new QgsFilterAlgorithm();
      61                 :            : }
      62                 :            : 
      63                 :          0 : QgsFilterAlgorithm::~QgsFilterAlgorithm()
      64                 :          0 : {
      65                 :          0 :   qDeleteAll( mOutputs );
      66                 :          0 : }
      67                 :            : 
      68                 :          0 : void QgsFilterAlgorithm::initAlgorithm( const QVariantMap &configuration )
      69                 :            : {
      70                 :          0 :   addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
      71                 :            : 
      72                 :          0 :   const QVariantList outputs = configuration.value( QStringLiteral( "outputs" ) ).toList();
      73                 :          0 :   for ( const QVariant &output : outputs )
      74                 :            :   {
      75                 :          0 :     const QVariantMap outputDef = output.toMap();
      76                 :          0 :     const QString name = QStringLiteral( "OUTPUT_%1" ).arg( outputDef.value( QStringLiteral( "name" ) ).toString() );
      77                 :          0 :     QgsProcessingParameterFeatureSink *outputParam = new QgsProcessingParameterFeatureSink( name, outputDef.value( QStringLiteral( "name" ) ).toString() );
      78                 :          0 :     QgsProcessingParameterDefinition::Flags flags = QgsProcessingParameterDefinition::Flags();
      79                 :          0 :     flags |= QgsProcessingParameterDefinition::FlagHidden;
      80                 :          0 :     if ( outputDef.value( QStringLiteral( "isModelOutput" ) ).toBool() )
      81                 :          0 :       flags |= QgsProcessingParameterDefinition::FlagIsModelOutput;
      82                 :          0 :     outputParam->setFlags( flags );
      83                 :          0 :     addParameter( outputParam );
      84                 :          0 :     mOutputs.append( new Output( name, outputDef.value( QStringLiteral( "expression" ) ).toString() ) );
      85                 :          0 :   }
      86                 :          0 : }
      87                 :            : 
      88                 :            : 
      89                 :          0 : QVariantMap QgsFilterAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      90                 :            : {
      91                 :          0 :   std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
      92                 :          0 :   if ( !source )
      93                 :          0 :     throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
      94                 :            : 
      95                 :          0 :   QgsExpressionContext expressionContext = createExpressionContext( parameters, context, source.get() );
      96                 :          0 :   for ( Output *output : std::as_const( mOutputs ) )
      97                 :            :   {
      98                 :          0 :     output->sink.reset( parameterAsSink( parameters, output->name, context, output->destinationIdentifier, source->fields(), source->wkbType(), source->sourceCrs() ) );
      99                 :          0 :     if ( !output->sink )
     100                 :          0 :       throw QgsProcessingException( invalidSinkError( parameters, output->name ) );
     101                 :          0 :     output->expression.prepare( &expressionContext );
     102                 :            :   }
     103                 :            : 
     104                 :          0 :   long count = source->featureCount();
     105                 :            : 
     106                 :          0 :   QgsFeature f;
     107                 :          0 :   QgsFeatureIterator it = source->getFeatures( QgsFeatureRequest(), QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks );
     108                 :            : 
     109                 :          0 :   double step = count > 0 ? 100.0 / count : 1;
     110                 :          0 :   int current = 0;
     111                 :            : 
     112                 :          0 :   while ( it.nextFeature( f ) )
     113                 :            :   {
     114                 :          0 :     if ( feedback->isCanceled() )
     115                 :            :     {
     116                 :          0 :       break;
     117                 :            :     }
     118                 :            : 
     119                 :          0 :     expressionContext.setFeature( f );
     120                 :            : 
     121                 :          0 :     for ( Output *output : std::as_const( mOutputs ) )
     122                 :            :     {
     123                 :          0 :       if ( output->expression.evaluate( &expressionContext ).toBool() )
     124                 :            :       {
     125                 :          0 :         output->sink->addFeature( f, QgsFeatureSink::FastInsert );
     126                 :          0 :       }
     127                 :            :     }
     128                 :            : 
     129                 :          0 :     feedback->setProgress( current * step );
     130                 :          0 :     current++;
     131                 :            :   }
     132                 :            : 
     133                 :          0 :   QVariantMap outputs;
     134                 :          0 :   for ( const Output *output : std::as_const( mOutputs ) )
     135                 :            :   {
     136                 :          0 :     outputs.insert( output->name, output->destinationIdentifier );
     137                 :            :   }
     138                 :          0 :   qDeleteAll( mOutputs );
     139                 :          0 :   mOutputs.clear();
     140                 :          0 :   return outputs;
     141                 :          0 : }
     142                 :            : 
     143                 :            : 
     144                 :            : ///@endcond PRIVATE