qgsalgorithmrefactorfields.cpp

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmrefactorfields.h
                         ---------------------------------
    begin                : June 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsalgorithmrefactorfields.h"
 
#include "qgsprocessingparameterfieldmap.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

 
QString QgsRefactorFieldsAlgorithm::name() const
{
  return u"refactorfields"_s;
}
 
QString QgsRefactorFieldsAlgorithm::displayName() const
{
  return QObject::tr( "Refactor fields" );
}
 
QString QgsRefactorFieldsAlgorithm::shortHelpString() const
{
  return QObject::tr(
    "This algorithm allows editing the structure of the attributes table of a vector layer. Fields can be modified "
    "in their type and name, using a fields mapping.\n\n"
    "The original layer is not modified. A new layer is generated, which contains a modified attribute table, according "
    "to the provided fields mapping.\n\n"
    "Rows in orange have constraints in the template layer from which these fields were loaded. Treat this information "
    "as a hint during configuration. No constraints will be added on an output layer nor will they be checked or "
    "enforced by the algorithm."
  );
}
 
QString QgsRefactorFieldsAlgorithm::shortDescription() const
{
  return QObject::tr( "Allows editing the structure of the attributes table of a vector layer, permitting field renaming, creation and deletion." );
}
 
QStringList QgsRefactorFieldsAlgorithm::tags() const
{
  return QObject::tr( "attributes,table" ).split( ',' );
}
 
QString QgsRefactorFieldsAlgorithm::group() const
{
  return QObject::tr( "Vector table" );
}
 
QString QgsRefactorFieldsAlgorithm::groupId() const
{
  return u"vectortable"_s;
}
 
QString QgsRefactorFieldsAlgorithm::outputName() const
{
  return QObject::tr( "Refactored" );
}
 
QList<int> QgsRefactorFieldsAlgorithm::inputLayerTypes() const
{
  return QList<int>() << static_cast<int>( Qgis::ProcessingSourceType::Vector );
}
 
Qgis::ProcessingAlgorithmDocumentationFlags QgsRefactorFieldsAlgorithm::documentationFlags() const
{
  return Qgis::ProcessingAlgorithmDocumentationFlag::RespectsEllipsoid;
}
 
Qgis::ProcessingFeatureSourceFlags QgsRefactorFieldsAlgorithm::sourceFlags() const
{
  return Qgis::ProcessingFeatureSourceFlag::SkipGeometryValidityChecks;
}
 
QgsRefactorFieldsAlgorithm *QgsRefactorFieldsAlgorithm::createInstance() const
{
  return new QgsRefactorFieldsAlgorithm();
}
 
void QgsRefactorFieldsAlgorithm::initParameters( const QVariantMap & )
{
  auto param = std::make_unique<QgsProcessingParameterFieldMapping>( u"FIELDS_MAPPING"_s, QObject::tr( "Fields mapping" ), u"INPUT"_s );
  addParameter( param.release() );
}
 
QgsFields QgsRefactorFieldsAlgorithm::outputFields( const QgsFields & ) const
{
  return mFields;
}
 
bool QgsRefactorFieldsAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
{
  std::unique_ptr<QgsProcessingFeatureSource> source( parameterAsSource( parameters, u"INPUT"_s, context ) );
  if ( !source )
    throw QgsProcessingException( invalidSourceError( parameters, u"INPUT"_s ) );
 
  mDa.setSourceCrs( source->sourceCrs(), context.transformContext() );
  mDa.setEllipsoid( context.ellipsoid() );
 
  mExpressionContext = createExpressionContext( parameters, context, source.get() );
 
  const QVariantList mapping = parameters.value( u"FIELDS_MAPPING"_s ).toList();
  for ( const QVariant &map : mapping )
  {
    const QVariantMap fieldDef = map.toMap();
    const QString name = fieldDef.value( u"name"_s ).toString();
    if ( name.isEmpty() )
      throw QgsProcessingException( QObject::tr( "Field name cannot be empty" ) );
 
    const QMetaType::Type type = static_cast<QMetaType::Type>( fieldDef.value( u"type"_s ).toInt() );
    const QString typeName = fieldDef.value( u"sub_name"_s ).toString();
    const QMetaType::Type subType = static_cast<QMetaType::Type>( fieldDef.value( u"sub_type"_s ).toInt() );
 
    const int length = fieldDef.value( u"length"_s, 0 ).toInt();
    const int precision = fieldDef.value( u"precision"_s, 0 ).toInt();
 
    const QString alias = fieldDef.value( u"alias"_s ).toString();
    const QString comment = fieldDef.value( u"comment"_s ).toString();
 
    QgsField newField( name, type, typeName, length, precision, QString(), subType );
    newField.setAlias( alias );
    newField.setComment( comment );
    mFields.append( newField );
 
    const QString expressionString = fieldDef.value( u"expression"_s ).toString();
    if ( !expressionString.isEmpty() )
    {
      QgsExpression expression( expressionString );
      expression.setGeomCalculator( &mDa );
      expression.setDistanceUnits( context.distanceUnit() );
      expression.setAreaUnits( context.areaUnit() );
      if ( expression.hasParserError() )
      {
        throw QgsProcessingException( QObject::tr( "Parser error for field \"%1\" with expression \"%2\": %3" ).arg( name, expressionString, expression.parserErrorString() ) );
      }
      mExpressions.append( expression );
    }
    else
    {
      mExpressions.append( QgsExpression() );
    }
  }
 
  return true;
}
 
QgsFeatureList QgsRefactorFieldsAlgorithm::processFeature( const QgsFeature &feature, QgsProcessingContext &, QgsProcessingFeedback * )
{
  if ( !mExpressionsPrepared )
  {
    for ( auto it = mExpressions.begin(); it != mExpressions.end(); ++it )
    {
      if ( it->isValid() )
        it->prepare( &mExpressionContext );
    }
    mExpressionsPrepared = true;
  }
 
  QgsAttributes attributes;
  attributes.reserve( mExpressions.size() );
  for ( auto it = mExpressions.begin(); it != mExpressions.end(); ++it )
  {
    if ( it->isValid() )
    {
      mExpressionContext.setFeature( feature );
      mExpressionContext.lastScope()->setVariable( u"row_number"_s, mRowNumber );
      const QVariant value = it->evaluate( &mExpressionContext );
      if ( it->hasEvalError() )
      {
        throw QgsProcessingException( QObject::tr( "Evaluation error in expression \"%1\": %2" ).arg( it->expression(), it->evalErrorString() ) );
      }
      attributes.append( value );
    }
    else
    {
      attributes.append( QVariant() );
    }
  }
 
  QgsFeature f = feature;
  f.setAttributes( attributes );
  mRowNumber++;
  return QgsFeatureList() << f;
}
 
bool QgsRefactorFieldsAlgorithm::supportInPlaceEdit( const QgsMapLayer *layer ) const
{
  Q_UNUSED( layer )
  return false;
}