qgsvirtuallayerdefinition.h

Go to the documentation of this file.

/***************************************************************************
                qgsvirtuallayerdefinition.h
begin                : Feb, 2015
copyright            : (C) 2015 Hugo Mercier, Oslandia
email                : hugo dot mercier at oslandia 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 QGSVIRTUALLAYERDEFINITION_H
#define QGSVIRTUALLAYERDEFINITION_H

#include <qgsfield.h>
#include <qgis.h>

class CORE_EXPORT QgsVirtualLayerDefinition
{
  public:
    class CORE_EXPORT SourceLayer
    {
      public:
        SourceLayer( const QString& name, const QString& ref ) : mName( name ), mRef( ref ) {}
        SourceLayer( const QString& name, const QString& source, const QString& provider, const QString& encoding )
            : mName( name ), mSource( source ), mProvider( provider ), mEncoding( encoding ) {}

        bool isReferenced() const { return !mRef.isEmpty(); }

        QString reference() const { return mRef; }

        QString name() const { return mName; }

        QString provider() const { return mProvider; }

        QString source() const { return mSource; }

        QString encoding() const { return mEncoding; }

      private:
        QString mName;
        QString mSource;
        QString mProvider;
        QString mRef;
        QString mEncoding;
    };

    QgsVirtualLayerDefinition( const QString& filePath = "" );

    static QgsVirtualLayerDefinition fromUrl( const QUrl& url );

    QUrl toUrl() const;

    QString toString() const;

    void addSource( const QString& name, const QString& ref );

    void addSource( const QString& name, const QString& source, const QString& provider, const QString& encoding = "" );

    typedef QList<SourceLayer> SourceLayers;

    const SourceLayers& sourceLayers() const { return mSourceLayers; }

    QString query() const { return mQuery; }
    void setQuery( const QString& query ) { mQuery = query; }

    QString filePath() const { return mFilePath; }
    void setFilePath( const QString& filePath ) { mFilePath = filePath; }

    QString uid() const { return mUid; }
    void setUid( const QString& uid ) { mUid = uid; }

    QString geometryField() const { return mGeometryField; }
    void setGeometryField( const QString& geometryField ) { mGeometryField = geometryField; }

    QgsWKBTypes::Type geometryWkbType() const { return mGeometryWkbType; }
    void setGeometryWkbType( QgsWKBTypes::Type t ) { mGeometryWkbType = t; }

    long geometrySrid() const { return mGeometrySrid; }
    void setGeometrySrid( long srid ) { mGeometrySrid = srid; }

    const QgsFields& fields() const { return mFields; }
    void setFields( const QgsFields& fields ) { mFields = fields; }

    bool hasSourceLayer( const QString& name ) const;

    bool hasReferencedLayers() const;

    bool hasDefinedGeometry() const
    {
      return geometryWkbType() != QgsWKBTypes::NoGeometry && geometryWkbType() != QgsWKBTypes::Unknown;
    }

  private:
    SourceLayers mSourceLayers;
    QString mQuery;
    QString mUid;
    QString mGeometryField;
    QString mFilePath;
    QgsFields mFields;
    QgsWKBTypes::Type mGeometryWkbType;
    long mGeometrySrid;
};

#endif