aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/vespa/searchcore/proton/docsummary/isummarymanager.h
blob: 3a37b62976ff396370e6fe0bbbe7dce2ae439d6e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include <vespa/searchlib/attribute/iattributemanager.h>
#include <vespa/searchlib/docstore/idocumentstore.h>
#include <vespa/searchsummary/docsummary/docsumstore.h>
#include <vespa/searchsummary/docsummary/docsumwriter.h>
#include <vespa/searchsummary/docsummary/idocsumenvironment.h>
#include <vespa/searchsummary/docsummary/resultconfig.h>

namespace document { class DocumentTypeRepo; }
namespace search::index { class Schema; }

namespace proton {

/**
 * Interface for a summary manager.
 */
class ISummaryManager
{
public:
    using SummaryConfig = const vespa::config::search::internal::InternalSummaryType;
    using JuniperrcConfig = const vespa::config::search::summary::internal::InternalJuniperrcType;
    ISummaryManager(const ISummaryManager &) = delete;
    ISummaryManager & operator = (const ISummaryManager &) = delete;
    /**
     * Interface for a summary setup.
     */
    class ISummarySetup : public search::docsummary::IDocsumEnvironment {
    public:
        using UP = std::unique_ptr<ISummarySetup>;
        using SP = std::shared_ptr<ISummarySetup>;

        ~ISummarySetup() override = default;

        virtual search::docsummary::IDocsumWriter &getDocsumWriter() const = 0;
        virtual const search::docsummary::ResultConfig &getResultConfig() = 0;
        virtual search::docsummary::IDocsumStore::UP createDocsumStore() = 0;
    };

    using UP = std::unique_ptr<ISummaryManager>;
    using SP = std::shared_ptr<ISummaryManager>;

    virtual ~ISummaryManager() = default;

    virtual ISummarySetup::SP
    createSummarySetup(const SummaryConfig &summaryCfg,
                       const JuniperrcConfig &juniperCfg,
                       const std::shared_ptr<const document::DocumentTypeRepo> &repo,
                       const std::shared_ptr<search::IAttributeManager> &attributeMgr,
                       const search::index::Schema& schema) = 0;

    virtual search::IDocumentStore &getBackingStore() = 0;
protected:
    ISummaryManager() = default;
};

} // namespace proton