Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmaddtablefield.cpp
       3                 :            :                          -----------------------------------
       4                 :            :     begin                : November 2019
       5                 :            :     copyright            : (C) 2019 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy 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 "qgsalgorithmaddtablefield.h"
      19                 :            : 
      20                 :            : ///@cond PRIVATE
      21                 :            : 
      22                 :          0 : QString QgsAddTableFieldAlgorithm::name() const
      23                 :            : {
      24                 :          0 :   return QStringLiteral( "addfieldtoattributestable" );
      25                 :            : }
      26                 :            : 
      27                 :          0 : QString QgsAddTableFieldAlgorithm::displayName() const
      28                 :            : {
      29                 :          0 :   return QObject::tr( "Add field to attributes table" );
      30                 :            : }
      31                 :            : 
      32                 :          0 : QString QgsAddTableFieldAlgorithm::shortHelpString() const
      33                 :            : {
      34                 :          0 :   return QObject::tr( "This algorithm adds a new attribute to a vector layer.\n\n"
      35                 :            :                       "The name and characteristics of the attribute are defined as parameters. The new attribute "
      36                 :            :                       "is not added to the input layer but a new layer is generated instead.\n\n" );
      37                 :            : }
      38                 :            : 
      39                 :          0 : QStringList QgsAddTableFieldAlgorithm::tags() const
      40                 :            : {
      41                 :          0 :   return QObject::tr( "add,create,new,attribute,fields" ).split( ',' );
      42                 :          0 : }
      43                 :            : 
      44                 :          0 : QString QgsAddTableFieldAlgorithm::group() const
      45                 :            : {
      46                 :          0 :   return QObject::tr( "Vector table" );
      47                 :            : }
      48                 :            : 
      49                 :          0 : QString QgsAddTableFieldAlgorithm::groupId() const
      50                 :            : {
      51                 :          0 :   return QStringLiteral( "vectortable" );
      52                 :            : }
      53                 :            : 
      54                 :          0 : QString QgsAddTableFieldAlgorithm::outputName() const
      55                 :            : {
      56                 :          0 :   return QObject::tr( "Added" );
      57                 :            : }
      58                 :            : 
      59                 :          0 : QList<int> QgsAddTableFieldAlgorithm::inputLayerTypes() const
      60                 :            : {
      61                 :          0 :   return QList<int>() << QgsProcessing::TypeVector;
      62                 :          0 : }
      63                 :            : 
      64                 :          0 : QgsProcessingFeatureSource::Flag QgsAddTableFieldAlgorithm::sourceFlags() const
      65                 :            : {
      66                 :          0 :   return QgsProcessingFeatureSource::FlagSkipGeometryValidityChecks;
      67                 :            : }
      68                 :            : 
      69                 :          0 : QgsAddTableFieldAlgorithm *QgsAddTableFieldAlgorithm::createInstance() const
      70                 :            : {
      71                 :          0 :   return new QgsAddTableFieldAlgorithm();
      72                 :          0 : }
      73                 :            : 
      74                 :          0 : void QgsAddTableFieldAlgorithm::initParameters( const QVariantMap & )
      75                 :            : {
      76                 :          0 :   addParameter( new QgsProcessingParameterString( QStringLiteral( "FIELD_NAME" ), QObject::tr( "Field name" ) ) );
      77                 :          0 :   addParameter( new QgsProcessingParameterEnum( QStringLiteral( "FIELD_TYPE" ), QObject::tr( "Field type" ),
      78                 :          0 :                 QStringList() << QObject::tr( "Integer" ) << QObject::tr( "Float" ) << QObject::tr( "String" ), false, 0 ) );
      79                 :          0 :   addParameter( new QgsProcessingParameterNumber( QStringLiteral( "FIELD_LENGTH" ), QObject::tr( "Field length" ),
      80                 :          0 :                 QgsProcessingParameterNumber::Integer, 10, false, 1, 255 ) );
      81                 :          0 :   addParameter( new QgsProcessingParameterNumber( QStringLiteral( "FIELD_PRECISION" ), QObject::tr( "Field precision" ),
      82                 :          0 :                 QgsProcessingParameterNumber::Integer, 0, false, 0, 10 ) );
      83                 :          0 : }
      84                 :            : 
      85                 :          0 : QgsFields QgsAddTableFieldAlgorithm::outputFields( const QgsFields &inputFields ) const
      86                 :            : {
      87                 :          0 :   QgsFields outFields = inputFields;
      88                 :          0 :   outFields.append( QgsField( mField ) );
      89                 :          0 :   return outFields;
      90                 :          0 : }
      91                 :            : 
      92                 :          0 : bool QgsAddTableFieldAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
      93                 :            : {
      94                 :          0 :   QString name = parameterAsString( parameters, QStringLiteral( "FIELD_NAME" ), context );
      95                 :          0 :   int type = parameterAsInt( parameters, QStringLiteral( "FIELD_TYPE" ), context );
      96                 :          0 :   int length = parameterAsInt( parameters, QStringLiteral( "FIELD_LENGTH" ), context );
      97                 :          0 :   int precision = parameterAsInt( parameters, QStringLiteral( "FIELD_PRECISION" ), context );
      98                 :            : 
      99                 :          0 :   mField.setName( name );
     100                 :          0 :   mField.setLength( length );
     101                 :          0 :   mField.setPrecision( precision );
     102                 :            : 
     103                 :          0 :   switch ( type )
     104                 :            :   {
     105                 :            :     case 0:
     106                 :          0 :       mField.setType( QVariant::Int );
     107                 :          0 :       break;
     108                 :            :     case 1:
     109                 :          0 :       mField.setType( QVariant::Double );
     110                 :          0 :       break;
     111                 :            :     case 2:
     112                 :          0 :       mField.setType( QVariant::String );
     113                 :          0 :       break;
     114                 :            :   }
     115                 :            : 
     116                 :            :   return true;
     117                 :          0 : }
     118                 :            : 
     119                 :          0 : QgsFeatureList QgsAddTableFieldAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback * )
     120                 :            : {
     121                 :          0 :   QgsFeature f = feature;
     122                 :          0 :   QgsAttributes attributes = f.attributes();
     123                 :          0 :   attributes.append( QVariant() );
     124                 :          0 :   f.setAttributes( attributes );
     125                 :          0 :   return QgsFeatureList() << f;
     126                 :          0 : }
     127                 :            : 
     128                 :          0 : bool QgsAddTableFieldAlgorithm::supportInPlaceEdit( const QgsMapLayer *layer ) const
     129                 :            : {
     130                 :            :   Q_UNUSED( layer )
     131                 :          0 :   return false;
     132                 :            : }
     133                 :            : 
     134                 :            : ///@endcond