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
 
#include "qgis_core.h"
#include "qgsrelation.h"
#include "qgsvectorlayerref.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsWeakRelation
{
  public:

    enum WeakRelationType
    {
      Referencing, 
      Referenced 
    };

    QgsWeakRelation();

    QgsWeakRelation( const QString &relationId,
                     const QString &relationName,
                     const Qgis::RelationshipStrength 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
                   );

#ifndef SIP_RUN
    QList< QgsRelation > resolvedRelations( const QgsProject *project, QgsVectorLayerRef::MatchType matchType = QgsVectorLayerRef::MatchType::All ) const;
#else
    QList< QgsRelation > resolvedRelations( const QgsProject *project ) const;
#endif

    QString id() const { return mRelationId; }

    QString name() const { return mRelationName; }

    QgsVectorLayerRef referencingLayer() const SIP_SKIP;

    QString referencingLayerSource() const;

    QString referencingLayerProvider() const;

    QString referencingLayerName() const;

    void setReferencingLayer( const QString &sourceUri, const QString &provider );

    QgsVectorLayerRef referencedLayer() const SIP_SKIP;

    QString referencedLayerSource() const;

    QString referencedLayerProvider() const;

    QString referencedLayerName() const;

    void setReferencedLayer( const QString &sourceUri, const QString &provider );

    QgsVectorLayerRef mappingTable() const SIP_SKIP;

    void setMappingTable( const QgsVectorLayerRef &table ) SIP_SKIP;

    QString mappingTableSource() const;

    QString mappingTableProvider() const;

    QString mappingTableName() const;

    void setMappingTable( const QString &sourceUri, const QString &provider );

    QStringList referencingLayerFields() const { return mReferencingLayerFields; }

    void setReferencingLayerFields( const QStringList &fields ) { mReferencingLayerFields = fields; }

    QStringList mappingReferencingLayerFields() const { return mMappingReferencingLayerFields; }

    void setMappingReferencingLayerFields( const QStringList &fields ) { mMappingReferencingLayerFields = fields; }

    QStringList referencedLayerFields() const { return mReferencedLayerFields; }

    void setReferencedLayerFields( const QStringList &fields ) { mReferencedLayerFields = fields; }

    QStringList mappingReferencedLayerFields() const { return mMappingReferencedLayerFields; }

    void setMappingReferencedLayerFields( const QStringList &fields ) { mMappingReferencedLayerFields = fields; }

    Qgis::RelationshipStrength strength() const;

    Qgis::RelationshipCardinality cardinality() const { return mCardinality; }

    void setCardinality( Qgis::RelationshipCardinality cardinality ) { mCardinality = cardinality; }

    QString forwardPathLabel() const { return mForwardPathLabel; }

    QString backwardPathLabel() const { return mBackwardPathLabel; }

    void setForwardPathLabel( const QString &label ) { mForwardPathLabel = label; }

    void setBackwardPathLabel( const QString &label ) { mBackwardPathLabel = label; }

    QString relatedTableType() const { return mRelatedTableType; }

    void setRelatedTableType( const QString &type ) { mRelatedTableType = type; }

    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 );
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
 
    QString leftIdentifier;
    if ( !sipCpp->referencedLayer().source.isEmpty() )
      leftIdentifier = sipCpp->referencedLayer().source;
 
    QString rightIdentifier;
    if ( !sipCpp->referencingLayer().source.isEmpty() )
      rightIdentifier = sipCpp->referencingLayer().source;
 
    QString str;
    if ( leftIdentifier.isEmpty() && rightIdentifier.isEmpty() )
      str = u"<QgsWeakRelation: %1>"_s.arg( sipCpp->id() );
    else
      str = u"<QgsWeakRelation: %1 - %2 -> %3>"_s.arg( sipCpp->id(), leftIdentifier, rightIdentifier );
 
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif
 
  private:
 
    QgsVectorLayerRef mReferencingLayer;
    QgsVectorLayerRef mReferencedLayer;
    QgsVectorLayerRef mMappingTable;
 
    QString mRelationId;
    QString mRelationName;
    Qgis::RelationshipStrength mStrength = Qgis::RelationshipStrength::Association;
 
    QStringList mReferencingLayerFields;
    QStringList mMappingReferencingLayerFields;
    QStringList mReferencedLayerFields;
    QStringList mMappingReferencedLayerFields;
 
    Qgis::RelationshipCardinality mCardinality = Qgis::RelationshipCardinality::OneToMany;
    QString mForwardPathLabel;
    QString mBackwardPathLabel;
    QString mRelatedTableType;
 
    friend class TestQgsWeakRelation;
 
};
 
#endif // QGSWEAKRELATION_H