Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmsplitfeaturesbyattributecharacter.cpp
       3                 :            :                          ---------------------
       4                 :            :     begin                : September 2019
       5                 :            :     copyright            : (C) 2019 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 "qgsalgorithmsplitfeaturesbyattributecharacter.h"
      19                 :            : #include "qgscurve.h"
      20                 :            : #include "qgslinestring.h"
      21                 :            : #include "qgscircularstring.h"
      22                 :            : #include "qgscompoundcurve.h"
      23                 :            : #include "qgsgeometrycollection.h"
      24                 :            : #include <QRegularExpression>
      25                 :            : 
      26                 :            : ///@cond PRIVATE
      27                 :            : 
      28                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::name() const
      29                 :            : {
      30                 :          0 :   return QStringLiteral( "splitfeaturesbycharacter" );
      31                 :            : }
      32                 :            : 
      33                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::displayName() const
      34                 :            : {
      35                 :          0 :   return QObject::tr( "Split features by character" );
      36                 :            : }
      37                 :            : 
      38                 :          0 : QStringList QgsSplitFeaturesByAttributeCharacterAlgorithm::tags() const
      39                 :            : {
      40                 :          0 :   return QObject::tr( "separate,attribute,value,string" ).split( ',' );
      41                 :          0 : }
      42                 :            : 
      43                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::group() const
      44                 :            : {
      45                 :          0 :   return QObject::tr( "Vector general" );
      46                 :            : }
      47                 :            : 
      48                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::groupId() const
      49                 :            : {
      50                 :          0 :   return QStringLiteral( "vectorgeneral" );
      51                 :            : }
      52                 :            : 
      53                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::shortHelpString() const
      54                 :            : {
      55                 :          0 :   return QObject::tr( "This algorithm splits features into multiple output features by splitting a field's value with a specified character.\n\n"
      56                 :            :                       "For instance, if a layer contains features with multiple comma separated values contained in a single field, this "
      57                 :            :                       "algorithm can be used to split these values up across multiple output features.\n\n"
      58                 :            :                       "Geometries and other attributes remain unchanged in the output.\n\n"
      59                 :            :                       "Optionally, the separator string can be a regular expression for added flexibility." );
      60                 :            : }
      61                 :            : 
      62                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::shortDescription() const
      63                 :            : {
      64                 :          0 :   return QObject::tr( "Splits features into multiple output features by splitting a field by a character." );
      65                 :            : }
      66                 :            : 
      67                 :          0 : QList<int> QgsSplitFeaturesByAttributeCharacterAlgorithm::inputLayerTypes() const
      68                 :            : {
      69                 :          0 :   return QList<int>() << QgsProcessing::TypeVector;
      70                 :          0 : }
      71                 :            : 
      72                 :          0 : void QgsSplitFeaturesByAttributeCharacterAlgorithm::initParameters( const QVariantMap & )
      73                 :            : {
      74                 :          0 :   addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD" ), QObject::tr( "Split using values in field" ), QVariant(), QStringLiteral( "INPUT" ) ) );
      75                 :          0 :   addParameter( new QgsProcessingParameterString( QStringLiteral( "CHAR" ), QObject::tr( "Split values using character" ) ) );
      76                 :          0 :   std::unique_ptr< QgsProcessingParameterDefinition > regexParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "REGEX" ), QObject::tr( "Use regular expression separator" ) );
      77                 :          0 :   regexParam->setFlags( regexParam->flags() | QgsProcessingParameterDefinition::FlagAdvanced );
      78                 :          0 :   addParameter( regexParam.release() );
      79                 :          0 : }
      80                 :            : 
      81                 :          0 : QgsProcessing::SourceType QgsSplitFeaturesByAttributeCharacterAlgorithm::outputLayerType() const
      82                 :            : {
      83                 :          0 :   return QgsProcessing::TypeVector;
      84                 :            : }
      85                 :            : 
      86                 :          0 : QgsSplitFeaturesByAttributeCharacterAlgorithm *QgsSplitFeaturesByAttributeCharacterAlgorithm::createInstance() const
      87                 :            : {
      88                 :          0 :   return new QgsSplitFeaturesByAttributeCharacterAlgorithm();
      89                 :          0 : }
      90                 :            : 
      91                 :          0 : QgsFields QgsSplitFeaturesByAttributeCharacterAlgorithm::outputFields( const QgsFields &inputFields ) const
      92                 :            : {
      93                 :          0 :   mFieldIndex = inputFields.lookupField( mFieldName );
      94                 :          0 :   QgsFields outputFields;
      95                 :          0 :   for ( int i = 0; i < inputFields.count(); ++i )
      96                 :            :   {
      97                 :          0 :     if ( i != mFieldIndex )
      98                 :            :     {
      99                 :          0 :       outputFields.append( inputFields.at( i ) );
     100                 :          0 :     }
     101                 :            :     else
     102                 :            :     {
     103                 :            :       // we need to convert the split field to a string field
     104                 :          0 :       outputFields.append( QgsField( inputFields.at( i ).name(), QVariant::String ) );
     105                 :            :     }
     106                 :          0 :   }
     107                 :          0 :   return outputFields;
     108                 :          0 : }
     109                 :            : 
     110                 :          0 : QString QgsSplitFeaturesByAttributeCharacterAlgorithm::outputName() const
     111                 :            : {
     112                 :          0 :   return QObject::tr( "Split" );
     113                 :            : }
     114                 :            : 
     115                 :          0 : bool QgsSplitFeaturesByAttributeCharacterAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
     116                 :            : {
     117                 :          0 :   mChar = parameterAsString( parameters, QStringLiteral( "CHAR" ), context );
     118                 :          0 :   mFieldName = parameterAsString( parameters, QStringLiteral( "FIELD" ), context );
     119                 :          0 :   mUseRegex = parameterAsBoolean( parameters, QStringLiteral( "REGEX" ), context );
     120                 :          0 :   if ( mUseRegex )
     121                 :          0 :     mRegex = QRegularExpression( mChar );
     122                 :          0 :   return true;
     123                 :          0 : }
     124                 :            : 
     125                 :          0 : QgsFeatureList QgsSplitFeaturesByAttributeCharacterAlgorithm::processFeature( const QgsFeature &f, QgsProcessingContext &, QgsProcessingFeedback * )
     126                 :            : {
     127                 :          0 :   QgsFeatureList res;
     128                 :          0 :   const QString val = f.attribute( mFieldIndex ).toString();
     129                 :          0 :   const QStringList parts = mUseRegex ? val.split( mRegex ) : val.split( mChar );
     130                 :          0 :   res.reserve( parts.size() );
     131                 :          0 :   for ( const QString &p : parts )
     132                 :            :   {
     133                 :          0 :     QgsFeature out = f;
     134                 :          0 :     out.setAttribute( mFieldIndex, p );
     135                 :          0 :     res << out;
     136                 :          0 :   }
     137                 :          0 :   return res;
     138                 :          0 : }
     139                 :            : 
     140                 :          0 : QgsFeatureSink::SinkFlags QgsSplitFeaturesByAttributeCharacterAlgorithm::sinkFlags() const
     141                 :            : {
     142                 :          0 :   return QgsFeatureSink::RegeneratePrimaryKey;
     143                 :            : }
     144                 :            : 
     145                 :            : ///@endcond
     146                 :            : 
     147                 :            : 
     148                 :            :