23QString QgsRefactorFieldsAlgorithm::name()
const
25 return QStringLiteral(
"refactorfields" );
28QString QgsRefactorFieldsAlgorithm::displayName()
const
30 return QObject::tr(
"Refactor fields" );
33QString QgsRefactorFieldsAlgorithm::shortHelpString()
const
35 return QObject::tr(
"This algorithm allows editing the structure of the attributes table of a vector layer. Fields can be modified "
36 "in their type and name, using a fields mapping.\n\n"
37 "The original layer is not modified. A new layer is generated, which contains a modified attribute table, according "
38 "to the provided fields mapping.\n\n"
39 "Rows in orange have constraints in the template layer from which these fields were loaded. Treat this information "
40 "as a hint during configuration. No constraints will be added on an output layer nor will they be checked or "
41 "enforced by the algorithm." );
44QString QgsRefactorFieldsAlgorithm::shortDescription()
const
46 return QObject::tr(
"Allows editing the structure of the attributes table of a vector layer, permitting field renaming, creation and deletion." );
49QStringList QgsRefactorFieldsAlgorithm::tags()
const
51 return QObject::tr(
"attributes,table" ).split(
',' );
54QString QgsRefactorFieldsAlgorithm::group()
const
56 return QObject::tr(
"Vector table" );
59QString QgsRefactorFieldsAlgorithm::groupId()
const
61 return QStringLiteral(
"vectortable" );
64QString QgsRefactorFieldsAlgorithm::outputName()
const
66 return QObject::tr(
"Refactored" );
69QList<int> QgsRefactorFieldsAlgorithm::inputLayerTypes()
const
79QgsRefactorFieldsAlgorithm *QgsRefactorFieldsAlgorithm::createInstance()
const
81 return new QgsRefactorFieldsAlgorithm();
84void QgsRefactorFieldsAlgorithm::initParameters(
const QVariantMap & )
86 auto param = std::make_unique<QgsProcessingParameterFieldMapping>( QStringLiteral(
"FIELDS_MAPPING" ), QObject::tr(
"Fields mapping" ), QStringLiteral(
"INPUT" ) );
87 addParameter( param.release() );
97 std::unique_ptr<QgsProcessingFeatureSource> source( parameterAsSource( parameters, QStringLiteral(
"INPUT" ), context ) );
104 mExpressionContext = createExpressionContext( parameters, context, source.get() );
106 const QVariantList mapping = parameters.value( QStringLiteral(
"FIELDS_MAPPING" ) ).toList();
107 for (
const QVariant &map : mapping )
109 const QVariantMap fieldDef = map.toMap();
110 const QString name = fieldDef.value( QStringLiteral(
"name" ) ).toString();
111 if ( name.isEmpty() )
114 const QMetaType::Type type =
static_cast<QMetaType::Type
>( fieldDef.value( QStringLiteral(
"type" ) ).toInt() );
115 const QString
typeName = fieldDef.value( QStringLiteral(
"sub_name" ) ).toString();
116 const QMetaType::Type subType =
static_cast<QMetaType::Type
>( fieldDef.value( QStringLiteral(
"sub_type" ) ).toInt() );
118 const int length = fieldDef.value( QStringLiteral(
"length" ), 0 ).toInt();
119 const int precision = fieldDef.value( QStringLiteral(
"precision" ), 0 ).toInt();
121 const QString alias = fieldDef.value( QStringLiteral(
"alias" ) ).toString();
122 const QString comment = fieldDef.value( QStringLiteral(
"comment" ) ).toString();
125 newField.setAlias( alias );
126 newField.setComment( comment );
127 mFields.append( newField );
129 const QString expressionString = fieldDef.value( QStringLiteral(
"expression" ) ).toString();
130 if ( !expressionString.isEmpty() )
133 expression.setGeomCalculator( &mDa );
135 expression.setAreaUnits( context.
areaUnit() );
136 if ( expression.hasParserError() )
142 expression.parserErrorString()
145 mExpressions.append( expression );
158 if ( !mExpressionsPrepared )
160 for (
auto it = mExpressions.begin(); it != mExpressions.end(); ++it )
163 it->prepare( &mExpressionContext );
168 attributes.reserve( mExpressions.size() );
169 for (
auto it = mExpressions.begin(); it != mExpressions.end(); ++it )
173 mExpressionContext.setFeature( feature );
174 mExpressionContext.lastScope()->setVariable( QStringLiteral(
"row_number" ), mRowNumber );
175 const QVariant value = it->evaluate( &mExpressionContext );
176 if ( it->hasEvalError() )
178 throw QgsProcessingException( QObject::tr(
"Evaluation error in expression \"%1\": %2" ).arg( it->expression(), it->evalErrorString() ) );
180 attributes.append( value );
184 attributes.append( QVariant() );
194bool QgsRefactorFieldsAlgorithm::supportInPlaceEdit(
const QgsMapLayer *layer )
const
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ SkipGeometryValidityChecks
Invalid geometry checks should always be skipped. This flag can be useful for algorithms which always...
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Handles parsing and evaluation of expressions (formerly called "search strings").
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
Base class for all map layer types.
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
Qgis::AreaUnit areaUnit() const
Returns the area unit to use for area calculations.
Qgis::DistanceUnit distanceUnit() const
Returns the distance unit to use for distance calculations.
QString ellipsoid() const
Returns the ellipsoid to use for distance and area calculations.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
QList< QgsFeature > QgsFeatureList