qgsvectordataprovider.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectordataprovider.h - DataProvider Interface for vector layers
     --------------------------------------
    Date                 : 23-Sep-2004
    Copyright            : (C) 2004 by Marco Hugentobler
    email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSVECTORDATAPROVIDER_H
#define QGSVECTORDATAPROVIDER_H

class QTextCodec;

#include <QList>
#include <QSet>
#include <QMap>
#include <QHash>

//QGIS Includes
#include "qgis.h"
#include "qgsdataprovider.h"
#include "qgsfeature.h"
#include "qgsfield.h"
#include "qgsrectangle.h"

typedef QList<int> QgsAttributeList;
typedef QSet<int> QgsAttributeIds;
typedef QHash<int, QString> QgsAttrPalIndexNameHash;

class QgsFeatureIterator;

#include "qgsfeaturerequest.h"

class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider
{
    Q_OBJECT

  public:

    // If you add to this, please also add to capabilitiesString()
    enum Capability
    {
      NoCapabilities =                     0,
      AddFeatures =                        1,
      DeleteFeatures =               1 <<  1,
      ChangeAttributeValues =        1 <<  2,
      AddAttributes =                1 <<  3,
      DeleteAttributes =             1 <<  4,
      SaveAsShapefile =              1 <<  5,
      CreateSpatialIndex =           1 <<  6,
      SelectAtId =                   1 <<  7,
      ChangeGeometries =             1 <<  8,
      SelectGeometryAtId =           1 <<  9,
      RandomSelectGeometryAtId =     1 << 10,
      SequentialSelectGeometryAtId = 1 << 11,
      CreateAttributeIndex =         1 << 12,
      SelectEncoding =               1 << 13,
    };

    const static int EditingCapabilities = AddFeatures | DeleteFeatures |
                                           ChangeAttributeValues | ChangeGeometries | AddAttributes | DeleteAttributes;

    QgsVectorDataProvider( QString uri = QString() );

    virtual ~QgsVectorDataProvider();

    virtual QString storageType() const;

    virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest& request = QgsFeatureRequest() ) = 0;

    virtual QGis::WkbType geometryType() const = 0;

    virtual long featureCount() const = 0;

    virtual const QgsFields &fields() const = 0;

    virtual QString dataComment() const;

    virtual QVariant minimumValue( int index );

    virtual QVariant maximumValue( int index );

    virtual void uniqueValues( int index, QList<QVariant> &uniqueValues, int limit = -1 );

    virtual void enumValues( int index, QStringList& enumList ) { Q_UNUSED( index ); enumList.clear(); }

    virtual bool addFeatures( QgsFeatureList &flist );

    virtual bool deleteFeatures( const QgsFeatureIds &id );

    virtual bool addAttributes( const QList<QgsField> &attributes );

    virtual bool deleteAttributes( const QgsAttributeIds &attributes );

    virtual bool changeAttributeValues( const QgsChangedAttributesMap &attr_map );

    virtual QVariant defaultValue( int fieldId );

    virtual bool changeGeometryValues( QgsGeometryMap & geometry_map );

    virtual bool createSpatialIndex();

    virtual bool createAttributeIndex( int field );

    virtual int capabilities() const;

    QString capabilitiesString() const;

    virtual void setEncoding( const QString& e );

    QString encoding() const;

    int fieldNameIndex( const QString& fieldName ) const;

    QMap<QString, int> fieldNameMap() const;

    virtual QgsAttributeList attributeIndexes();

    virtual QgsAttributeList pkAttributeIndexes() { return QgsAttributeList(); }

    virtual QgsAttrPalIndexNameHash palAttributeIndexNames() const { return mAttrPalIndexName; }

    bool supportedType( const QgsField &field ) const;

    struct NativeType
    {
      NativeType( QString typeDesc, QString typeName, QVariant::Type type, int minLen = 0, int maxLen = 0, int minPrec = 0, int maxPrec = 0 ) :
          mTypeDesc( typeDesc ), mTypeName( typeName ), mType( type ), mMinLen( minLen ), mMaxLen( maxLen ), mMinPrec( minPrec ), mMaxPrec( maxPrec ) {};

      QString mTypeDesc;
      QString mTypeName;
      QVariant::Type mType;
      int mMinLen;
      int mMaxLen;
      int mMinPrec;
      int mMaxPrec;
    };

    const QList< NativeType > &nativeTypes() const;

    virtual bool doesStrictFeatureTypeCheck() const { return true;}

    static const QStringList &availableEncodings();

    /* provider has errors to report
     * @note added in 1.7
     */
    bool hasErrors();

    /* clear recorded errors
     * @note added in 1.7
     */
    void clearErrors();

    /* get recorded errors
     * @note added in 1.7
     */
    QStringList errors();


    virtual bool isSaveAndLoadStyleToDBSupported() { return false; }

  protected:
    QVariant convertValue( QVariant::Type type, QString value );

    void clearMinMaxCache();
    void fillMinMaxCache();

    bool mCacheMinMaxDirty;
    QMap<int, QVariant> mCacheMinValues, mCacheMaxValues;

    QTextCodec* mEncoding;

    bool mFetchFeaturesWithoutGeom;

    bool mFetchGeom;

    QgsAttributeList mAttributesToFetch;

    QList< NativeType > mNativeTypes;

    void pushError( QString msg );

    QgsAttrPalIndexNameHash mAttrPalIndexName;

  private:
    QMap<QString, QVariant::Type> mOldTypeList;

    // list of errors
    QStringList mErrors;

    static QStringList smEncodings;

};


#endif