data_organization_service.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.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 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_DQ_SERVICE_DATA_ORGANIZATION_SERVICE_HPP
#define ORES_DQ_SERVICE_DATA_ORGANIZATION_SERVICE_HPP
 
#include <string>
#include <vector>
#include <optional>
#include "ores.logging/make_logger.hpp"
#include "ores.database/domain/context.hpp"
#include "ores.dq/domain/catalog.hpp"
#include "ores.dq/domain/dataset_dependency.hpp"
#include "ores.dq/domain/data_domain.hpp"
#include "ores.dq/domain/subject_area.hpp"
#include "ores.dq/repository/catalog_repository.hpp"
#include "ores.dq/repository/dataset_dependency_repository.hpp"
#include "ores.dq/repository/data_domain_repository.hpp"
#include "ores.dq/repository/subject_area_repository.hpp"
 
namespace ores::dq::service {
 
class data_organization_service {
private:
    inline static std::string_view logger_name =
        "ores.dq.service.data_organization_service";
 
    [[nodiscard]] static auto& lg() {
        using namespace ores::logging;
        static auto instance = make_logger(logger_name);
        return instance;
    }
 
public:
    using context = ores::database::context;
 
    explicit data_organization_service(context ctx);
 
    // ========================================================================
    // Catalog Management
    // ========================================================================
 
    std::vector<domain::catalog> list_catalogs();
 
    std::vector<domain::catalog>
    list_catalogs(std::uint32_t offset, std::uint32_t limit);
 
    std::uint32_t get_catalog_count();
 
    std::optional<domain::catalog> find_catalog(const std::string& name);
 
    void save_catalog(const domain::catalog& catalog);
 
    void remove_catalog(const std::string& name);
 
    std::vector<domain::catalog> get_catalog_history(const std::string& name);
 
    // ========================================================================
    // Dataset Dependency Management
    // ========================================================================
 
    std::vector<domain::dataset_dependency> list_dataset_dependencies();
 
    std::vector<domain::dataset_dependency>
    list_dataset_dependencies_by_dataset(const std::string& dataset_code);
 
    // ========================================================================
    // Data Domain Management
    // ========================================================================
 
    std::vector<domain::data_domain> list_data_domains();
 
    std::optional<domain::data_domain> find_data_domain(const std::string& name);
 
    void save_data_domain(const domain::data_domain& data_domain);
 
    void remove_data_domain(const std::string& name);
 
    std::vector<domain::data_domain> get_data_domain_history(const std::string& name);
 
    // ========================================================================
    // Subject Area Management
    // ========================================================================
 
    std::vector<domain::subject_area> list_subject_areas();
 
    std::vector<domain::subject_area>
    list_subject_areas(std::uint32_t offset, std::uint32_t limit);
 
    std::vector<domain::subject_area>
    list_subject_areas_by_domain(const std::string& domain_name);
 
    std::uint32_t get_subject_area_count();
 
    std::optional<domain::subject_area>
    find_subject_area(const std::string& name, const std::string& domain_name);
 
    void save_subject_area(const domain::subject_area& subject_area);
 
    void remove_subject_area(const std::string& name,
                             const std::string& domain_name);
 
    std::vector<domain::subject_area>
    get_subject_area_history(const std::string& name,
                             const std::string& domain_name);
 
private:
    repository::catalog_repository catalog_repo_;
    repository::dataset_dependency_repository dataset_dependency_repo_;
    repository::data_domain_repository data_domain_repo_;
    repository::subject_area_repository subject_area_repo_;
};
 
}
 
#endif