Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmrenametablefield.cpp
       3                 :            :                          -----------------------------------
       4                 :            :     begin                : January 2020
       5                 :            :     copyright            : (C) 2020 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 "qgsalgorithmrenametablefield.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsRenameTableFieldAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "renametablefield" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QString QgsRenameTableFieldAlgorithm::displayName() const
      28                 :            : {
      29                 :          0 :   return QObject::tr( "Rename field" );
      30                 :            : }
      31                 :            : 
      32                 :          0 : QString QgsRenameTableFieldAlgorithm::shortHelpString() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "This algorithm renames an existing field from a vector layer." );
      35                 :            : }
      36                 :            : 
      37                 :          0 : QString QgsRenameTableFieldAlgorithm::shortDescription() const
      38                 :            : {
      39                 :          0 :   return QObject::tr( "Renames an existing field from a vector layer." );
      40                 :            : }
      41                 :            : 
      42                 :          0 : QStringList QgsRenameTableFieldAlgorithm::tags() const
      43                 :            : {
      44                 :          0 :   return QObject::tr( "rename,attribute,fields,table,change" ).split( ',' );
      45                 :          0 : }
      46                 :            : 
      47                 :          0 : QString QgsRenameTableFieldAlgorithm::group() const
      48                 :            : {
      49                 :          0 :   return QObject::tr( "Vector table" );
      50                 :            : }
      51                 :            : 
      52                 :          0 : QString QgsRenameTableFieldAlgorithm::groupId() const
      53                 :            : {
      54                 :          0 :   return QStringLiteral( "vectortable" );
      55                 :            : }
      56                 :            : 
      57                 :          0 : QString QgsRenameTableFieldAlgorithm::outputName() const
      58                 :            : {
      59                 :          0 :   return QObject::tr( "Renamed" );
      60                 :            : }
      61                 :            : 
      62                 :          0 : QList<int> QgsRenameTableFieldAlgorithm::inputLayerTypes() const
      63                 :            : {
      64                 :          0 :   return QList<int>() << QgsProcessing::TypeVector;
      65                 :          0 : }
      66                 :            : 
      67                 :          0 : QgsProcessingFeatureSource::Flag QgsRenameTableFieldAlgorithm::sourceFlags() const
      68                 :            : {
      69                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
      70                 :            : }
      71                 :            : 
      72                 :          0 : QgsRenameTableFieldAlgorithm *QgsRenameTableFieldAlgorithm::createInstance() const
      73                 :            : {
      74                 :          0 :   return new QgsRenameTableFieldAlgorithm();
      75                 :            : }
      76                 :            : 
      77                 :          0 : void QgsRenameTableFieldAlgorithm::initParameters( const QVariantMap & )
      78                 :            : {
      79                 :          0 :   addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD" ), QObject::tr( "Field to rename" ), QVariant(), QStringLiteral( "INPUT" ) ) );
      80                 :          0 :   addParameter( new QgsProcessingParameterString( QStringLiteral( "NEW_NAME" ), QObject::tr( "New field name" ) ) );
      81                 :          0 : }
      82                 :            : 
      83                 :          0 : QgsFields QgsRenameTableFieldAlgorithm::outputFields( const QgsFields &inputFields ) const
      84                 :            : {
      85                 :          0 :   QgsFields outFields = inputFields;
      86                 :          0 :   const int index = outFields.lookupField( mOriginalName );
      87                 :          0 :   if ( index < 0 )
      88                 :          0 :     throw QgsProcessingException( QObject::tr( "Field %1 could not be found in input table" ).arg( mOriginalName ) );
      89                 :            : 
      90                 :          0 :   if ( outFields.lookupField( mNewName ) >= 0 )
      91                 :          0 :     throw QgsProcessingException( QObject::tr( "A field already exists with the name %1" ).arg( mNewName ) );
      92                 :            : 
      93                 :          0 :   outFields.rename( index, mNewName );
      94                 :          0 :   return outFields;
      95                 :          0 : }
      96                 :            : 
      97                 :          0 : bool QgsRenameTableFieldAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      98                 :            : {
      99                 :          0 :   mOriginalName = parameterAsString( parameters, QStringLiteral( "FIELD" ), context );
     100                 :          0 :   mNewName = parameterAsString( parameters, QStringLiteral( "NEW_NAME" ), context );
     101                 :          0 :   return true;
     102                 :          0 : }
     103                 :            : 
     104                 :          0 : QgsFeatureList QgsRenameTableFieldAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback * )
     105                 :            : {
     106                 :          0 :   return QgsFeatureList() << feature;
     107                 :          0 : }
     108                 :            : 
     109                 :          0 : bool QgsRenameTableFieldAlgorithm::supportInPlaceEdit( const QgsMapLayer *layer ) const
     110                 :            : {
     111                 :            :   Q_UNUSED( layer )
     112                 :          0 :   return false;
     113                 :            : }
     114                 :            : 
     115                 :            : ///@endcond