Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                              qgsogrdataitems.h
       3                 :            :                              -------------------
       4                 :            :     begin                : 2011-04-01
       5                 :            :     copyright            : (C) 2011 Radim Blazek
       6                 :            :     email                : radim dot blazek at gmail dot com
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSOGRDATAITEMS_H
      17                 :            : #define QGSOGRDATAITEMS_H
      18                 :            : 
      19                 :            : #include "qgsdataitem.h"
      20                 :            : #include "qgsogrprovider.h"
      21                 :            : #include "qgsdataitemprovider.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : 
      24                 :            : ///@cond PRIVATE
      25                 :            : #define SIP_NO_FILE
      26                 :            : 
      27                 :            : /**
      28                 :            :  * Holds the information about a gpkg layer
      29                 :            :  */
      30                 :          0 : class CORE_EXPORT QgsOgrDbLayerInfo
      31                 :            : {
      32                 :            :   public:
      33                 :          0 :     QgsOgrDbLayerInfo( const QString &path,
      34                 :            :                        const QString &uri,
      35                 :            :                        const QString &name,
      36                 :            :                        const QString &theGeometryColumn,
      37                 :            :                        const QString &theGeometryType,
      38                 :            :                        const QgsLayerItem::LayerType &theLayerType,
      39                 :            :                        const QString &driverName )
      40                 :          0 :       : mPath( path )
      41                 :          0 :       , mUri( uri )
      42                 :          0 :       , mName( name )
      43                 :          0 :       , mGeometryColumn( theGeometryColumn )
      44                 :          0 :       , mGeometryType( theGeometryType )
      45                 :          0 :       , mLayerType( theLayerType )
      46                 :          0 :       , mDriverName( driverName )
      47                 :            :     {
      48                 :          0 :     }
      49                 :          0 :     const QString path() const { return mPath; }
      50                 :          0 :     const QString uri() const { return mUri; }
      51                 :          0 :     const QString name() const { return mName; }
      52                 :            :     const QString geometryColumn() const { return mGeometryColumn; }
      53                 :            :     const QString geometryType() const { return mGeometryType; }
      54                 :          0 :     QgsLayerItem::LayerType layerType() const { return mLayerType; }
      55                 :            : 
      56                 :            :   private:
      57                 :            :     QString mPath;
      58                 :            :     QString mUri;
      59                 :            :     QString mName;
      60                 :            :     QString mGeometryColumn;
      61                 :            :     QString mGeometryType;
      62                 :            :     QgsLayerItem::LayerType mLayerType = QgsLayerItem::LayerType::NoType;
      63                 :            :     QString mDriverName;
      64                 :            : };
      65                 :            : 
      66                 :            : /**
      67                 :            :  * The QgsOgrLayerException class is thrown by QgsOgrLayerItem when the layer is not valid
      68                 :            :  */
      69                 :          0 : class CORE_EXPORT QgsOgrLayerNotValidException: public QgsException
      70                 :            : {
      71                 :            :   public:
      72                 :            : 
      73                 :            :     /**
      74                 :            :      * Constructor for QgsOgrLayerNotValidException, with the specified error \a message.
      75                 :            :      */
      76                 :          0 :     QgsOgrLayerNotValidException( const QString &message )
      77                 :          0 :       : QgsException( message )
      78                 :          0 :     {}
      79                 :            : };
      80                 :            : 
      81                 :            : class CORE_EXPORT QgsOgrLayerItem final: public QgsLayerItem
      82                 :            : {
      83                 :          0 :     Q_OBJECT
      84                 :            :   public:
      85                 :            :     QgsOgrLayerItem( QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, LayerType layerType, const QString &driverName = QString(), bool isSubLayer = false );
      86                 :            : 
      87                 :            :     QString layerName() const override;
      88                 :            : 
      89                 :            :     /**
      90                 :            :      * Retrieve sub layers from a DB ogr layer \a path with the specified \a driver
      91                 :            :      * If the layer is not valid, throw a std::exception
      92                 :            :      */
      93                 :            :     static QList<QgsOgrDbLayerInfo *> subLayers( const QString &path, const QString &driver );
      94                 :            :     //! Returns a LayerType from a geometry type string
      95                 :            :     static QgsLayerItem::LayerType layerTypeFromDb( const QString &geometryType );
      96                 :            :     bool isSubLayer() const;
      97                 :            : 
      98                 :            :     QVector<QgsDataItem *> createChildren() override;
      99                 :            : 
     100                 :            :   private:
     101                 :            :     QString mDriverName;
     102                 :            :     bool mIsSubLayer;
     103                 :            : 
     104                 :            : 
     105                 :            : };
     106                 :            : 
     107                 :            : 
     108                 :            : 
     109                 :            : 
     110                 :            : class CORE_EXPORT QgsOgrDataCollectionItem final: public QgsDataCollectionItem
     111                 :            : {
     112                 :          0 :     Q_OBJECT
     113                 :            :   public:
     114                 :            :     QgsOgrDataCollectionItem( QgsDataItem *parent, const QString &name, const QString &path );
     115                 :            : 
     116                 :            :     QVector<QgsDataItem *> createChildren() override;
     117                 :            : 
     118                 :            :     /**
     119                 :            :      * Utility function to store DB connections
     120                 :            :      * \param path to the DB
     121                 :            :      * \param ogrDriverName the OGR/GDAL driver name (e.g. "GPKG")
     122                 :            :      */
     123                 :            :     static bool saveConnection( const QString &path, const QString &ogrDriverName );
     124                 :            : 
     125                 :            :     /**
     126                 :            :      * Utility function to create and store a new DB connection
     127                 :            :      * \param name is the translatable name of the managed layers (e.g. "GeoPackage")
     128                 :            :      * \param extensions is a string with file extensions (e.g. "GeoPackage Database (*.gpkg *.GPKG)")
     129                 :            :      * \param ogrDriverName the OGR/GDAL driver name (e.g. "GPKG")
     130                 :            :      */
     131                 :            :     static bool createConnection( const QString &name, const QString &extensions, const QString &ogrDriverName );
     132                 :            : 
     133                 :            :     bool hasDragEnabled() const override;
     134                 :            :     QgsMimeDataUtils::UriList mimeUris() const override;
     135                 :            : 
     136                 :            :     QgsAbstractDatabaseProviderConnection *databaseConnection() const override;
     137                 :            : 
     138                 :            : };
     139                 :            : 
     140                 :            : //! Provider for OGR root data item
     141                 :          9 : class QgsOgrDataItemProvider final: public QgsDataItemProvider
     142                 :            : {
     143                 :            :   public:
     144                 :            :     QString name() override;
     145                 :            :     QString dataProviderKey() const override;
     146                 :            :     int capabilities() const override;
     147                 :            : 
     148                 :            :     QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) override;
     149                 :            : 
     150                 :            :     bool handlesDirectoryPath( const QString &path ) override;
     151                 :            : };
     152                 :            : 
     153                 :            : ///@endcond
     154                 :            : #endif // QGSOGRDATAITEMS_H