Analysis.h

Go to the documentation of this file.

 
#pragma once
 
#include <algorithm>
#include <cctype>
#include <cstddef>
#include <string>
#include <unordered_map>
#include <utility>
 
#include "core/domain/values/AnalysisType.h"
#include "core/domain/values/ExportFormat.h"
#include "core/domain/values/EntityName.h"
#include "core/domain/values/FilterSpec.h"
#include "core/domain/policies/AnalysisPolicy.h"
 
namespace core::domain {
 
class Analysis {
public:
    Analysis();
 
    Analysis(const Analysis&) = delete;
    Analysis& operator=(const Analysis&) = delete;
    Analysis(Analysis&&) = delete;
    Analysis& operator=(Analysis&&) = delete;

    void rename(EntityName value);
    void rename(std::string value);

    void setType(AnalysisType value);
    void setType(std::string value);
    void setConfigJson(std::string value);
    void setFilterSpec(FilterSpec value);
    void setFilterSpec(std::string value);
    void setExportFormat(ExportFormat value);
    void setExportFormat(std::string value);
    void setIncludeCalculationAdjustments(bool value);
    void setExportStateJson(std::string value);
    void setSnapshotTransactionsJson(std::string value);
    void clearAdjustments();

    void setAdjustment(std::string key, double value);

    void removeAdjustment(const std::string& key);

    [[nodiscard]] bool hasAdjustment(const std::string& key) const;

    [[nodiscard]] std::size_t adjustmentCount() const noexcept;

    [[nodiscard]] bool hasType() const noexcept;
    [[nodiscard]] bool hasExportFormat() const noexcept;
    [[nodiscard]] bool hasConfig() const noexcept;
    [[nodiscard]] bool hasFilterSpec() const noexcept;
    [[nodiscard]] bool hasSnapshotTransactions() const noexcept;
    [[nodiscard]] bool isReadyForExport() const noexcept;
    [[nodiscard]] bool isConfigured() const noexcept;
    [[nodiscard]] bool isTabular() const noexcept;
    [[nodiscard]] bool isChartLike() const noexcept;
    [[nodiscard]] bool supportsExportFormat(const std::string& candidate) const;
    [[nodiscard]] bool hasAdjustments() const noexcept;
    [[nodiscard]] bool isResultReady() const noexcept;

    [[nodiscard]] std::string executionType() const;

    [[nodiscard]] std::string outputType() const;
 
private:
    std::string id_;
    std::string name_;
    std::string type_;
    std::string configJson_;
    std::string filterSpec_;
    std::string exportFormat_;
    bool includeCalculationAdjustments_ = true;
    std::string exportStateJson_;
    std::string snapshotTransactionsJson_;
    std::unordered_map<std::string, double> adjustments_;
    std::string createdAt_;
    std::string updatedAt_;
 
public:
    // Read accessors
    [[nodiscard]] const std::string& id() const noexcept;
    [[nodiscard]] const std::string& name() const noexcept;
    [[nodiscard]] const std::string& type() const noexcept;
    [[nodiscard]] const std::string& configJson() const noexcept;
    [[nodiscard]] const std::string& filterSpec() const noexcept;
    [[nodiscard]] const std::string& exportFormat() const noexcept;
    [[nodiscard]] const bool& includeCalculationAdjustments() const noexcept;
    [[nodiscard]] const std::string& exportStateJson() const noexcept;
    [[nodiscard]] const std::string& snapshotTransactionsJson() const noexcept;
    [[nodiscard]] const std::unordered_map<std::string, double>& adjustments() const noexcept;
    [[nodiscard]] const std::string& createdAt() const noexcept;
    [[nodiscard]] const std::string& updatedAt() const noexcept;
 
    // Technical hydration
    void setId(std::string value);
    void setCreatedAt(std::string value);
    void setUpdatedAt(std::string value);
};
 
} // namespace core::domain