qgsmaplayerserverproperties.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmaplayerserverproperties.h
                             ------------------
  begin                : June 21, 2021
  copyright            : (C) 2021 by Etienne Trimaille
  email                : etrimaille at 3liz 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 QGSMAPLAYERSERVERPROPERTIES_H
#define QGSMAPLAYERSERVERPROPERTIES_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QMap>
#include <QMetaType>
#include <QString>
#include <QVariant>
 
class QgsMapLayer;
 
class QDomNode;
class QDomDocument;

class CORE_EXPORT QgsServerMetadataUrlProperties
{
    Q_GADGET
 
  public:
    struct CORE_EXPORT MetadataUrl
    {
        MetadataUrl( const QString &url = QString(), const QString &type = QString(), const QString &format = QString() )
          : url( url )
          , type( type )
          , format( format )
        {}

        QString url;

        QString type;

        QString format;
 
        // TODO c++20 - replace with = default

        bool operator==( const QgsServerMetadataUrlProperties::MetadataUrl &other ) const;
    };
 
    virtual ~QgsServerMetadataUrlProperties() = default;

    QList<QgsServerMetadataUrlProperties::MetadataUrl> metadataUrls() const { return mMetadataUrls; };

    void setMetadataUrls( const QList<QgsServerMetadataUrlProperties::MetadataUrl> &metaUrls ) { mMetadataUrls = metaUrls; };

    void addMetadataUrl( const QgsServerMetadataUrlProperties::MetadataUrl &metaUrl ) { mMetadataUrls << metaUrl; };

    virtual const QgsMapLayer *layer() const = 0;
 
    // TODO c++20 - replace with = default
 
    bool operator==( const QgsServerMetadataUrlProperties &other ) const;
    bool operator!=( const QgsServerMetadataUrlProperties &other ) const;
 
  protected:
    void writeXml( QDomNode &layerNode, QDomDocument &document ) const SIP_SKIP;

    void readXml( const QDomNode &layerNode ) SIP_SKIP;

    void copyTo( QgsServerMetadataUrlProperties *properties ) const SIP_SKIP;

    void reset() SIP_SKIP;
 
  private:
    QList<MetadataUrl> mMetadataUrls;
};
 

class CORE_EXPORT QgsServerWmsDimensionProperties
{
    Q_GADGET
 
  public:
    enum PredefinedWmsDimensionName
    {
      TIME,
      DATE,
      ELEVATION
    };
    Q_ENUM( PredefinedWmsDimensionName )
 
    SIP_SKIP static constexpr const char *TIME_DIMENSION_NAME = "TIME";

    struct CORE_EXPORT WmsDimensionInfo
    {
        explicit WmsDimensionInfo(
          const QString &dimName,
          const QString &dimFieldName,
          const QString &dimEndFieldName = QString(),
          const QString &dimUnits = QString(),
          const QString &dimUnitSymbol = QString(),
          Qgis::WmsDimensionDefaultDisplay dimDefaultDisplayType = Qgis::WmsDimensionDefaultDisplay::AllValues,
          const QVariant &dimReferenceValue = QVariant()
        )
          : name( dimName )
          , fieldName( dimFieldName )
          , endFieldName( dimEndFieldName )
          , units( dimUnits )
          , unitSymbol( dimUnitSymbol )
          , defaultDisplayType( dimDefaultDisplayType )
          , mReferenceValue( dimReferenceValue )
        {}

        explicit WmsDimensionInfo(
          const QString &dimName, Qgis::WmsDimensionDefaultDisplay dimDefaultDisplayType = Qgis::WmsDimensionDefaultDisplay::AllValues, const QVariant &dimReferenceValue = QVariant()
        )
          : name( dimName )
          , defaultDisplayType( dimDefaultDisplayType )
          , mReferenceValue( dimReferenceValue )
        {}
 
        bool operator==( const WmsDimensionInfo &other ) const;
        bool operator!=( const WmsDimensionInfo &other ) const;

        QVariant referenceValue() const SIP_PYNAME( _referenceValue ) { return mReferenceValue; }

        void setReferenceValue( const QVariant &referenceValue ) { mReferenceValue = referenceValue; }
 
 
        QString name;
        QString fieldName;
        QString endFieldName;
        QString units;
        QString unitSymbol;
        Qgis::WmsDimensionDefaultDisplay defaultDisplayType;
 
      private:
        QVariant mReferenceValue;
    };
 
    virtual ~QgsServerWmsDimensionProperties() = default;
 
    // TODO c++20 - replace with = default
 
    bool operator==( const QgsServerWmsDimensionProperties &other ) const;
    bool operator!=( const QgsServerWmsDimensionProperties &other ) const;

    static QMap<int, QString> wmsDimensionDefaultDisplayLabels();

    static QMap<Qgis::WmsDimensionDefaultDisplay, QString> wmsDimensionDefaultDisplayDescriptions() SIP_SKIP;

    bool addWmsDimension( const QgsServerWmsDimensionProperties::WmsDimensionInfo &wmsDimInfo );

    bool removeWmsDimension( const QString &wmsDimName );

    void setWmsDimensions( const QList<QgsServerWmsDimensionProperties::WmsDimensionInfo> &dimensions );

    const QList<QgsServerWmsDimensionProperties::WmsDimensionInfo> wmsDimensions() const;

    virtual const QgsMapLayer *layer() const = 0;
 
  protected:
    void writeXml( QDomNode &layer_node, QDomDocument &document ) const SIP_SKIP;

    void readXml( const QDomNode &layer_node ) SIP_SKIP;

    void copyTo( QgsServerWmsDimensionProperties *properties ) const SIP_SKIP;

    void reset() SIP_SKIP;
 
  private: // Private attributes
    QList<WmsDimensionInfo> mWmsDimensions;
};
 

class CORE_EXPORT QgsMapLayerServerProperties : public QgsServerMetadataUrlProperties, public QgsServerWmsDimensionProperties
{
    Q_GADGET
 
  public:
    QgsMapLayerServerProperties( QgsMapLayer *layer = nullptr );
 
    // TODO c++20 - replace with = default
 
    bool operator==( const QgsMapLayerServerProperties &other ) const;
    bool operator!=( const QgsMapLayerServerProperties &other ) const;

    void copyTo( QgsMapLayerServerProperties *properties ) const;

    void writeXml( QDomNode &layer_node, QDomDocument &document ) const; // cppcheck-suppress duplInheritedMember

    void readXml( const QDomNode &layer_node ); // cppcheck-suppress duplInheritedMember

    void reset(); // cppcheck-suppress duplInheritedMember

    void setShortName( const QString &name ) { mShortName = name; }

    QString shortName() const { return mShortName; }

    QString wfsTypeName() const;

    void setTitle( const QString &title ) { mTitle = title; }

    void setWfsTitle( const QString &title ) { mWfsTitle = title; }

    QString title() const { return mTitle; }

    QString wfsTitle() const { return mWfsTitle.isEmpty() ? mTitle : mWfsTitle; }

    void setAbstract( const QString &abstract ) { mAbstract = abstract; }

    QString abstract() const { return mAbstract; }

    void setKeywordList( const QString &keywords ) { mKeywordList = keywords; }

    QString keywordList() const { return mKeywordList; }

    void setDataUrl( const QString &dataUrl ) { mDataUrl = dataUrl; }

    QString dataUrl() const { return mDataUrl; }

    void setDataUrlFormat( const QString &dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; }

    QString dataUrlFormat() const { return mDataUrlFormat; }

    void setAttribution( const QString &attrib ) { mAttribution = attrib; }

    QString attribution() const { return mAttribution; }

    void setAttributionUrl( const QString &url ) { mAttributionUrl = url; }

    QString attributionUrl() const { return mAttributionUrl; }

    void setLegendUrl( const QString &legendUrl ) { mLegendUrl = legendUrl; }

    QString legendUrl() const { return mLegendUrl; }

    void setLegendUrlFormat( const QString &legendUrlFormat ) { mLegendUrlFormat = legendUrlFormat; }

    QString legendUrlFormat() const { return mLegendUrlFormat; }

    const QgsMapLayer *layer() const override { return mLayer; };
 
  private:
    QgsMapLayer *mLayer = nullptr;
 
    QString mShortName;
    QString mTitle;
    QString mWfsTitle; // optional WFS title
 
    QString mAttribution;
    QString mAttributionUrl;
 
    QString mDataUrl;
    QString mDataUrlFormat;
 
    QString mAbstract;
    QString mKeywordList;

    QString mLegendUrl;
    QString mLegendUrlFormat;
};
 
// XXX How to make a proper SIP type alias ?
//using QgsVectorLayerServerProperties = QgsMapLayerServerProperties;

class CORE_EXPORT QgsVectorLayerServerProperties : public QgsMapLayerServerProperties
{
    Q_GADGET
};
 
#endif // QGSMAPLAYERSERVERPROPERTIES_H