qgsabstractmetadatabase.h

Go to the documentation of this file.

/***************************************************************************
                             QgsAbstractMetadataBase.h
                             -------------------
    begin                : March 2018
    copyright            : (C) 2018 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 QGSABSTRACTMETADATABASE_H
#define QGSABSTRACTMETADATABASE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsreadwritecontext.h"
 
#include <QMap>
#include <QMetaType>
#include <QString>
 
class QDomElement;
class QDomDocument;
class QgsTranslationContext;

class CORE_EXPORT QgsAbstractMetadataBase
{
    Q_GADGET
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsLayerMetadata * >( sipCpp ) != NULL )
      sipType = sipType_QgsLayerMetadata;
    else if ( dynamic_cast< QgsProjectMetadata * >( sipCpp ) != NULL )
      sipType = sipType_QgsProjectMetadata;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_PROPERTY( QString type READ type )
    Q_PROPERTY( QString title READ title )
    Q_PROPERTY( QString abstract READ abstract )
 
  public:
    // NOTE - these really belong in a separate namespace, but SIP says no, I want to make you waste more time
    // TODO: dump sip

    typedef QMap< QString, QStringList > KeywordMap;

    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;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsAbstractMetadataBase::Address &other ) const;
    };

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

        QString name;

        QString organization;

        QString position;

        QList< QgsAbstractMetadataBase::Address > addresses;

        QString voice;

        QString fax;

        QString email;

        QString role;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsAbstractMetadataBase::Contact &other ) const;
    };

    typedef QList< QgsAbstractMetadataBase::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;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsAbstractMetadataBase::Link &other ) const;
    };

    typedef QList< QgsAbstractMetadataBase::Link > LinkList;
 
    virtual ~QgsAbstractMetadataBase() = default;

    virtual QgsAbstractMetadataBase *clone() const = 0 SIP_FACTORY;

    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 );

    QStringList history() const;

    void setHistory( const QStringList &history );

    void addHistoryItem( const QString &text );

    QgsAbstractMetadataBase::KeywordMap keywords() const;

    void setKeywords( const QgsAbstractMetadataBase::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 );

    QgsAbstractMetadataBase::ContactList contacts() const;

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

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

    QgsAbstractMetadataBase::LinkList links() const;

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

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

    QDateTime dateTime( Qgis::MetadataDateType type ) const;

    void setDateTime( Qgis::MetadataDateType type, QDateTime date );

    virtual bool readMetadataXml( const QDomElement &metadataElement, const QgsReadWriteContext &context = QgsReadWriteContext() );

    virtual bool writeMetadataXml( QDomElement &metadataElement, QDomDocument &document, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;

    virtual void combine( const QgsAbstractMetadataBase *other );

    virtual void registerTranslations( QgsTranslationContext *translationContext ) const;
 
  protected:
    QgsAbstractMetadataBase() = default;
 
    /*
     * 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;
    QStringList mHistory;
 
    // IMPORTANT - look up before adding anything here!!

    QgsAbstractMetadataBase::KeywordMap mKeywords;
 
    QgsAbstractMetadataBase::ContactList mContacts;
 
    QgsAbstractMetadataBase::LinkList mLinks;

    QMap< Qgis::MetadataDateType, QDateTime > mDates;
 
    /*
     * IMPORTANT!!!!!!
     *
     * Do NOT add anything to this class without also updating the schema
     * definition located at resources/qgis-resource-metadata.xsd
     *
     */
 

    bool equals( const QgsAbstractMetadataBase &other ) const;
};
 
Q_DECLARE_METATYPE( QgsAbstractMetadataBase::KeywordMap )
Q_DECLARE_METATYPE( QgsAbstractMetadataBase::ContactList )
Q_DECLARE_METATYPE( QgsAbstractMetadataBase::LinkList )
 
#endif // QGSABSTRACTMETADATABASE_H