QGIS API Documentation 3.39.0-Master (3aed037ce22)
Loading...
Searching...
No Matches
qgswfsparameters.h
Go to the documentation of this file.
1/***************************************************************************
2 qgswfsparameters.h
3 ------------------
4 begin : Sept 14, 2017
5 copyright : (C) 2017 by René-Luc Dhont
6 email : rldhont at 3liz dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSWFSPARAMETERS_H
19#define QGSWFSPARAMETERS_H
20
21#include <QMap>
22#include <QMetaEnum>
23
24#include "qgsrectangle.h"
25#include "qgsprojectversion.h"
26#include "qgsserverparameters.h"
27
28namespace QgsWfs
29{
30
38 {
39 Q_GADGET
40
41 public:
60 Q_ENUM( Name )
61
62
69 const QMetaType::Type type = QMetaType::Type::QString,
70 const QVariant defaultValue = QVariant( "" ) );
71
72 virtual ~QgsWfsParameter() = default;
73
79 int toInt() const;
80
87 QStringList toStringListWithExp( const QString &exp = "\\(([^()]+)\\)" ) const;
88
95
100 void raiseError() const;
101
105 static QString name( const QgsWfsParameter::Name );
106
111 static QgsWfsParameter::Name name( const QString &name );
112
114 };
115
122 {
123 Q_GADGET
124
125 public:
126
135
138 {
140 HITS
141 };
142
147 QgsWfsParameters( const QgsServerParameters &parameters );
148
153
154 virtual ~QgsWfsParameters() = default;
155
159 void dump() const;
160
166
171 QString outputFormatAsString() const;
172
178 Format outputFormat() const;
179
184 QString resultTypeAsString() const;
185
191 ResultType resultType() const;
192
197 QStringList propertyNames() const;
198
203 QString maxFeatures() const;
204
212 int maxFeaturesAsInt() const;
213
218 QString startIndex() const;
219
227 int startIndexAsInt() const;
228
233 QString srsName() const;
234
239 QStringList typeNames() const;
240
245 QStringList featureIds() const;
246
251 QStringList filters() const;
252
257 QString bbox() const;
258
266
271 QStringList sortBy() const;
272
277 QStringList expFilters() const;
278
283 QString geometryNameAsString() const;
284
285 private:
286 bool loadParameter( const QString &key, const QString &value ) override;
287 void save( const QgsWfsParameter &parameter );
288
289 void log( const QString &msg ) const;
290
291 QList<QgsProjectVersion> mVersions;
292 QMap<QgsWfsParameter::Name, QgsWfsParameter> mWfsParameters;
293 };
294}
295
296#endif
A class to describe the version of a project.
A rectangle specified with double values.
Definition of a parameter with basic conversion methods.
QgsServerParameters provides an interface to retrieve and manipulate global parameters received from ...
QString value(const QString &key) const
Returns the value of a parameter.
WFS parameter received from the client.
virtual ~QgsWfsParameter()=default
QgsWfsParameter::Name mName
Name
Available parameters for WFS requests.
int toInt() const
Converts the parameter into an integer.
QStringList toStringListWithExp(const QString &exp="\\‍(([^()]+)\\‍)") const
Converts the parameter into a list of string.
void raiseError() const
Raises an error in case of an invalid conversion.
QgsRectangle toRectangle() const
Converts the parameter into a rectangle.
static QString name(const QgsWfsParameter::Name)
Converts a parameter's name into its string representation.
Provides an interface to retrieve and manipulate WFS parameters received from the client.
QgsWfsParameters()
Constructor for WFS parameters with default values only.
int startIndexAsInt() const
Returns STARTINDEX parameter as an int or its default value if not defined.
QString geometryNameAsString() const
Returns GEOMETRYNAME parameter as a string.
QStringList sortBy() const
Returns SORTBY parameter as list.
QStringList typeNames() const
Returns TYPENAME parameter as list.
QStringList expFilters() const
Returns EXP_FILTER parameter as list.
QString maxFeatures() const
Returns MAXFEATURES parameter as a string.
QStringList filters() const
Returns FILTER parameter as list.
QString srsName() const
Returns SRSNAME parameter as a string.
QString resultTypeAsString() const
Returns RESULTTYPE parameter as a string.
int maxFeaturesAsInt() const
Returns MAXFEATURES parameter as an int or its default value if not defined.
QString bbox() const
Returns BBOX if defined or an empty string.
void dump() const
Dumps parameters.
virtual ~QgsWfsParameters()=default
QString outputFormatAsString() const
Returns OUTPUTFORMAT parameter as a string.
ResultType resultType() const
Returns resultType.
QgsProjectVersion versionAsNumber() const
Returns VERSION parameter if defined or its default value.
QStringList featureIds() const
Returns FEATUREID parameter as list.
QString startIndex() const
Returns STARTINDEX parameter as a string.
Format
Output format for the response.
QgsRectangle bboxAsRectangle() const
Returns BBOX as a rectangle if defined and valid.
QStringList propertyNames() const
Returns PROPERTYNAME parameter as list.
Format outputFormat() const
Returns format.
WMS implementation.
Definition qgswfs.cpp:36