qgsabstractlayermetadataprovider.h

Go to the documentation of this file.

/***************************************************************************
  qgslayermetadataprovider.h - QgsLayerMetadataProvider
 
 ---------------------
 begin                : 17.8.2022
 copyright            : (C) 2022 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 QGSABSTRACTLAYERMETADATAPROVIDER_H
#define QGSABSTRACTLAYERMETADATAPROVIDER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgscoordinatetransformcontext.h"
#include "qgslayermetadata.h"
#include "qgspolygon.h"
#include "qgsrectangle.h"
 
#include <QObject>
 
class QgsFeedback;

struct CORE_EXPORT QgsMetadataSearchContext
{
    QgsCoordinateTransformContext transformContext;
};

class CORE_EXPORT QgsLayerMetadataProviderResult : public QgsLayerMetadata
{
  public:
    QgsLayerMetadataProviderResult( const QgsLayerMetadata &metadata );
 
    QgsLayerMetadataProviderResult() = default;

    const QgsPolygon &geographicExtent() const;

    void setGeographicExtent( const QgsPolygon &geographicExtent );

    Qgis::GeometryType geometryType() const;

    void setGeometryType( Qgis::GeometryType geometryType );

    const QString &authid() const;

    void setAuthid( const QString &authid );

    const QString &uri() const;

    void setUri( const QString &Uri );

    const QString &dataProviderName() const;

    void setDataProviderName( const QString &dataProviderName );

    Qgis::LayerType layerType() const;

    void setLayerType( Qgis::LayerType layerType );

    const QString &standardUri() const;

    void setStandardUri( const QString &standardUri );
 
 
  private:
    QgsPolygon mGeographicExtent;
    Qgis::GeometryType mGeometryType = Qgis::GeometryType::Unknown;
    QString mAuthid;
    QString mUri;
    QString mDataProviderName;
    Qgis::LayerType mLayerType = Qgis::LayerType::Vector;
    QString mStandardUri;
};
 
Q_DECLARE_METATYPE( QgsLayerMetadataProviderResult )
 

class CORE_EXPORT QgsLayerMetadataSearchResults
{
  public:
    QList<QgsLayerMetadataProviderResult> metadata() const;

    void addMetadata( const QgsLayerMetadataProviderResult &metadata );

    QStringList errors() const;

    void addError( const QString &error );
 
  private:
    QList<QgsLayerMetadataProviderResult> mMetadata;
    QStringList mErrors;
};
 
Q_DECLARE_METATYPE( QgsLayerMetadataSearchResults )
 

class CORE_EXPORT QgsAbstractLayerMetadataProvider
{
  public:
    virtual ~QgsAbstractLayerMetadataProvider() = default;

    virtual QString id() const = 0;

    virtual QgsLayerMetadataSearchResults search(
      const QgsMetadataSearchContext &searchContext, const QString &searchString = QString(), const QgsRectangle &geographicExtent = QgsRectangle(), QgsFeedback *feedback = nullptr
    ) const
      = 0;
};
 
#endif // QGSABSTRACTLAYERMETADATAPROVIDER_H