QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
qgsfeaturefiltermodel.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsfeaturefiltermodel.cpp - QgsFeatureFilterModel
3 ---------------------
4 begin : 10.3.2017
5 copyright : (C) 2017 by Matthias Kuhn
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
16
18#include "qgssettings.h"
19#include "qgsvariantutils.h"
20#include "qgsvectorlayer.h"
21
22#include "moc_qgsfeaturefiltermodel.cpp"
23
24bool qVariantListCompare( const QVariantList &a, const QVariantList &b )
25{
26 if ( a.size() != b.size() )
27 return false;
28
29 for ( int i = 0; i < a.size(); ++i )
30 {
31 if ( !qgsVariantEqual( a.at( i ), b.at( i ) ) )
32 return false;
33 }
34 return true;
35}
36
37
40{
41 setFetchGeometry( false );
42 setFetchLimit( QgsSettings().value( QStringLiteral( "maxEntriesRelationWidget" ), 100, QgsSettings::Gui ).toInt() );
44}
45
47{
48 return mIdentifierFields.value( 0 );
49}
50
51void QgsFeatureFilterModel::requestToReloadCurrentFeature( QgsFeatureRequest &request )
52{
53 QStringList conditions;
54 for ( int i = 0; i < mIdentifierFields.count(); i++ )
55 {
56 if ( i >= mExtraIdentifierValue.toList().count() )
57 {
58 conditions << QgsExpression::createFieldEqualityExpression( mIdentifierFields.at( i ), QVariant() );
59 }
60 else
61 {
62 conditions << QgsExpression::createFieldEqualityExpression( mIdentifierFields.at( i ), mExtraIdentifierValue.toList().at( i ) );
63 }
64 }
65 request.setFilterExpression( conditions.join( QLatin1String( " AND " ) ) );
66}
67
69{
70 return QSet<QString>( mIdentifierFields.begin(), mIdentifierFields.end() );
71}
72
73QVariant QgsFeatureFilterModel::entryIdentifier( const QgsFeatureExpressionValuesGatherer::Entry &entry ) const
74{
75 return entry.featureId;
76}
77
78QgsFeatureExpressionValuesGatherer::Entry QgsFeatureFilterModel::createEntry( const QVariant &identifier ) const
79{
80 const QVariantList constValues = identifier.toList();
81
82 QStringList values;
83 for ( const QVariant &v : constValues )
84 values << QStringLiteral( "(%1)" ).arg( v.toString() );
85
86 return QgsFeatureExpressionValuesGatherer::Entry( constValues, values.join( QLatin1Char( ' ' ) ), QgsFeature( sourceLayer() ? sourceLayer()->fields() : QgsFields() ) );
87}
88
89bool QgsFeatureFilterModel::compareEntries( const QgsFeatureExpressionValuesGatherer::Entry &a, const QgsFeatureExpressionValuesGatherer::Entry &b ) const
90{
91 return qVariantListCompare( a.identifierFields, b.identifierFields );
92}
93
94bool QgsFeatureFilterModel::identifierIsNull( const QVariant &identifier ) const
95{
96 const QVariantList values = identifier.toList();
97 for ( const QVariant &value : values )
98 {
99 if ( !QgsVariantUtils::isNull( value ) )
100 {
101 return false;
102 }
103 }
104 return true;
105}
106
108{
109 QVariantList nullValues;
110 for ( int i = 0; i < mIdentifierFields.count(); i++ )
111 nullValues << QgsVariantUtils::createNullVariant( QMetaType::Type::Int );
112 return nullValues;
113}
114
116{
117 return mIdentifierFields;
118}
119
120
122{
123 if ( mIdentifierFields == identifierFields )
124 return;
125
126 mIdentifierFields = identifierFields;
129}
130
131QgsFeatureExpressionValuesGatherer *QgsFeatureFilterModel::createValuesGatherer( const QgsFeatureRequest &request ) const
132{
133 return new QgsFeatureExpressionValuesGatherer( sourceLayer(), displayExpression(), orderExpression(), request, mIdentifierFields );
134}
135
136
138{
139 QVariantList values = mExtraIdentifierValue.toList();
140 if ( values.count() != mIdentifierFields.count() )
141 {
142 return nullIdentifier().toList();
143 }
144 return values;
145}
146
151
156
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QMetaType::Type fieldType=QMetaType::Type::UnknownType)
Create an expression allowing to evaluate if a field is equal to a value.
void setExtraIdentifierValues(const QVariantList &extraIdentifierValues)
Allows specifying one value that does not need to match the filter criteria but will still be availab...
void setExtraIdentifierValueToNull() override
Allows specifying one value that does not need to match the filter criteria but will still be availab...
Q_DECL_DEPRECATED QString identifierField() const
The identifier field should be a unique field that can be used to identify individual features.
QgsFeatureFilterModel(QObject *parent=nullptr)
Create a new QgsFeatureFilterModel, optionally specifying a parent.
QStringList identifierFields
A set of fields of sourceLayer that is unique and should be used to identify features.
QVariantList extraIdentifierValues
The values that identifies the current feature.
void identifierFieldsChanged()
The identifier field should be a unique field that can be used to identify individual features.
void setIdentifierFields(const QStringList &identifierFields)
The identifier field should be a unique field that can be used to identify individual features.
void setExtraIdentifierValue(const QVariant &extraIdentifierValue)
Allows specifying one value that does not need to match the filter criteria but will still be availab...
void setFetchLimit(int fetchLimit)
Defines the feature request fetch limit If set to 0, no limit is applied when fetching.
void setFetchGeometry(bool fetchGeometry)
Defines if the geometry will be fetched.
void setExtraIdentifierValueUnguarded(const QVariant &identifierValue)
This will set the identifier value to be set in the model even if it doesn't exist currently in the d...
virtual QSet< QString > requestedAttributes() const
Returns the attributes to be fetched in the request.
QModelIndex parent(const QModelIndex &child) const override
QVariant mExtraIdentifierValue
The current identifier value.
QgsFeaturePickerModelBase(QObject *parent=nullptr)
Create a new QgsFeaturePickerModelBase, optionally specifying a parent.
virtual QVariant nullIdentifier() const =0
Returns a null identifier.
Wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
Stores settings for use within QGIS.
Definition qgssettings.h:65
static bool isNull(const QVariant &variant, bool silenceNullWarnings=false)
Returns true if the specified variant should be considered a NULL value.
static QVariant createNullVariant(QMetaType::Type metaType)
Helper method to properly create a null QVariant from a metaType Returns the created QVariant.
bool qgsVariantEqual(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether they are equal, two NULL values are always treated a...
Definition qgis.cpp:652
bool qVariantListCompare(const QVariantList &a, const QVariantList &b)