Add methods to QgsFieldMappingModel to retrieve/set QgsProperty based…

… definitions
qgis · Apr 7, 2020 · a3c7a05 · a3c7a05
1 parent 8050612
commit a3c7a05
Show file tree

Hide file tree

Showing 7 changed files with 159 additions and 1 deletion.
diff --git a/python/gui/auto_generated/qgsfieldmappingmodel.sip.in b/python/gui/auto_generated/qgsfieldmappingmodel.sip.in
@@ -79,6 +79,21 @@ Returns a list of source fields
     QList<QgsFieldMappingModel::Field> mapping() const;
 %Docstring
 Returns a list of Field objects representing the current status of the model
+%End
+
+    QMap< QString, QgsProperty > fieldPropertyMap() const;
+%Docstring
+Returns a map of destination field name to QgsProperty definition for field value,
+representing the current status of the model.
+
+.. seealso:: :py:func:`setFieldPropertyMap`
+%End
+
+    void setFieldPropertyMap( const QMap< QString, QgsProperty > &map );
+%Docstring
+Sets a map of destination field name to QgsProperty definition for field value.
+
+.. seealso:: :py:func:`fieldPropertyMap`
 %End
 
     void appendField( const QgsField &field, const QString &expression = QString() );

diff --git a/python/gui/auto_generated/qgsfieldmappingwidget.sip.in b/python/gui/auto_generated/qgsfieldmappingwidget.sip.in
@@ -53,6 +53,21 @@ Returns the underlying mapping model
     QList<QgsFieldMappingModel::Field> mapping() const;
 %Docstring
 Returns a list of Field objects representing the current status of the underlying mapping model
+%End
+
+    QMap< QString, QgsProperty > fieldPropertyMap() const;
+%Docstring
+Returns a map of destination field name to QgsProperty definition for field value,
+representing the current status of the widget.
+
+.. seealso:: :py:func:`setFieldPropertyMap`
+%End
+
+    void setFieldPropertyMap( const QMap< QString, QgsProperty > &map );
+%Docstring
+Sets a map of destination field name to QgsProperty definition for field value.
+
+.. seealso:: :py:func:`fieldPropertyMap`
 %End
 
     QItemSelectionModel *selectionModel();

diff --git a/src/gui/qgsfieldmappingmodel.cpp b/src/gui/qgsfieldmappingmodel.cpp
@@ -16,7 +16,7 @@
 
 #include "qgsfieldmappingmodel.h"
 #include "qgsexpressioncontextutils.h"
-
+#include "qgsexpressionnodeimpl.h"
 
 QgsFieldMappingModel::QgsFieldMappingModel( const QgsFields &sourceFields,
     const QgsFields &destinationFields,
@@ -402,6 +402,56 @@ QList<QgsFieldMappingModel::Field> QgsFieldMappingModel::mapping() const
   return mMapping;
 }
 
+QMap<QString, QgsProperty> QgsFieldMappingModel::fieldPropertyMap() const
+{
+  QMap< QString, QgsProperty > fieldMap;
+  for ( const QgsFieldMappingModel::Field &field : mMapping )
+  {
+    const QgsExpression exp( field.expression );
+    const bool isField = exp.isField();
+    fieldMap.insert( field.originalName, isField
+                     ? QgsProperty::fromField( static_cast<const QgsExpressionNodeColumnRef *>( exp.rootNode() )->name() )
+                     : QgsProperty::fromExpression( field.expression ) );
+  }
+  return fieldMap;
+}
+
+void QgsFieldMappingModel::setFieldPropertyMap( const QMap<QString, QgsProperty> &map )
+{
+  beginResetModel();
+  for ( int i = 0; i < mMapping.count(); ++i )
+  {
+    Field &f = mMapping[i];
+    if ( map.contains( f.field.name() ) )
+    {
+      const QgsProperty prop = map.value( f.field.name() );
+      switch ( prop.propertyType() )
+      {
+        case QgsProperty::StaticProperty:
+          f.expression = QgsExpression::quotedValue( prop.staticValue() );
+          break;
+
+        case QgsProperty::FieldBasedProperty:
+          f.expression = prop.field();
+          break;
+
+        case QgsProperty::ExpressionBasedProperty:
+          f.expression = prop.expressionString();
+          break;
+
+        case QgsProperty::InvalidProperty:
+          f.expression.clear();
+          break;
+      }
+    }
+    else
+    {
+      f.expression.clear();
+    }
+  }
+  endResetModel();
+}
+
 void QgsFieldMappingModel::appendField( const QgsField &field, const QString &expression )
 {
   const int lastRow { rowCount( QModelIndex( ) ) };

diff --git a/src/gui/qgsfieldmappingmodel.h b/src/gui/qgsfieldmappingmodel.h
@@ -22,6 +22,7 @@
 #include "qgsfields.h"
 #include "qgsexpressioncontextgenerator.h"
 #include "qgsfieldconstraints.h"
+#include "qgsproperty.h"
 #include "qgis_gui.h"
 
 
@@ -97,6 +98,21 @@ class GUI_EXPORT QgsFieldMappingModel: public QAbstractTableModel
     //! Returns a list of Field objects representing the current status of the model
     QList<QgsFieldMappingModel::Field> mapping() const;
 
+    /**
+     * Returns a map of destination field name to QgsProperty definition for field value,
+     * representing the current status of the model.
+     *
+     * \see setFieldPropertyMap()
+     */
+    QMap< QString, QgsProperty > fieldPropertyMap() const;
+
+    /**
+     * Sets a map of destination field name to QgsProperty definition for field value.
+     *
+     * \see fieldPropertyMap()
+     */
+    void setFieldPropertyMap( const QMap< QString, QgsProperty > &map );
+
     //! Appends a new \a field to the model, with an optional \a expression
     void appendField( const QgsField &field, const QString &expression = QString() );
 

diff --git a/src/gui/qgsfieldmappingwidget.cpp b/src/gui/qgsfieldmappingwidget.cpp
@@ -67,6 +67,16 @@ QList<QgsFieldMappingModel::Field> QgsFieldMappingWidget::mapping() const
   return model()->mapping();
 }
 
+QMap<QString, QgsProperty> QgsFieldMappingWidget::fieldPropertyMap() const
+{
+  return model()->fieldPropertyMap();
+}
+
+void QgsFieldMappingWidget::setFieldPropertyMap( const QMap<QString, QgsProperty> &map )
+{
+  model()->setFieldPropertyMap( map );
+}
+
 QItemSelectionModel *QgsFieldMappingWidget::selectionModel()
 {
   return mTableView->selectionModel();

diff --git a/src/gui/qgsfieldmappingwidget.h b/src/gui/qgsfieldmappingwidget.h
@@ -61,6 +61,21 @@ class GUI_EXPORT QgsFieldMappingWidget : public QgsPanelWidget, private Ui::QgsF
     //! Returns a list of Field objects representing the current status of the underlying mapping model
     QList<QgsFieldMappingModel::Field> mapping() const;
 
+    /**
+     * Returns a map of destination field name to QgsProperty definition for field value,
+     * representing the current status of the widget.
+     *
+     * \see setFieldPropertyMap()
+     */
+    QMap< QString, QgsProperty > fieldPropertyMap() const;
+
+    /**
+     * Sets a map of destination field name to QgsProperty definition for field value.
+     *
+     * \see fieldPropertyMap()
+     */
+    void setFieldPropertyMap( const QMap< QString, QgsProperty > &map );
+
     //! Returns the selection model
     QItemSelectionModel *selectionModel();
 

diff --git a/tests/src/python/test_qgsfieldmappingwidget.py b/tests/src/python/test_qgsfieldmappingwidget.py
@@ -17,6 +17,7 @@
     QgsFields,
     QgsField,
     QgsFieldConstraints,
+    QgsProperty
 )
 from qgis.gui import (
     QgsFieldMappingWidget,
@@ -173,6 +174,42 @@ def testSetSourceFields(self):
         self.assertEqual(model.data(model.index(2, 0), Qt.DisplayRole), '"source_field3"')
         self.assertEqual(model.data(model.index(2, 1), Qt.DisplayRole), 'destination_field3')
 
+    def testProperties(self):
+        model = QgsFieldMappingModel(self.source_fields, self.destination_fields)
+        model.setDestinationFields(self.destination_fields, {'destination_field1': '5',
+                                                             'destination_field2': 'source_field2',
+                                                             'destination_field3': 'source_field2 * @myvar'})
+
+        mapping = model.mapping()
+        self.assertEqual(mapping[0].field.name(), 'destination_field1')
+        self.assertEqual(mapping[1].field.name(), 'destination_field2')
+        self.assertEqual(mapping[2].field.name(), 'destination_field3')
+        self.assertEqual(mapping[0].expression, '5')
+        self.assertEqual(mapping[1].expression, 'source_field2')
+        self.assertEqual(mapping[2].expression, 'source_field2 * @myvar')
+
+        self.assertEqual(model.fieldPropertyMap(), {'destination_field1': QgsProperty.fromExpression('5'),
+                                                    'destination_field2': QgsProperty.fromField('source_field2'),
+                                                    'destination_field3': QgsProperty.fromExpression('source_field2 * @myvar'),
+                                                    })
+
+        model = QgsFieldMappingModel(self.source_fields, self.destination_fields)
+        self.assertEqual(model.fieldPropertyMap(), {'destination_field1': QgsProperty.fromField('source_field2'),
+                                                    'destination_field2': QgsProperty.fromField('source_field1'),
+                                                    'destination_field3': QgsProperty.fromExpression(''),
+                                                    })
+
+        model.setFieldPropertyMap({
+            'destination_field1': QgsProperty.fromField('source_field1'),
+            'destination_field2': QgsProperty.fromExpression('55*6'),
+            'destination_field3': QgsProperty.fromValue(6),
+        })
+        self.assertEqual(model.fieldPropertyMap(), {
+            'destination_field1': QgsProperty.fromField('source_field1'),
+            'destination_field2': QgsProperty.fromExpression('55*6'),
+            'destination_field3': QgsProperty.fromExpression('6'),
+        })
+
     def testWidget(self):
         """Test widget operations"""