24 const QMap<QString, QString> &expressions,
26 : QAbstractTableModel( parent )
27 , mSourceFields( sourceFields )
28 , mExpressionContextGenerator( new ExpressionContextGenerator( mSourceFields ) )
35 if ( role == Qt::DisplayRole )
37 switch ( orientation )
45 return tr(
"Source Expression" );
57 return tr(
"Length" );
61 return tr(
"Precision" );
65 return tr(
"Constraints" );
73 return tr(
"Comment" );
94 if ( parent.isValid() )
96 return mMapping.count();
101 if ( parent.isValid() )
108 if ( index.isValid() )
111 const Field &f { mMapping.at( index.row() ) };
117 case Qt::DisplayRole:
128 return f.field.displayNameWithAlias();
132 return f.field.typeName();
136 return f.field.length();
140 return f.field.precision();
144 return constraints != 0 ? tr(
"Constraints active" ) : QString();
148 return f.field.alias();
152 return f.field.comment();
157 case Qt::ToolTipRole:
162 QStringList constraintDescription;
165 constraintDescription.push_back( tr(
"Unique" ) );
169 constraintDescription.push_back( tr(
"Not null" ) );
173 constraintDescription.push_back( tr(
"Expression" ) );
175 return constraintDescription.join( QLatin1String(
"<br>" ) );
179 case Qt::BackgroundRole:
181 if ( constraints != 0 )
183 return QBrush( QColor( 255, 224, 178 ) );
194 if ( index.isValid() &&
198 return Qt::ItemFlags( Qt::ItemIsSelectable |
202 return Qt::ItemFlags();
207 if ( index.isValid() )
209 if ( role == Qt::EditRole )
211 Field &f = mMapping[index.row()];
227 setFieldTypeFromName( f.
field, value.toString() );
233 const int length { value.toInt( &ok ) };
241 const int precision { value.toInt( &ok ) };
263 emit dataChanged( index, index );
294bool QgsFieldMappingModel::moveUpOrDown(
const QModelIndex &index,
bool up )
296 if ( ! index.isValid() && index.model() ==
this )
300 const int row { up ? index.row() - 1 : index.row() };
302 if ( row < 0 || row + 1 >=
rowCount( QModelIndex() ) )
306 beginMoveRows( QModelIndex( ), row, row, QModelIndex(), row + 2 );
307 mMapping.swapItemsAt( row, row + 1 );
312QString QgsFieldMappingModel::findExpressionForDestinationField(
const QgsFieldMappingModel::Field &f, QStringList &excludedFieldNames )
316 for (
const QgsField &sf : std::as_const( mSourceFields ) )
320 excludedFieldNames.push_back( sf.name() );
325 for (
const QgsField &sf : std::as_const( mSourceFields ) )
327 if ( excludedFieldNames.contains( sf.name() ) || sf.type() != f.
field.
type() )
329 excludedFieldNames.push_back( sf.name() );
338 if ( mExpressionContextGenerator )
339 mExpressionContextGenerator->setSourceFields( mSourceFields );
340 QStringList usedFields;
342 for (
const Field &f : std::as_const( mMapping ) )
349 for (
auto it = mMapping.begin(); it != mMapping.end(); ++it )
351 if ( it->expression.isEmpty() )
353 const QString expression { findExpressionForDestinationField( *it, usedFields ) };
354 if ( ! expression.isEmpty() )
355 it->expression = expression;
363 return mExpressionContextGenerator.get();
368 mExpressionContextGenerator->setBaseExpressionContextGenerator( generator );
372 const QMap<QString, QString> &expressions )
377 QStringList usedFields;
378 for (
const QgsField &df : destinationFields )
384 if ( expressions.contains( f.
field.
name() ) )
389 if ( exp.isField() &&
390 mSourceFields.
names().contains( qgis::setToList( exp.referencedColumns() ).first() ) )
392 usedFields.push_back( qgis::setToList( exp.referencedColumns() ).first() );
397 const QString expression { findExpressionForDestinationField( f, usedFields ) };
398 if ( ! expression.isEmpty() )
401 mMapping.push_back( f );
408 return mDestinationEditable;
418 static const QMap<QMetaType::Type, QString> sDataTypes
435 static const QList<QgsVectorDataProvider::NativeType> sDataTypes =
452const QString QgsFieldMappingModel::qgsFieldToTypeName(
const QgsField &field )
455 for (
const auto &type : types )
457 if ( type.mType == field.
type() && type.mSubType == field.
subType() )
459 return type.mTypeName;
465void QgsFieldMappingModel::setFieldTypeFromName(
QgsField &field,
const QString &name )
468 for (
const auto &type : types )
470 if ( type.mTypeName == name )
487 QMap< QString, QgsProperty > fieldMap;
491 const bool isField = exp.
isField();
492 fieldMap.insert( field.originalName, isField
502 for (
int i = 0; i < mMapping.count(); ++i )
504 Field &f = mMapping[i];
537 const int lastRow {
rowCount( QModelIndex( ) ) };
538 beginInsertRows( QModelIndex(), lastRow, lastRow );
544 mMapping.push_back( f );
550 if ( index.isValid() && index.model() ==
this && index.row() <
rowCount( QModelIndex() ) )
552 beginRemoveRows( QModelIndex(), index.row(), index.row() );
553 mMapping.removeAt( index.row() );
565 return moveUpOrDown( index );
570 return moveUpOrDown( index,
false );
573QgsFieldMappingModel::ExpressionContextGenerator::ExpressionContextGenerator(
const QgsFields &sourceFields )
574 : mSourceFields( sourceFields )
578QgsExpressionContext QgsFieldMappingModel::ExpressionContextGenerator::createExpressionContext()
const
580 if ( mBaseGenerator )
583 std::unique_ptr< QgsExpressionContextScope > fieldMappingScope = std::make_unique< QgsExpressionContextScope >( tr(
"Field Mapping" ) );
584 fieldMappingScope->setFields( mSourceFields );
602 mBaseGenerator = generator;
605void QgsFieldMappingModel::ExpressionContextGenerator::setSourceFields(
const QgsFields &fields )
607 mSourceFields = fields;
@ Invalid
Invalid (not set) property.
@ Field
Field based property.
@ Expression
Expression based property.
Abstract interface for generating an expression context.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
void setFields(const QgsFields &fields)
Convenience function for setting a fields for the context.
An expression node which takes it value from a feature's field.
QString name() const
The name of the column.
Class for parsing and evaluation of expressions (formerly called "search strings").
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
bool isField() const
Checks whether an expression consists only of a single field reference.
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes)
const QgsExpressionNode * rootNode() const
Returns the root node of the expression.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void setValid(bool validity)
Sets the validity of the feature.
Stores information about constraints which may be present on a field.
@ ConstraintStrengthHard
Constraint must be honored before feature can be accepted.
@ ConstraintNotNull
Field may not be null.
@ ConstraintUnique
Field must have a unique value.
@ ConstraintExpression
Field has an expression constraint set. See constraintExpression().
QFlags< Constraint > Constraints
void setDestinationEditable(bool editable)
Sets the destination fields editable state to editable.
QVariant headerData(int section, Qt::Orientation orientation, int role) const override
ColumnDataIndex
The ColumnDataIndex enum represents the column index for the view.
@ DestinationAlias
Destination alias.
@ SourceExpression
Expression.
@ DestinationPrecision
Destination field precision.
@ DestinationComment
Destination comment.
@ DestinationConstraints
Destination field constraints.
@ DestinationName
Destination field name.
@ DestinationType
Destination field type string.
@ DestinationLength
Destination field length.
Qt::ItemFlags flags(const QModelIndex &index) const override
QgsFields sourceFields() const
Returns a list of source fields.
int columnCount(const QModelIndex &parent=QModelIndex()) const override
bool removeField(const QModelIndex &index)
Removes the field at index from the model, returns true on success.
void appendField(const QgsField &field, const QString &expression=QString())
Appends a new field to the model, with an optional expression.
QMap< QString, QgsProperty > fieldPropertyMap() const
Returns a map of destination field name to QgsProperty definition for field value,...
QList< QgsFieldMappingModel::Field > mapping() const
Returns a list of Field objects representing the current status of the model.
QgsFieldMappingModel(const QgsFields &sourceFields=QgsFields(), const QgsFields &destinationFields=QgsFields(), const QMap< QString, QString > &expressions=QMap< QString, QString >(), QObject *parent=nullptr)
Constructs a QgsFieldMappingModel from a set of sourceFields and destinationFields,...
bool moveDown(const QModelIndex &index)
Moves up the field at index.
bool moveUp(const QModelIndex &index)
Moves down the field at index.
int rowCount(const QModelIndex &parent=QModelIndex()) const override
QVariant data(const QModelIndex &index, int role) const override
static Q_DECL_DEPRECATED const QMap< QMetaType::Type, QString > dataTypes()
Returns a static map of supported data types.
void setBaseExpressionContextGenerator(const QgsExpressionContextGenerator *generator)
Sets the base expression context generator, which will generate the expression contexts for expressio...
static const QList< QgsVectorDataProvider::NativeType > supportedDataTypes()
Returns a static list of supported data types.
QgsExpressionContextGenerator * contextGenerator() const
Returns the context generator with the source fields.
void setDestinationFields(const QgsFields &destinationFields, const QMap< QString, QString > &expressions=QMap< QString, QString >())
Set destination fields to destinationFields, initial values for the expressions can be optionally spe...
void setSourceFields(const QgsFields &sourceFields)
Set source fields to sourceFields.
bool setData(const QModelIndex &index, const QVariant &value, int role) override
bool destinationEditable() const
Returns true if the destination fields are editable.
void setFieldPropertyMap(const QMap< QString, QgsProperty > &map)
Sets a map of destination field name to QgsProperty definition for field value.
Encapsulate a field in an attribute table or data source.
void setAlias(const QString &alias)
Sets the alias for the field (the friendly displayed name of the field ).
void setPrecision(int precision)
Set the field precision.
void setSubType(QMetaType::Type subType)
If the field is a collection, set its element's type.
void setName(const QString &name)
Set the field name.
void setComment(const QString &comment)
Set the field comment.
void setType(QMetaType::Type type)
Set variant type.
void setLength(int len)
Set the field length.
QMetaType::Type subType() const
If the field is a collection, gets its element's type.
QgsFieldConstraints constraints
void setTypeName(const QString &typeName)
Set the field type.
Container of fields for a vector layer.
A store for object properties.
QString expressionString() const
Returns the expression used for the property value.
Qgis::PropertyType propertyType() const
Returns the property type.
QString field() const
Returns the current field name the property references.
QVariant value(const QgsExpressionContext &context, const QVariant &defaultValue=QVariant(), bool *ok=nullptr) const
Calculates the current value of the property, including any transforms which are set for the property...
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
QVariant staticValue() const
Returns the current static value for the property.
static QgsProperty fromField(const QString &fieldName, bool isActive=true)
Returns a new FieldBasedProperty created from the specified field name.
static QString typeToDisplayString(QMetaType::Type type, QMetaType::Type subType=QMetaType::Type::UnknownType)
Returns a user-friendly translated string representing a QVariant type.
The Field struct holds information about a mapped field.
QgsField field
The field in its current status (it might have been renamed)
QString expression
The expression for the mapped field from the source fields.
QString originalName
The original name of the field.