QGIS API Documentation 3.41.0-Master (af5edcb665c)
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
68 QgsWfsParameter( const QgsWfsParameter::Name name = QgsWfsParameter::UNKNOWN, const QMetaType::Type type = QMetaType::Type::QString, const QVariant defaultValue = QVariant( "" ) );
69
70 virtual ~QgsWfsParameter() = default;
71
77 int toInt() const;
78
85 QStringList toStringListWithExp( const QString &exp = "\\(([^()]+)\\)" ) const;
86
93
98 void raiseError() const;
99
103 static QString name( const QgsWfsParameter::Name );
104
109 static QgsWfsParameter::Name name( const QString &name );
110
112 };
113
120 {
121 Q_GADGET
122
123 public:
132
135 {
137 HITS
138 };
139
144 QgsWfsParameters( const QgsServerParameters &parameters );
145
150
151 virtual ~QgsWfsParameters() = default;
152
156 void dump() const;
157
163
168 QString outputFormatAsString() const;
169
175 Format outputFormat() const;
176
181 QString resultTypeAsString() const;
182
188 ResultType resultType() const;
189
194 QStringList propertyNames() const;
195
200 QString maxFeatures() const;
201
209 int maxFeaturesAsInt() const;
210
215 QString startIndex() const;
216
224 int startIndexAsInt() const;
225
230 QString srsName() const;
231
236 QStringList typeNames() const;
237
242 QStringList featureIds() const;
243
248 QStringList filters() const;
249
254 QString bbox() const;
255
263
268 QStringList sortBy() const;
269
274 QStringList expFilters() const;
275
280 QString geometryNameAsString() const;
281
282 private:
283 bool loadParameter( const QString &key, const QString &value ) override;
284 void save( const QgsWfsParameter &parameter );
285
286 void log( const QString &msg ) const;
287
288 QList<QgsProjectVersion> mVersions;
289 QMap<QgsWfsParameter::Name, QgsWfsParameter> mWfsParameters;
290 };
291} // namespace QgsWfs
292
293#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