annotation_repository.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "kcenon/pacs/storage/annotation_record.h"
 
#include <kcenon/common/patterns/result.h>
 
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#ifdef PACS_WITH_DATABASE_SYSTEM
 
#include "kcenon/pacs/storage/base_repository.h"
 
namespace kcenon::pacs::storage {
 
class annotation_repository
    : public base_repository<annotation_record, std::string> {
public:
    explicit annotation_repository(std::shared_ptr<pacs_database_adapter> db);
    ~annotation_repository() override = default;
 
    annotation_repository(const annotation_repository&) = delete;
    auto operator=(const annotation_repository&)
        -> annotation_repository& = delete;
    annotation_repository(annotation_repository&&) noexcept = default;
    auto operator=(annotation_repository&&) noexcept
        -> annotation_repository& = default;
 
    // =========================================================================
    // Domain-Specific Operations
    // =========================================================================
 
    [[nodiscard]] auto find_by_pk(int64_t pk) -> result_type;
 
    [[nodiscard]] auto find_by_instance(std::string_view sop_instance_uid)
        -> list_result_type;
 
    [[nodiscard]] auto find_by_study(std::string_view study_uid)
        -> list_result_type;
 
    [[nodiscard]] auto search(const annotation_query& query) -> list_result_type;
 
    [[nodiscard]] auto update_annotation(const annotation_record& record)
        -> VoidResult;
 
    [[nodiscard]] auto count_matching(const annotation_query& query)
        -> Result<size_t>;
 
protected:
    // =========================================================================
    // base_repository overrides
    // =========================================================================
 
    [[nodiscard]] auto map_row_to_entity(const database_row& row) const
        -> annotation_record override;
 
    [[nodiscard]] auto entity_to_row(const annotation_record& entity) const
        -> std::map<std::string, database_value> override;
 
    [[nodiscard]] auto get_pk(const annotation_record& entity) const
        -> std::string override;
 
    [[nodiscard]] auto has_pk(const annotation_record& entity) const
        -> bool override;
 
    [[nodiscard]] auto select_columns() const
        -> std::vector<std::string> override;
 
private:
    [[nodiscard]] auto parse_timestamp(const std::string& str) const
        -> std::chrono::system_clock::time_point;
 
    [[nodiscard]] auto format_timestamp(
        std::chrono::system_clock::time_point tp) const -> std::string;
 
    [[nodiscard]] static auto serialize_style(const annotation_style& style)
        -> std::string;
    [[nodiscard]] static auto deserialize_style(std::string_view json)
        -> annotation_style;
};
 
}  // namespace kcenon::pacs::storage
 
#else  // !PACS_WITH_DATABASE_SYSTEM
 
// Legacy interface for builds without database_system
struct sqlite3;
 
namespace kcenon::pacs::storage {
 
template <typename T>
using Result = kcenon::common::Result<T>;
 
using VoidResult = kcenon::common::VoidResult;
 
class annotation_repository {
public:
    explicit annotation_repository(sqlite3* db);
    ~annotation_repository();
 
    annotation_repository(const annotation_repository&) = delete;
    auto operator=(const annotation_repository&) -> annotation_repository& = delete;
    annotation_repository(annotation_repository&&) noexcept;
    auto operator=(annotation_repository&&) noexcept -> annotation_repository&;
 
    [[nodiscard]] auto save(const annotation_record& record) -> VoidResult;
    [[nodiscard]] auto find_by_id(std::string_view annotation_id) const
        -> std::optional<annotation_record>;
    [[nodiscard]] auto find_by_pk(int64_t pk) const
        -> std::optional<annotation_record>;
    [[nodiscard]] auto find_by_instance(std::string_view sop_instance_uid) const
        -> std::vector<annotation_record>;
    [[nodiscard]] auto find_by_study(std::string_view study_uid) const
        -> std::vector<annotation_record>;
    [[nodiscard]] auto search(const annotation_query& query) const
        -> std::vector<annotation_record>;
    [[nodiscard]] auto update(const annotation_record& record) -> VoidResult;
    [[nodiscard]] auto remove(std::string_view annotation_id) -> VoidResult;
    [[nodiscard]] auto exists(std::string_view annotation_id) const -> bool;
    [[nodiscard]] auto count() const -> size_t;
    [[nodiscard]] auto count(const annotation_query& query) const -> size_t;
    [[nodiscard]] auto is_valid() const noexcept -> bool;
 
private:
    [[nodiscard]] auto parse_row(void* stmt) const -> annotation_record;
 
    [[nodiscard]] static auto serialize_style(const annotation_style& style) -> std::string;
    [[nodiscard]] static auto deserialize_style(std::string_view json) -> annotation_style;
 
    sqlite3* db_{nullptr};
};
 
}  // namespace kcenon::pacs::storage
 
#endif  // PACS_WITH_DATABASE_SYSTEM