qgslayermetadatavalidator.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayermetadatavalidator.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 QGSLAYERMETADATAVALIDATOR_H
#define QGSLAYERMETADATAVALIDATOR_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
#include <QVariant>
 
class QgsAbstractMetadataBase;
class QgsLayerMetadata;

 
class CORE_EXPORT QgsAbstractMetadataBaseValidator
{
 
  public:

    class ValidationResult
    {
 
      public:

        ValidationResult( const QString &section, const QString &note, const QVariant &identifier = QVariant() )
          : section( section )
          , note( note )
          , mIdentifier( identifier )
        {}

        QString section;
 
        // TODO QGIS 4.0 - remove compatibility code

        QVariant identifier() const SIP_PYNAME( _identifier ) { return mIdentifier; }

        void setIdentifier( const QVariant &identifier ) { mIdentifier = identifier; }

        QString note;
 
      private:
 
        QVariant mIdentifier;
    };
 
    virtual ~QgsAbstractMetadataBaseValidator() = default;

    virtual bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const = 0;
 
};

 
class CORE_EXPORT QgsNativeMetadataBaseValidator : public QgsAbstractMetadataBaseValidator
{
 
  public:
 
    QgsNativeMetadataBaseValidator() = default;
 
    bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const override;
 
};
 

 
class CORE_EXPORT QgsNativeMetadataValidator : public QgsNativeMetadataBaseValidator
{
 
  public:
    QgsNativeMetadataValidator() = default;
 
    bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const override;
 
};

 
class CORE_EXPORT QgsNativeProjectMetadataValidator : public QgsNativeMetadataBaseValidator
{
 
  public:
 
    QgsNativeProjectMetadataValidator() = default;
 
    bool validate( const QgsAbstractMetadataBase *metadata, QList< QgsAbstractMetadataBaseValidator::ValidationResult > &results SIP_OUT ) const override;
 
};
 
#endif // QGSLAYERMETADATAVALIDATOR_H