gdal_relationship.h

/******************************************************************************
 *
 * Project:  GDAL
 * Purpose:  Declaration of GDALRelationship class
 * Author:   Nyall Dawson, <nyall dot dawson at gmail dot com>
 *
 ******************************************************************************
 * Copyright (c) 2022, Nyall Dawson <nyall dot dawson at gmail dot comg>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef GDALRELATIONSHIP_H_INCLUDED
#define GDALRELATIONSHIP_H_INCLUDED
 
#include "cpl_port.h"
#include "gdal.h"
 
#include <string>
#include <vector>
 
/************************************************************************/
/*                            Relationships                             */
/************************************************************************/
 
class CPL_DLL GDALRelationship
{
  protected:
    std::string m_osName{};
    std::string m_osLeftTableName{};
    std::string m_osRightTableName{};
    GDALRelationshipCardinality m_eCardinality =
        GDALRelationshipCardinality::GRC_ONE_TO_MANY;
    std::string m_osMappingTableName{};
    std::vector<std::string> m_osListLeftTableFields{};
    std::vector<std::string> m_osListRightTableFields{};
    std::vector<std::string> m_osListLeftMappingTableFields{};
    std::vector<std::string> m_osListRightMappingTableFields{};
    GDALRelationshipType m_eType = GDALRelationshipType::GRT_ASSOCIATION;
    std::string m_osForwardPathLabel{};
    std::string m_osBackwardPathLabel{};
    std::string m_osRelatedTableType{};
 
  public:
    GDALRelationship(const std::string &osName,
                     const std::string &osLeftTableName,
                     const std::string &osRightTableName,
                     GDALRelationshipCardinality eCardinality =
                         GDALRelationshipCardinality::GRC_ONE_TO_MANY)
        : m_osName(osName), m_osLeftTableName(osLeftTableName),
          m_osRightTableName(osRightTableName), m_eCardinality(eCardinality)
    {
    }
 
    const std::string &GetName() const
    {
        return m_osName;
    }
 
    GDALRelationshipCardinality GetCardinality() const
    {
        return m_eCardinality;
    }
 
    const std::string &GetLeftTableName() const
    {
        return m_osLeftTableName;
    }
 
    void SetLeftTableName(const std::string &osName)
    {
        m_osLeftTableName = osName;
    }
 
    const std::string &GetRightTableName() const
    {
        return m_osRightTableName;
    }
 
    void SetRightTableName(const std::string &osName)
    {
        m_osRightTableName = osName;
    }
 
    const std::string &GetMappingTableName() const
    {
        return m_osMappingTableName;
    }
 
    void SetMappingTableName(const std::string &osName)
    {
        m_osMappingTableName = osName;
    }
 
    const std::vector<std::string> &GetLeftTableFields() const
    {
        return m_osListLeftTableFields;
    }
 
    const std::vector<std::string> &GetRightTableFields() const
    {
        return m_osListRightTableFields;
    }
 
    void SetLeftTableFields(const std::vector<std::string> &osListFields)
    {
        m_osListLeftTableFields = osListFields;
    }
 
    void SetRightTableFields(const std::vector<std::string> &osListFields)
    {
        m_osListRightTableFields = osListFields;
    }
 
    const std::vector<std::string> &GetLeftMappingTableFields() const
    {
        return m_osListLeftMappingTableFields;
    }
 
    const std::vector<std::string> &GetRightMappingTableFields() const
    {
        return m_osListRightMappingTableFields;
    }
 
    void SetLeftMappingTableFields(const std::vector<std::string> &osListFields)
    {
        m_osListLeftMappingTableFields = osListFields;
    }
 
    void
    SetRightMappingTableFields(const std::vector<std::string> &osListFields)
    {
        m_osListRightMappingTableFields = osListFields;
    }
 
    GDALRelationshipType GetType() const
    {
        return m_eType;
    }
 
    void SetType(GDALRelationshipType eType)
    {
        m_eType = eType;
    }
 
    const std::string &GetForwardPathLabel() const
    {
        return m_osForwardPathLabel;
    }
 
    void SetForwardPathLabel(const std::string &osLabel)
    {
        m_osForwardPathLabel = osLabel;
    }
 
    const std::string &GetBackwardPathLabel() const
    {
        return m_osBackwardPathLabel;
    }
 
    void SetBackwardPathLabel(const std::string &osLabel)
    {
        m_osBackwardPathLabel = osLabel;
    }
 
    const std::string &GetRelatedTableType() const
    {
        return m_osRelatedTableType;
    }
 
    void SetRelatedTableType(const std::string &osType)
    {
        m_osRelatedTableType = osType;
    }
 
    static inline GDALRelationshipH ToHandle(GDALRelationship *poRelationship)
    {
        return static_cast<GDALRelationshipH>(poRelationship);
    }
 
    static inline GDALRelationship *FromHandle(GDALRelationshipH hRelationship)
    {
        return static_cast<GDALRelationship *>(hRelationship);
    }
};
 
#endif