qgsvectorlayerjoininfo.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorlayerjoininfo.h
    ---------------------
    begin                : January 2017
    copyright            : (C) 2017 by Martin Dobias
    email                : wonder dot sk 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 QGSVECTORLAYERJOININFO_H
#define QGSVECTORLAYERJOININFO_H
 
#include "qgsfeature.h"
#include "qgsvectorlayerref.h"
 
#include <QHash>
#include <QString>
#include <QStringList>

class CORE_EXPORT QgsVectorLayerJoinInfo
{
  public:
    QgsVectorLayerJoinInfo() = default;

    void setJoinLayer( QgsVectorLayer *layer ) { mJoinLayerRef = QgsVectorLayerRef( layer ); }
    QgsVectorLayer *joinLayer() const { return mJoinLayerRef.get(); }

    void setJoinLayerId( const QString &layerId ) { mJoinLayerRef = QgsVectorLayerRef( layerId ); }
    QString joinLayerId() const { return mJoinLayerRef.layerId; }

    void setTargetFieldName( const QString &fieldName ) { mTargetFieldName = fieldName; }
    QString targetFieldName() const { return mTargetFieldName; }

    void setJoinFieldName( const QString &fieldName ) { mJoinFieldName = fieldName; }
    QString joinFieldName() const { return mJoinFieldName; }

    void setPrefix( const QString &prefix ) { mPrefix = prefix; }
    QString prefix() const { return mPrefix; }

    void setUsingMemoryCache( bool enabled );

    bool isUsingMemoryCache() const;

    bool isDynamicFormEnabled() const { return mDynamicForm; }

    void setDynamicFormEnabled( bool enabled ) { mDynamicForm = enabled; }

    bool isEditable() const { return mEditable; }

    void setEditable( bool enabled );

    bool hasUpsertOnEdit() const { return mUpsertOnEdit; }

    void setUpsertOnEdit( bool enabled ) { mUpsertOnEdit = enabled; }

    bool hasCascadedDelete() const { return mCascadedDelete; }

    void setCascadedDelete( bool enabled ) { mCascadedDelete = enabled; }

    QString prefixedFieldName( const QgsField &field ) const;

    QgsFeature extractJoinedFeature( const QgsFeature &feature ) const;

    Q_DECL_DEPRECATED void setJoinFieldNamesBlackList( const QStringList &blackList ) SIP_DEPRECATED { mBlockList = blackList; }

    Q_DECL_DEPRECATED QStringList joinFieldNamesBlackList() const SIP_DEPRECATED { return mBlockList; }

    void setJoinFieldNamesBlockList( const QStringList &list ) { mBlockList = list; }

    QStringList joinFieldNamesBlockList() const { return mBlockList; }

    bool hasSubset( bool blocklisted = true ) const;

    static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, bool blocklisted = true );

    static QStringList joinFieldNamesSubset( const QgsVectorLayerJoinInfo &info, const QgsFields &joinLayerFields, bool blocklisted = true );
 
    bool operator==( const QgsVectorLayerJoinInfo &other ) const
    {
      return mTargetFieldName == other.mTargetFieldName
             && mJoinLayerRef.layerId == other.mJoinLayerRef.layerId
             && mJoinFieldName == other.mJoinFieldName
             && mJoinFieldsSubset == other.mJoinFieldsSubset
             && mMemoryCache == other.mMemoryCache
             && mPrefix == other.mPrefix;
    }

    void setJoinFieldNamesSubset( QStringList *fieldNamesSubset SIP_TRANSFER ) { mJoinFieldsSubset = std::shared_ptr<QStringList>( fieldNamesSubset ); }

    QStringList *joinFieldNamesSubset() const { return mJoinFieldsSubset.get(); }
 
  protected:
    QString mTargetFieldName;
    QgsVectorLayerRef mJoinLayerRef;
    QString mJoinFieldName;

    QString mPrefix;

    bool mMemoryCache = false;

    std::shared_ptr<QStringList> mJoinFieldsSubset;
 
    // caching support
 
    friend class QgsVectorLayerJoinBuffer;
    friend class QgsVectorLayerFeatureIterator;

    bool cacheDirty = true;
 
    bool mDynamicForm = false;
 
    bool mEditable = false;
 
    bool mUpsertOnEdit = false;
 
    bool mCascadedDelete = false;
 
    QStringList mBlockList;

    QHash< QString, QgsAttributes> cachedAttributes;
};
 
 
#endif // QGSVECTORLAYERJOININFO_H