QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgssearchquerybuilder.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgssearchquerybuilder.cpp - Query builder for search strings
3 ----------------------
4 begin : March 2006
5 copyright : (C) 2006 by Martin Dobias
6 email : wonder.sk at gmail dot com
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 ***************************************************************************/
15
16#include <QDomDocument>
17#include <QDomElement>
18#include <QFileDialog>
19#include <QFileInfo>
20#include <QInputDialog>
21#include <QListView>
22#include <QMessageBox>
23#include <QStandardItem>
24#include <QTextStream>
25
26#include "qgsfeature.h"
27#include "qgsfeatureiterator.h"
28#include "qgsfields.h"
30#include "qgsexpression.h"
31#include "qgsvectorlayer.h"
32#include "qgshelp.h"
34#include "qgsquerybuilder.h"
35
36
38 QWidget *parent, Qt::WindowFlags fl )
39 : QDialog( parent, fl )
40 , mLayer( layer )
41{
42 setupUi( this );
43 connect( btnEqual, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnEqual_clicked );
44 connect( btnLessThan, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnLessThan_clicked );
45 connect( btnGreaterThan, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnGreaterThan_clicked );
46 connect( btnLike, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnLike_clicked );
47 connect( btnILike, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnILike_clicked );
48 connect( btnPct, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnPct_clicked );
49 connect( btnIn, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnIn_clicked );
50 connect( btnNotIn, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnNotIn_clicked );
51 connect( lstFields, &QListView::doubleClicked, this, &QgsSearchQueryBuilder::lstFields_doubleClicked );
52 connect( lstValues, &QListView::doubleClicked, this, &QgsSearchQueryBuilder::lstValues_doubleClicked );
53 connect( btnLessEqual, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnLessEqual_clicked );
54 connect( btnGreaterEqual, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnGreaterEqual_clicked );
55 connect( btnNotEqual, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnNotEqual_clicked );
56 connect( btnAnd, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnAnd_clicked );
57 connect( btnNot, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnNot_clicked );
58 connect( btnOr, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnOr_clicked );
59 connect( btnGetAllValues, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnGetAllValues_clicked );
60 connect( btnSampleValues, &QPushButton::clicked, this, &QgsSearchQueryBuilder::btnSampleValues_clicked );
61 setupListViews();
62 connect( buttonBox, &QDialogButtonBox::helpRequested, this, &QgsSearchQueryBuilder::showHelp );
63
64 setWindowTitle( tr( "Search Query Builder" ) );
65
66 QPushButton *pbn = new QPushButton( tr( "&Test" ) );
67 buttonBox->addButton( pbn, QDialogButtonBox::ActionRole );
68 connect( pbn, &QAbstractButton::clicked, this, &QgsSearchQueryBuilder::btnTest_clicked );
69
70 pbn = new QPushButton( tr( "&Clear" ) );
71 buttonBox->addButton( pbn, QDialogButtonBox::ActionRole );
72 connect( pbn, &QAbstractButton::clicked, this, &QgsSearchQueryBuilder::btnClear_clicked );
73
74 pbn = new QPushButton( tr( "&Save…" ) );
75 buttonBox->addButton( pbn, QDialogButtonBox::ActionRole );
76 pbn->setToolTip( tr( "Save query to an xml file" ) );
77 connect( pbn, &QAbstractButton::clicked, this, &QgsSearchQueryBuilder::saveQuery );
78
79 pbn = new QPushButton( tr( "&Load…" ) );
80 buttonBox->addButton( pbn, QDialogButtonBox::ActionRole );
81 pbn->setToolTip( tr( "Load query from xml file" ) );
82 connect( pbn, &QAbstractButton::clicked, this, &QgsSearchQueryBuilder::loadQuery );
83
84 if ( layer )
85 lblDataUri->setText( layer->name() );
86 populateFields();
87}
88
89void QgsSearchQueryBuilder::populateFields()
90{
91 if ( !mLayer )
92 return;
93
94 const QgsFields &fields = mLayer->fields();
95 for ( int idx = 0; idx < fields.count(); ++idx )
96 {
97 const QString fieldName = fields.at( idx ).name();
98 mFieldMap[fieldName] = idx;
99 QStandardItem *myItem = new QStandardItem( fieldName );
100 myItem->setEditable( false );
101 mModelFields->insertRow( mModelFields->rowCount(), myItem );
102 }
103}
104
105void QgsSearchQueryBuilder::setupListViews()
106{
107 //Models
108 mModelFields = new QStandardItemModel();
109 mModelValues = new QStandardItemModel();
110 lstFields->setModel( mModelFields );
111 lstValues->setModel( mModelValues );
112 // Modes
113 lstFields->setViewMode( QListView::ListMode );
114 lstValues->setViewMode( QListView::ListMode );
115 lstFields->setSelectionBehavior( QAbstractItemView::SelectRows );
116 lstValues->setSelectionBehavior( QAbstractItemView::SelectRows );
117 // Performance tip since Qt 4.1
118 lstFields->setUniformItemSizes( true );
119 lstValues->setUniformItemSizes( true );
120}
121
122void QgsSearchQueryBuilder::getFieldValues( int limit )
123{
124 if ( !mLayer )
125 {
126 return;
127 }
128 // clear the values list
129 mModelValues->clear();
130
131 // determine the field type
132 const QString fieldName = mModelFields->data( lstFields->currentIndex() ).toString();
133 const int fieldIndex = mFieldMap[fieldName];
134 const QgsField field = mLayer->fields().at( fieldIndex );//provider->fields().at( fieldIndex );
135 const bool numeric = ( field.type() == QVariant::Int || field.type() == QVariant::Double );
136
137 QgsFeature feat;
138 QString value;
139
140 QgsAttributeList attrs;
141 attrs.append( fieldIndex );
142
144
145 lstValues->setCursor( Qt::WaitCursor );
146 // Block for better performance
147 mModelValues->blockSignals( true );
148 lstValues->setUpdatesEnabled( false );
149
150 // MH: keep already inserted values in a set. Querying is much faster compared to QStandardItemModel::findItems
151 QSet<QString> insertedValues;
152
153 while ( fit.nextFeature( feat ) &&
154 ( limit == 0 || mModelValues->rowCount() != limit ) )
155 {
156 value = feat.attribute( fieldIndex ).toString();
157
158 if ( !numeric )
159 {
160 // put string in single quotes and escape single quotes in the string
161 value = '\'' + value.replace( '\'', QLatin1String( "''" ) ) + '\'';
162 }
163
164 // add item only if it's not there already
165 if ( !insertedValues.contains( value ) )
166 {
167 QStandardItem *myItem = new QStandardItem( value );
168 myItem->setEditable( false );
169 mModelValues->insertRow( mModelValues->rowCount(), myItem );
170 insertedValues.insert( value );
171 }
172 }
173 // Unblock for normal use
174 mModelValues->blockSignals( false );
175 lstValues->setUpdatesEnabled( true );
176 // TODO: already sorted, signal emit to refresh model
177 mModelValues->sort( 0 );
178 lstValues->setCursor( Qt::ArrowCursor );
179}
180
181void QgsSearchQueryBuilder::btnSampleValues_clicked()
182{
183 getFieldValues( 25 );
184}
185
186void QgsSearchQueryBuilder::btnGetAllValues_clicked()
187{
188 getFieldValues( 0 );
189}
190
191void QgsSearchQueryBuilder::btnTest_clicked()
192{
193 const long count = countRecords( mTxtSql->text() );
194
195 // error?
196 if ( count == -1 )
197 return;
198
199 QMessageBox::information( this, tr( "Test Query" ), tr( "Found %n matching feature(s).", "test result", count ) );
200}
201
202// This method tests the number of records that would be returned
203long QgsSearchQueryBuilder::countRecords( const QString &searchString )
204{
205 QgsExpression search( searchString );
206 if ( search.hasParserError() )
207 {
208 QMessageBox::critical( this, tr( "Query Result" ), search.parserErrorString() );
209 return -1;
210 }
211
212 if ( !mLayer )
213 return -1;
214
215 const bool fetchGeom = search.needsGeometry();
216
217 int count = 0;
218 QgsFeature feat;
219
221
222 if ( !search.prepare( &context ) )
223 {
224 QMessageBox::critical( this, tr( "Query Result" ), search.evalErrorString() );
225 return -1;
226 }
227
228 QApplication::setOverrideCursor( Qt::WaitCursor );
229
231
232 while ( fit.nextFeature( feat ) )
233 {
234 context.setFeature( feat );
235 const QVariant value = search.evaluate( &context );
236 if ( value.toInt() != 0 )
237 {
238 count++;
239 }
240
241 // check if there were errors during evaluating
242 if ( search.hasEvalError() )
243 break;
244 }
245
246 QApplication::restoreOverrideCursor();
247
248 if ( search.hasEvalError() )
249 {
250 QMessageBox::critical( this, tr( "Query Result" ), search.evalErrorString() );
251 return -1;
252 }
253
254 return count;
255}
256
257
258void QgsSearchQueryBuilder::btnOk_clicked()
259{
260 // if user hits OK and there is no query, skip the validation
261 if ( mTxtSql->text().trimmed().length() > 0 )
262 {
263 accept();
264 return;
265 }
266
267 // test the query to see if it will result in a valid layer
268 const long numRecs = countRecords( mTxtSql->text() );
269 if ( numRecs == -1 )
270 {
271 // error shown in countRecords
272 }
273 else if ( numRecs == 0 )
274 {
275 QMessageBox::warning( this, tr( "Query Result" ), tr( "The query you specified results in zero records being returned." ) );
276 }
277 else
278 {
279 accept();
280 }
281
282}
283
284void QgsSearchQueryBuilder::btnEqual_clicked()
285{
286 mTxtSql->insertText( QStringLiteral( " = " ) );
287}
288
289void QgsSearchQueryBuilder::btnLessThan_clicked()
290{
291 mTxtSql->insertText( QStringLiteral( " < " ) );
292}
293
294void QgsSearchQueryBuilder::btnGreaterThan_clicked()
295{
296 mTxtSql->insertText( QStringLiteral( " > " ) );
297}
298
299void QgsSearchQueryBuilder::btnPct_clicked()
300{
301 mTxtSql->insertText( QStringLiteral( "%" ) );
302}
303
304void QgsSearchQueryBuilder::btnIn_clicked()
305{
306 mTxtSql->insertText( QStringLiteral( " IN " ) );
307}
308
309void QgsSearchQueryBuilder::btnNotIn_clicked()
310{
311 mTxtSql->insertText( QStringLiteral( " NOT IN " ) );
312}
313
314void QgsSearchQueryBuilder::btnLike_clicked()
315{
316 mTxtSql->insertText( QStringLiteral( " LIKE " ) );
317}
318
320{
321 return mTxtSql->text();
322}
323
324void QgsSearchQueryBuilder::setSearchString( const QString &searchString )
325{
326 mTxtSql->setText( searchString );
327}
328
329void QgsSearchQueryBuilder::lstFields_doubleClicked( const QModelIndex &index )
330{
331 mTxtSql->insertText( QgsExpression::quotedColumnRef( mModelFields->data( index ).toString() ) );
332}
333
334void QgsSearchQueryBuilder::lstValues_doubleClicked( const QModelIndex &index )
335{
336 mTxtSql->insertText( mModelValues->data( index ).toString() );
337}
338
339void QgsSearchQueryBuilder::btnLessEqual_clicked()
340{
341 mTxtSql->insertText( QStringLiteral( " <= " ) );
342}
343
344void QgsSearchQueryBuilder::btnGreaterEqual_clicked()
345{
346 mTxtSql->insertText( QStringLiteral( " >= " ) );
347}
348
349void QgsSearchQueryBuilder::btnNotEqual_clicked()
350{
351 mTxtSql->insertText( QStringLiteral( " != " ) );
352}
353
354void QgsSearchQueryBuilder::btnAnd_clicked()
355{
356 mTxtSql->insertText( QStringLiteral( " AND " ) );
357}
358
359void QgsSearchQueryBuilder::btnNot_clicked()
360{
361 mTxtSql->insertText( QStringLiteral( " NOT " ) );
362}
363
364void QgsSearchQueryBuilder::btnOr_clicked()
365{
366 mTxtSql->insertText( QStringLiteral( " OR " ) );
367}
368
369void QgsSearchQueryBuilder::btnClear_clicked()
370{
371 mTxtSql->clear();
372}
373
374void QgsSearchQueryBuilder::btnILike_clicked()
375{
376 mTxtSql->insertText( QStringLiteral( " ILIKE " ) );
377}
378
380{
381 QgsQueryBuilder::saveQueryToFile( mTxtSql->text() );
382}
383
385{
386 QString query;
388 {
389 mTxtSql->clear();
390 mTxtSql->insertText( query );
391 }
392}
393
394void QgsSearchQueryBuilder::showHelp()
395{
396 QgsHelp::openHelp( QStringLiteral( "working_with_vector/vector_properties.html#query-builder" ) );
397}
@ NoGeometry
Geometry is not required. It may still be returned if e.g. required for a filter condition.
@ NoFlags
No flags are set.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
Class for parsing and evaluation of expressions (formerly called "search strings").
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes)
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFlags(Qgis::FeatureRequestFlags flags)
Sets flags that affect how features will be fetched.
QgsFeatureRequest & setSubsetOfAttributes(const QgsAttributeList &attrs)
Set a subset of attributes that will be fetched.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
QVariant attribute(const QString &name) const
Lookup attribute value by attribute name.
Definition: qgsfeature.cpp:335
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:53
QString name
Definition: qgsfield.h:62
QVariant::Type type
Definition: qgsfield.h:60
Container of fields for a vector layer.
Definition: qgsfields.h:45
int count() const
Returns number of items.
Definition: qgsfields.cpp:133
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
Definition: qgsfields.cpp:163
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Definition: qgshelp.cpp:39
QString name
Definition: qgsmaplayer.h:78
static bool loadQueryFromFile(QString &subset)
Load query from the XML file.
static bool saveQueryToFile(const QString &subset)
Save query to the XML file.
QgsSearchQueryBuilder(QgsVectorLayer *layer, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
Constructor - takes pointer to vector layer as a parameter.
void setSearchString(const QString &searchString)
change search string shown in text field
QString searchString()
returns newly created search string
Represents a vector layer which manages a vector based data sets.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
QList< int > QgsAttributeList
Definition: qgsfield.h:27