qgsrelation.h

Go to the documentation of this file.

/***************************************************************************
    qgsrelation.h
     --------------------------------------
    Date                 : 29.4.2013
    Copyright            : (C) 2013 Matthias Kuhn
    Email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSRELATION_H
#define QGSRELATION_H

#include <QList>
#include <QDomNode>
#include <QPair>

#include "qgsfield.h"
#include "qgsfeatureiterator.h"

class QgsVectorLayer;

class CORE_EXPORT QgsRelation
{
  public:
    class FieldPair : public QPair< QString, QString >
    {
      public:
        FieldPair()
            : QPair< QString, QString >() {}

        FieldPair( const QString& referencingField, const QString& referencedField )
            : QPair< QString, QString >( referencingField, referencedField ) {}

        QString referencingField() const { return first; }
        QString referencedField() const { return second; }
    };

    QgsRelation();

    static QgsRelation createFromXML( const QDomNode& node );

    void writeXML( QDomNode& node, QDomDocument& doc ) const;

    void setRelationId( const QString& id );

    void setRelationName( const QString& name );

    void setReferencingLayer( const QString& id );

    void setReferencedLayer( const QString& id );

    void addFieldPair( const QString& referencingField, const QString& referencedField );

    void addFieldPair( const FieldPair& fieldPair );

    QgsFeatureIterator getRelatedFeatures( const QgsFeature& feature ) const;

    QgsFeatureRequest getRelatedFeaturesRequest( const QgsFeature& feature ) const;

    QString getRelatedFeaturesFilter( const QgsFeature& feature ) const;

    QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes& attributes ) const;

    QgsFeatureRequest getReferencedFeatureRequest( const QgsFeature& feature ) const;

    QgsFeature getReferencedFeature( const QgsFeature& feature ) const;

    QString name() const;

    QString id() const;

    QString referencingLayerId() const;

    QgsVectorLayer* referencingLayer() const;

    QString referencedLayerId() const;

    QgsVectorLayer* referencedLayer() const;

    QList< FieldPair > fieldPairs() const;

    QgsAttributeList referencedFields() const;

    QgsAttributeList referencingFields() const;

    bool isValid() const;

  protected:
    void updateRelationStatus();

  private:
    QString mRelationId;
    QString mRelationName;
    QString mReferencingLayerId;
    QgsVectorLayer* mReferencingLayer;
    QString mReferencedLayerId;
    QgsVectorLayer* mReferencedLayer;
    QList< FieldPair > mFieldPairs;

    bool mValid;
};

// Register QgsRelation for usage with QVariant
Q_DECLARE_METATYPE( QgsRelation )

#endif // QGSRELATION_H