QGIS API Documentation 3.99.0-Master (d270888f95f)
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 <QString>
23
24#include "moc_qgsfeaturefiltermodel.cpp"
25
26using namespace Qt::StringLiterals;
27
28bool qVariantListCompare( const QVariantList &a, const QVariantList &b )
29{
30 if ( a.size() != b.size() )
31 return false;
32
33 for ( int i = 0; i < a.size(); ++i )
34 {
35 if ( !qgsVariantEqual( a.at( i ), b.at( i ) ) )
36 return false;
37 }
38 return true;
39}
40
41
49
51{
52 return mIdentifierFields.value( 0 );
53}
54
55void QgsFeatureFilterModel::requestToReloadCurrentFeature( QgsFeatureRequest &request )
56{
57 QStringList conditions;
58 for ( int i = 0; i < mIdentifierFields.count(); i++ )
59 {
60 if ( i >= mExtraIdentifierValue.toList().count() )
61 {
62 conditions << QgsExpression::createFieldEqualityExpression( mIdentifierFields.at( i ), QVariant() );
63 }
64 else
65 {
66 conditions << QgsExpression::createFieldEqualityExpression( mIdentifierFields.at( i ), mExtraIdentifierValue.toList().at( i ) );
67 }
68 }
69 request.setFilterExpression( conditions.join( " AND "_L1 ) );
70}
71
73{
74 return QSet<QString>( mIdentifierFields.begin(), mIdentifierFields.end() );
75}
76
77QVariant QgsFeatureFilterModel::entryIdentifier( const QgsFeatureExpressionValuesGatherer::Entry &entry ) const
78{
79 return entry.featureId;
80}
81
82QgsFeatureExpressionValuesGatherer::Entry QgsFeatureFilterModel::createEntry( const QVariant &identifier ) const
83{
84 const QVariantList constValues = identifier.toList();
85
86 QStringList values;
87 for ( const QVariant &v : constValues )
88 values << u"(%1)"_s.arg( v.toString() );
89
90 return QgsFeatureExpressionValuesGatherer::Entry( constValues, values.join( ' '_L1 ), QgsFeature( sourceLayer() ? sourceLayer()->fields() : QgsFields() ) );
91}
92
93bool QgsFeatureFilterModel::compareEntries( const QgsFeatureExpressionValuesGatherer::Entry &a, const QgsFeatureExpressionValuesGatherer::Entry &b ) const
94{
95 return qVariantListCompare( a.identifierFields, b.identifierFields );
96}
97
98bool QgsFeatureFilterModel::identifierIsNull( const QVariant &identifier ) const
99{
100 const QVariantList values = identifier.toList();
101 for ( const QVariant &value : values )
102 {
103 if ( !QgsVariantUtils::isNull( value ) )
104 {
105 return false;
106 }
107 }
108 return true;
109}
110
112{
113 QVariantList nullValues;
114 for ( int i = 0; i < mIdentifierFields.count(); i++ )
115 nullValues << QgsVariantUtils::createNullVariant( QMetaType::Type::Int );
116 return nullValues;
117}
118
120{
121 return mIdentifierFields;
122}
123
124
126{
127 if ( mIdentifierFields == identifierFields )
128 return;
129
130 mIdentifierFields = identifierFields;
133}
134
135QgsFeatureExpressionValuesGatherer *QgsFeatureFilterModel::createValuesGatherer( const QgsFeatureRequest &request ) const
136{
137 return new QgsFeatureExpressionValuesGatherer( sourceLayer(), displayExpression(), orderExpression(), request, mIdentifierFields );
138}
139
140
142{
143 QVariantList values = mExtraIdentifierValue.toList();
144 if ( values.count() != mIdentifierFields.count() )
145 {
146 return nullIdentifier().toList();
147 }
148 return values;
149}
150
155
160
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:68
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:657
bool qVariantListCompare(const QVariantList &a, const QVariantList &b)