QGIS API Documentation  3.4.3-Madeira (2f64a3c)
qgsjsonutils.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsjsonutils.h
3  -------------
4  Date : May 206
5  Copyright : (C) 2016 Nyall Dawson
6  Email : nyall dot dawson 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 #ifndef QGSJSONUTILS_H
17 #define QGSJSONUTILS_H
18 
19 #include "qgis_core.h"
20 #include "qgsfeature.h"
22 #include "qgscoordinatetransform.h"
23 #include "qgsfields.h"
24 
25 #include <QPointer>
26 
27 class QTextCodec;
28 
39 class CORE_EXPORT QgsJsonExporter
40 {
41  public:
42 
49  QgsJsonExporter( QgsVectorLayer *vectorLayer = nullptr, int precision = 6 );
50 
57  void setPrecision( int precision ) { mPrecision = precision; }
58 
63  int precision() const { return mPrecision; }
64 
70  void setIncludeGeometry( bool includeGeometry ) { mIncludeGeometry = includeGeometry; }
71 
76  bool includeGeometry() const { return mIncludeGeometry; }
77 
83  void setIncludeAttributes( bool includeAttributes ) { mIncludeAttributes = includeAttributes; }
84 
89  bool includeAttributes() const { return mIncludeAttributes; }
90 
98  void setIncludeRelated( bool includeRelated ) { mIncludeRelatedAttributes = includeRelated; }
99 
104  bool includeRelated() const { return mIncludeRelatedAttributes; }
105 
112  void setVectorLayer( QgsVectorLayer *vectorLayer );
113 
118  QgsVectorLayer *vectorLayer() const;
119 
127  void setSourceCrs( const QgsCoordinateReferenceSystem &crs );
128 
134  QgsCoordinateReferenceSystem sourceCrs() const;
135 
145  void setAttributes( const QgsAttributeList &attributes ) { mAttributeIndexes = attributes; }
146 
155  QgsAttributeList attributes() const { return mAttributeIndexes; }
156 
164  void setExcludedAttributes( const QgsAttributeList &attributes ) { mExcludedAttributeIndexes = attributes; }
165 
172  QgsAttributeList excludedAttributes() const { return mExcludedAttributeIndexes; }
173 
183  QString exportFeature( const QgsFeature &feature,
184  const QVariantMap &extraProperties = QVariantMap(),
185  const QVariant &id = QVariant() ) const;
186 
187 
194  QString exportFeatures( const QgsFeatureList &features ) const;
195 
196  private:
197 
199  int mPrecision;
200 
205  QgsAttributeList mAttributeIndexes;
206 
208  QgsAttributeList mExcludedAttributeIndexes;
209 
211  bool mIncludeGeometry = true;
212 
214  bool mIncludeAttributes = true;
215 
217  bool mIncludeRelatedAttributes = false;
218 
220  QPointer< QgsVectorLayer > mLayer;
221 
223 
224  QgsCoordinateTransform mTransform;
225 
226 };
227 
235 class CORE_EXPORT QgsJsonUtils
236 {
237  public:
238 
248  static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding );
249 
258  static QgsFields stringToFields( const QString &string, QTextCodec *encoding );
259 
266  static QString encodeValue( const QVariant &value );
267 
276  static QString exportAttributes( const QgsFeature &feature, QgsVectorLayer *layer = nullptr,
277  const QVector<QVariant> &attributeWidgetCaches = QVector<QVariant>() );
278 
285  static QVariantList parseArray( const QString &json, QVariant::Type type );
286 };
287 
288 #endif // QGSJSONUTILS_H
QgsAttributeList excludedAttributes() const
Returns a list of attributes which will be specifically excluded from the JSON exports.
Definition: qgsjsonutils.h:172
int precision
bool includeRelated() const
Returns whether attributes of related (child) features will be included in the JSON exports...
Definition: qgsjsonutils.h:104
void setIncludeAttributes(bool includeAttributes)
Sets whether to include attributes in the JSON exports.
Definition: qgsjsonutils.h:83
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:571
void setIncludeGeometry(bool includeGeometry)
Sets whether to include geometry in the JSON exports.
Definition: qgsjsonutils.h:70
Helper utilities for working with JSON and GeoJSON conversions.
Definition: qgsjsonutils.h:235
Container of fields for a vector layer.
Definition: qgsfields.h:42
bool includeAttributes() const
Returns whether attributes will be included in the JSON exports.
Definition: qgsjsonutils.h:89
int precision() const
Returns the maximum number of decimal places to use in geometry coordinates.
Definition: qgsjsonutils.h:63
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
const QgsCoordinateReferenceSystem & crs
void setAttributes(const QgsAttributeList &attributes)
Sets the list of attributes to include in the JSON exports.
Definition: qgsjsonutils.h:145
void setExcludedAttributes(const QgsAttributeList &attributes)
Sets a list of attributes to specifically exclude from the JSON exports.
Definition: qgsjsonutils.h:164
QgsAttributeList attributes() const
Returns the list of attributes which will be included in the JSON exports, or an empty list if all at...
Definition: qgsjsonutils.h:155
void setIncludeRelated(bool includeRelated)
Sets whether to include attributes of features linked via references in the JSON exports.
Definition: qgsjsonutils.h:98
Handles exporting QgsFeature features to GeoJSON features.
Definition: qgsjsonutils.h:39
bool includeGeometry() const
Returns whether geometry will be included in the JSON exports.
Definition: qgsjsonutils.h:76
This class represents a coordinate reference system (CRS).
Class for doing transforms between two map coordinate systems.
QList< int > QgsAttributeList
Definition: qgsfield.h:27
void setPrecision(int precision)
Sets the maximum number of decimal places to use in geometry coordinates.
Definition: qgsjsonutils.h:57
Represents a vector layer which manages a vector based data sets.