Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmorderbyexpression.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : November 2017
       5                 :            :     copyright            : (C) 2017 by Etienne Trimaille
       6                 :            :     email                : etienne dot trimaille 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                 :            : 
      19                 :            : #include "qgsalgorithmorderbyexpression.h"
      20                 :            : #include "qgsfeaturerequest.h"
      21                 :            : 
      22                 :            : 
      23                 :            : ///@cond PRIVATE
      24                 :            : 
      25                 :          0 : QString QgsOrderByExpressionAlgorithm::name() const
      26                 :            : {
      27                 :          0 :   return QStringLiteral( "orderbyexpression" );
      28                 :            : }
      29                 :            : 
      30                 :          0 : QString QgsOrderByExpressionAlgorithm::displayName() const
      31                 :            : {
      32                 :          0 :   return QObject::tr( "Order by expression" );
      33                 :            : }
      34                 :            : 
      35                 :          0 : QStringList QgsOrderByExpressionAlgorithm::tags() const
      36                 :            : {
      37                 :          0 :   return QObject::tr( "orderby,sort,expression,field" ).split( ',' );
      38                 :          0 : }
      39                 :            : 
      40                 :          0 : QString QgsOrderByExpressionAlgorithm::group() const
      41                 :            : {
      42                 :          0 :   return QObject::tr( "Vector general" );
      43                 :            : }
      44                 :            : 
      45                 :          0 : QString QgsOrderByExpressionAlgorithm::groupId() const
      46                 :            : {
      47                 :          0 :   return QStringLiteral( "vectorgeneral" );
      48                 :            : }
      49                 :            : 
      50                 :          0 : void QgsOrderByExpressionAlgorithm::initAlgorithm( const QVariantMap & )
      51                 :            : {
      52                 :          0 :   addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ), QList< int >() << QgsProcessing::TypeVector ) );
      53                 :          0 :   addParameter( new QgsProcessingParameterExpression( QStringLiteral( "EXPRESSION" ), QObject::tr( "Expression" ), QVariant(), QStringLiteral( "INPUT" ) ) );
      54                 :          0 :   addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "ASCENDING" ), QObject::tr( "Sort ascending" ), true ) );
      55                 :          0 :   addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "NULLS_FIRST" ), QObject::tr( "Sort nulls first" ), false ) );
      56                 :            : 
      57                 :          0 :   addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Ordered" ) ) );
      58                 :          0 : }
      59                 :            : 
      60                 :          0 : QString QgsOrderByExpressionAlgorithm::shortHelpString() const
      61                 :            : {
      62                 :          0 :   return QObject::tr( "This algorithm sorts a vector layer according to an expression. Be careful, it might not work as expected with some providers, the order might not be kept every time." );
      63                 :            : }
      64                 :            : 
      65                 :          0 : QgsOrderByExpressionAlgorithm *QgsOrderByExpressionAlgorithm::createInstance() const
      66                 :            : {
      67                 :          0 :   return new QgsOrderByExpressionAlgorithm();
      68                 :            : }
      69                 :            : 
      70                 :          0 : QVariantMap QgsOrderByExpressionAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
      71                 :            : {
      72                 :          0 :   std::unique_ptr< QgsProcessingFeatureSource > source( parameterAsSource( parameters, QStringLiteral( "INPUT" ), context ) );
      73                 :          0 :   if ( !source )
      74                 :          0 :     throw QgsProcessingException( invalidSourceError( parameters, QStringLiteral( "INPUT" ) ) );
      75                 :            : 
      76                 :          0 :   QString expressionString = parameterAsExpression( parameters, QStringLiteral( "EXPRESSION" ), context );
      77                 :            : 
      78                 :          0 :   bool ascending = parameterAsBoolean( parameters, QStringLiteral( "ASCENDING" ), context );
      79                 :          0 :   bool nullsFirst = parameterAsBoolean( parameters, QStringLiteral( "NULLS_FIRST" ), context );
      80                 :            : 
      81                 :          0 :   QString sinkId;
      82                 :          0 :   std::unique_ptr< QgsFeatureSink > sink( parameterAsSink( parameters, QStringLiteral( "OUTPUT" ), context, sinkId, source->fields(), source->wkbType(), source->sourceCrs() ) );
      83                 :          0 :   if ( !sink )
      84                 :          0 :     throw QgsProcessingException( invalidSinkError( parameters, QStringLiteral( "OUTPUT" ) ) );
      85                 :            : 
      86                 :          0 :   long count = source->featureCount();
      87                 :          0 :   double step = count > 0 ? 100.0 / count : 1;
      88                 :          0 :   int current = 0;
      89                 :            : 
      90                 :          0 :   QgsFeatureRequest request;
      91                 :          0 :   request.addOrderBy( expressionString, ascending, nullsFirst );
      92                 :            : 
      93                 :          0 :   QgsFeature inFeature;
      94                 :          0 :   QgsFeatureIterator features = source->getFeatures( request, QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks );
      95                 :          0 :   while ( features.nextFeature( inFeature ) )
      96                 :            :   {
      97                 :          0 :     if ( feedback->isCanceled() )
      98                 :            :     {
      99                 :          0 :       break;
     100                 :            :     }
     101                 :          0 :     sink->addFeature( inFeature );
     102                 :          0 :     feedback->setProgress( current * step );
     103                 :          0 :     current++;
     104                 :            :   }
     105                 :            : 
     106                 :          0 :   QVariantMap outputs;
     107                 :          0 :   outputs.insert( QStringLiteral( "OUTPUT" ), sinkId );
     108                 :          0 :   return outputs;
     109                 :          0 : }
     110                 :            : 
     111                 :            : ///@endcond