qgslayermetadata.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayermetadata.h
                             -------------------
    begin                : April 2017
    copyright            : (C) 2017 by 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 QGSLAYERMETADATA_H
#define QGSLAYERMETADATA_H

#include "qgis.h"
#include "qgis_core.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsbox3d.h"
#include "qgsrange.h"

class QgsMapLayer;

class CORE_EXPORT QgsLayerMetadata
{
  public:

    typedef QMap< QString, QStringList > KeywordMap;

    struct CORE_EXPORT SpatialExtent
    {

      QgsCoordinateReferenceSystem extentCrs;

      QgsBox3d bounds;

      bool operator==( const QgsLayerMetadata::SpatialExtent &other ) const;
    };

    struct CORE_EXPORT Extent
    {
      public:

        QList< QgsLayerMetadata::SpatialExtent > spatialExtents() const;

        void setSpatialExtents( const QList< QgsLayerMetadata::SpatialExtent > &extents );

        QList< QgsDateTimeRange > temporalExtents() const;

        void setTemporalExtents( const QList< QgsDateTimeRange > &extents );

        bool operator==( const QgsLayerMetadata::Extent &other ) const;

#ifndef SIP_RUN
      private:

        QList< QgsLayerMetadata::SpatialExtent > mSpatialExtents;
        QList< QgsDateTimeRange > mTemporalExtents;

#endif

    };

    struct CORE_EXPORT Constraint
    {

      Constraint( const QString &constraint = QString(), const QString &type = QString() )
        : type( type )
        , constraint( constraint )
      {}

      QString type;

      QString constraint;

      bool operator==( const QgsLayerMetadata::Constraint &other ) const;

    };

    typedef QList< QgsLayerMetadata::Constraint > ConstraintList;


    struct CORE_EXPORT Address
    {

      Address( const QString &type = QString(), const QString &address = QString(), const QString &city = QString(), const QString &administrativeArea = QString(), const QString &postalCode = QString(), const QString &country = QString() )
        : type( type )
        , address( address )
        , city( city )
        , administrativeArea( administrativeArea )
        , postalCode( postalCode )
        , country( country )
      {}

      QString type;

      QString address;

      QString city;

      QString administrativeArea;

      QString postalCode;

      QString country;

      bool operator==( const QgsLayerMetadata::Address &other ) const;
    };

    struct CORE_EXPORT Contact
    {

      Contact( const QString &name = QString() )
        : name( name )
      {}

      QString name;

      QString organization;

      QString position;

      QList< QgsLayerMetadata::Address > addresses;

      QString voice;

      QString fax;

      QString email;

      QString role;

      bool operator==( const QgsLayerMetadata::Contact &other ) const;
    };

    typedef QList< QgsLayerMetadata::Contact > ContactList;


    struct CORE_EXPORT Link
    {

      Link( const QString &name = QString(), const QString &type = QString(), const QString &url = QString() )
        : name( name )
        , type( type )
        , url( url )
      {}

      QString name;

      QString type;

      QString description;

      QString url;

      QString format;

      QString mimeType;

      QString size;

      bool operator==( const QgsLayerMetadata::Link &other ) const;
    };

    typedef QList< QgsLayerMetadata::Link > LinkList;

    QgsLayerMetadata() = default;

    virtual ~QgsLayerMetadata() = default;

    QString identifier() const;

    void setIdentifier( const QString &identifier );

    QString parentIdentifier() const;

    void setParentIdentifier( const QString &parentIdentifier );

    QString language() const;

    void setLanguage( const QString &language );

    QString type() const;

    void setType( const QString &type );

    QString title() const;

    void setTitle( const QString &title );

    QString abstract() const;

    void setAbstract( const QString &abstract );

    QString fees() const;

    void setFees( const QString &fees );

    QgsLayerMetadata::ConstraintList constraints() const;

    void addConstraint( const QgsLayerMetadata::Constraint &constraint );

    void setConstraints( const QgsLayerMetadata::ConstraintList &constraints );

    QStringList rights() const;

    void setRights( const QStringList &rights );

    QStringList licenses() const;

    void setLicenses( const QStringList &licenses );

    QStringList history() const;

    void setHistory( const QStringList &history );

    void addHistoryItem( const QString &text );

    QString encoding() const;

    void setEncoding( const QString &encoding );

    SIP_SKIP const QgsLayerMetadata::Extent &extent() const;

    QgsLayerMetadata::Extent &extent();

    void setExtent( const QgsLayerMetadata::Extent &extent );

    QgsCoordinateReferenceSystem crs() const;

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    KeywordMap keywords() const;

    void setKeywords( const KeywordMap &keywords );

    void addKeywords( const QString &vocabulary, const QStringList &keywords );

    bool removeKeywords( const QString &vocabulary );

    QStringList keywordVocabularies() const;

    QStringList keywords( const QString &vocabulary ) const;

    QStringList categories() const;

    void setCategories( const QStringList &categories );

    QgsLayerMetadata::ContactList contacts() const;

    void setContacts( const QgsLayerMetadata::ContactList &contacts );

    void addContact( const QgsLayerMetadata::Contact &contact );

    QgsLayerMetadata::LinkList links() const;

    void setLinks( const QgsLayerMetadata::LinkList &links );

    void addLink( const QgsLayerMetadata::Link &link );

    void saveToLayer( QgsMapLayer *layer ) const;

    void readFromLayer( const QgsMapLayer *layer );

    bool readMetadataXml( const QDomElement &metadataElement );

    bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document ) const;

    bool operator==( const QgsLayerMetadata &metadataOther ) const;

  private:

    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */

    QString mIdentifier;
    QString mParentIdentifier;
    QString mLanguage;
    QString mType;
    QString mTitle;
    QString mAbstract;
    QString mFees;
    ConstraintList mConstraints;
    QStringList mRights;
    QStringList mLicenses;
    QStringList mHistory;

    // IMPORTANT - look up before adding anything here!!

    QString mEncoding;
    QgsCoordinateReferenceSystem mCrs;

    Extent mExtent;

    KeywordMap mKeywords;

    ContactList mContacts;

    LinkList mLinks;

    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */

};

Q_DECLARE_METATYPE( QgsLayerMetadata::KeywordMap )
Q_DECLARE_METATYPE( QgsLayerMetadata::ConstraintList )
Q_DECLARE_METATYPE( QgsLayerMetadata::ContactList )
Q_DECLARE_METATYPE( QgsLayerMetadata::LinkList )
Q_DECLARE_METATYPE( QgsLayerMetadata::Extent )

#endif // QGSLAYERMETADATA_H