qgsweakrelation.h

Go to the documentation of this file.

/***************************************************************************
  qgsweakrelation.h - QgsWeakRelation
 
 ---------------------
 begin                : 5.12.2019
 copyright            : (C) 2019 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 QGSWEAKRELATION_H
#define QGSWEAKRELATION_H
 
#define SIP_NO_FILE
 
#include "qgis_core.h"
#include "qgsrelation.h"
#include "qgsvectorlayerref.h"
 
class CORE_EXPORT QgsWeakRelation
{
  public:
 
    enum WeakRelationType
    {
      Referencing, 
      Referenced 
    };
 
 
    QgsWeakRelation( const QString &relationId,
                     const QString &relationName,
                     const QgsRelation::RelationStrength strength,
                     const QString &referencingLayerId,
                     const QString &referencingLayerName,
                     const QString &referencingLayerSource,
                     const QString &referencingLayerProviderKey,
                     const QString &referencedLayerId,
                     const QString &referencedLayerName,
                     const QString &referencedLayerSource,
                     const QString &referencedLayerProviderKey,
                     const QList<QgsRelation::FieldPair> &fieldPairs
                   );
 
    QgsRelation resolvedRelation( const QgsProject *project, QgsVectorLayerRef::MatchType matchType = QgsVectorLayerRef::MatchType::All ) const;
 
    QgsVectorLayerRef referencingLayer() const;
 
    QgsVectorLayerRef referencedLayer() const;
 
    QgsRelation::RelationStrength strength() const;
 
    QList<QgsRelation::FieldPair> fieldPairs() const;
 
    static QgsWeakRelation readXml( const QgsVectorLayer *layer, WeakRelationType type, const QDomNode &node, const QgsPathResolver resolver );
 
    static void writeXml( const QgsVectorLayer *layer, WeakRelationType type, const QgsRelation &relation, QDomNode &node, QDomDocument &doc );
 
  private:
 
    QgsVectorLayerRef mReferencingLayer;
    QgsVectorLayerRef mReferencedLayer;
    QString mRelationId;
    QString mRelationName;
    QgsRelation::RelationStrength mStrength = QgsRelation::RelationStrength::Association;
    QList<QgsRelation::FieldPair> mFieldPairs;
 
    friend class TestQgsWeakRelation;
 
};
 
#endif // QGSWEAKRELATION_H