IAnalysisRunner.h

Go to the documentation of this file.

 
#pragma once
 
#include "core/ports/usecases/analysis/AnalysisRequest.h"
#include "core/ports/usecases/analysis/AnalysisResult.h"
#include "core/ports/workspace/WorkspaceSnapshot.h"
 
#include <optional>
#include <string>
#include <vector>
 
namespace core::ports::analysis {
 
class IAnalysisRunner {
public:
    virtual ~IAnalysisRunner() = default;

    [[nodiscard]] virtual AnalysisResult
    runAnalysis(const core::ports::workspace::WorkspaceSnapshot& workspace,
                const AnalysisRequest& request) const = 0;

    [[nodiscard]] virtual AnalysisPreviewResult
    previewTransactions(const core::ports::workspace::WorkspaceSnapshot& workspace,
                        const AnalysisFilterSelection& filter) const = 0;

    [[nodiscard]] virtual AnalysisFilterSelection filterSelectionFromFields(
        const std::string& dateField,
        const std::string& dateMode,
        const std::string& year,
        const std::string& dateFrom,
        const std::string& dateTo,
        const std::vector<std::string>& propertyIds,
        const std::vector<std::string>& contractTypes,
        const std::string& allocatableMode) const = 0;

    [[nodiscard]] virtual AnalysisFilterSelection
    parseFilterSpec(const std::string& filterSpec) const = 0;

    [[nodiscard]] virtual std::string
    buildFilterSpec(const AnalysisFilterSelection& selection) const = 0;

    [[nodiscard]] virtual std::string
    buildAnalysisConfigJson(const AnalysisConfigInput& input) const = 0;

    [[nodiscard]] virtual AnalysisAdjustmentAmounts buildAnalysisAdjustments(
        const std::vector<AnalysisAdjustmentTransactionInput>& transactions,
        const std::vector<std::string>& selectedTransactionIds,
        double taxPercent) const = 0;

    [[nodiscard]] virtual std::optional<double>
    parseAnalysisPercentText(const std::string& text) const = 0;

    virtual void applyAnalysisPreviewOverrides(
        core::ports::workspace::WorkspaceSnapshot& workspace,
        const std::string& analysisId,
        bool includeCalculationAdjustments,
        const AnalysisAdjustmentAmounts& adjustments) const = 0;

    [[nodiscard]] virtual AnalysisTableState projectTableState(
        const AnalysisResult& result,
        const AnalysisAdjustmentAmounts& adjustments,
        bool includeCalculationAdjustments,
        const std::string& unassignedLabel) const = 0;

    [[nodiscard]] virtual std::vector<std::string> contractTypes(
        const core::ports::workspace::WorkspaceSnapshot& workspace) const = 0;
};
 
} // namespace core::ports::analysis