qgsjsonutils.h

Go to the documentation of this file.

/***************************************************************************
    qgsjsonutils.h
     -------------
    Date                 : May 206
    Copyright            : (C) 2016 Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSJSONUTILS_H
#define QGSJSONUTILS_H
 
#include "qgis_core.h"
#include "qgscoordinatereferencesystem.h"
#include "qgscoordinatetransform.h"
#include "qgsfeature.h"
#include "qgsfields.h"
 
#include <QJsonObject>
#include <QPointer>
 
#ifndef SIP_RUN
#include <nlohmann/json_fwd.hpp>
using namespace nlohmann;
#endif
 
class QTextCodec;

 
class CORE_EXPORT QgsJsonExporter
{
  public:
    QgsJsonExporter( QgsVectorLayer *vectorLayer = nullptr, int precision = 6 );

    void setPrecision( int precision ) { mPrecision = precision; }

    int precision() const { return mPrecision; }

    void setIncludeGeometry( bool includeGeometry ) { mIncludeGeometry = includeGeometry; }

    bool includeGeometry() const { return mIncludeGeometry; }

    void setIncludeAttributes( bool includeAttributes ) { mIncludeAttributes = includeAttributes; }

    bool includeAttributes() const { return mIncludeAttributes; }

    void setIncludeRelated( bool includeRelated ) { mIncludeRelatedAttributes = includeRelated; }

    bool includeRelated() const { return mIncludeRelatedAttributes; }

    void setAttributeDisplayName( bool displayName ) { mAttributeDisplayName = displayName; }

 
    bool attributeDisplayName() const { return mAttributeDisplayName; }

    void setVectorLayer( QgsVectorLayer *vectorLayer );

    QgsVectorLayer *vectorLayer() const;

    void setSourceCrs( const QgsCoordinateReferenceSystem &crs );

    QgsCoordinateReferenceSystem sourceCrs() const;

    void setTransformGeometries( bool activate ) { mTransformGeometries = activate; }

    void setAttributes( const QgsAttributeList &attributes ) { mAttributeIndexes = attributes; }

    QgsAttributeList attributes() const { return mAttributeIndexes; }

    void setExcludedAttributes( const QgsAttributeList &attributes ) { mExcludedAttributeIndexes = attributes; }

    QgsAttributeList excludedAttributes() const { return mExcludedAttributeIndexes; }

    void setUseFieldFormatters( bool useFieldFormatters ) { mUseFieldFormatters = useFieldFormatters; }

    bool useFieldFormatters() const { return mUseFieldFormatters; }

    QString exportFeature(
      const QgsFeature &feature, const QVariantMap &extraProperties = QVariantMap(), const QVariant &id = QVariant(), int indent = -1, const QVariantMap &extraMembers = QVariantMap()
    ) const;

    json exportFeatureToJsonObject( const QgsFeature &feature, const QVariantMap &extraProperties = QVariantMap(), const QVariant &id = QVariant(), const QVariantMap &extraMembers = QVariantMap() ) const
      SIP_SKIP;

    QString exportFeatures( const QgsFeatureList &features, int indent = -1 ) const;

    json exportFeaturesToJsonObject( const QgsFeatureList &features ) const SIP_SKIP;

    void setDestinationCrs( const QgsCoordinateReferenceSystem &destinationCrs );

    Qgis::GeoJsonProfile geoJsonProfile() const;

    void setGeoJsonProfile( Qgis::GeoJsonProfile profile );
 
  private:
    int mPrecision;

    QgsAttributeList mAttributeIndexes;

    QgsAttributeList mExcludedAttributeIndexes;

    bool mIncludeGeometry = true;

    bool mIncludeAttributes = true;

    bool mIncludeRelatedAttributes = false;

    QPointer< QgsVectorLayer > mLayer;
 
    QgsCoordinateReferenceSystem mCrs;
 
    QgsCoordinateTransform mTransform;
 
    bool mAttributeDisplayName = false;
 
    bool mTransformGeometries = true;
 
    QgsCoordinateReferenceSystem mDestinationCrs;
 
    bool mUseFieldFormatters = true;

    mutable bool mOmitCollectionLevelInformation = false;
 
    Qgis::GeoJsonProfile mGeoJsonProfile = Qgis::GeoJsonProfile::Legacy;
};

 
class CORE_EXPORT QgsJsonUtils
{
    Q_GADGET
 
  public:
    static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields = QgsFields(), QTextCodec *encoding SIP_PYARGREMOVE6 = nullptr );

    static QgsFields stringToFields( const QString &string, QTextCodec *encoding SIP_PYARGREMOVE6 = nullptr );

    Q_INVOKABLE static QString encodeValue( const QVariant &value );

    static QString exportAttributes( const QgsFeature &feature, QgsVectorLayer *layer = nullptr, const QVector<QVariant> &attributeWidgetCaches = QVector<QVariant>() );

    static json exportAttributesToJsonObject( const QgsFeature &feature, QgsVectorLayer *layer = nullptr, const QVector<QVariant> &attributeWidgetCaches = QVector<QVariant>(), bool useFieldFormatters = true )
      SIP_SKIP;

    Q_INVOKABLE static QVariantList parseArray( const QString &json, QMetaType::Type type = QMetaType::Type::UnknownType );

    Q_INVOKABLE Q_DECL_DEPRECATED static QVariantList parseArray( const QString &json, QVariant::Type type ) SIP_DEPRECATED;

    static QgsGeometry geometryFromGeoJson( const json &geometry ) SIP_SKIP;

    static QgsGeometry geometryFromGeoJson( const QString &geometry );

    static QVariant geometryToGeoJsonVariant( const QgsGeometry &geometry );

    static json jsonFromVariant( const QVariant &v ) SIP_SKIP;

    static QVariant parseJson( const std::string &jsonString ) SIP_SKIP;

    static QVariant parseJson( const std::string &jsonString, QString &error ) SIP_SKIP;

    static QVariant parseJson( const QString &jsonString ) SIP_SKIP;

    static QVariant jsonToVariant( const json &value ) SIP_SKIP;

    static void addCrsInfo( json &value, const QgsCoordinateReferenceSystem &crs, Qgis::GeoJsonProfile profile = Qgis::GeoJsonProfile::Legacy ) SIP_SKIP;
};
 
#endif // QGSJSONUTILS_H