aboutsummaryrefslogtreecommitdiffstats
path: root/searchsummary/src/vespa/searchsummary/docsummary/docsumwriter.h
blob: 2816cde677f10373de51ea9edf67d81c6965ecba (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
60
61
62
63
64
65
66
67
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include "docsum_field_writer.h"
#include "docsumstore.h"
#include "juniperproperties.h"
#include "resultclass.h"
#include "resultconfig.h"
#include <vespa/vespalib/stllike/string.h>

namespace search { class IAttributeManager; }

namespace vespalib { class Slime; }

namespace search::docsummary {

static constexpr uint32_t SLIME_MAGIC_ID = 0x55555555;

/**
 * Interface for writing a docsum payload (in Slime) for a given document.
 */
class IDocsumWriter
{
public:
    using Inserter = vespalib::slime::Inserter;
    struct ResolveClassInfo {
        bool all_fields_generated;
        const ResultClass* res_class;
        ResolveClassInfo()
            : all_fields_generated(false),
              res_class(nullptr)
        { }
    };

    virtual ~IDocsumWriter() = default;
    virtual void initState(const search::IAttributeManager & attrMan, GetDocsumsState& state, const ResolveClassInfo& rci) = 0;
    virtual void insertDocsum(const ResolveClassInfo & rci, uint32_t docid, GetDocsumsState& state,
                              IDocsumStore &docinfos, Inserter & target) = 0;
    virtual ResolveClassInfo resolveClassInfo(vespalib::stringref class_name,
                                              const vespalib::hash_set<vespalib::string>& fields) const = 0;
};

//--------------------------------------------------------------------------

class DynamicDocsumWriter : public IDocsumWriter
{
private:
    std::unique_ptr<ResultConfig>                         _resultConfig;

public:
    DynamicDocsumWriter(std::unique_ptr<ResultConfig> config);
    DynamicDocsumWriter(const DynamicDocsumWriter &) = delete;
    DynamicDocsumWriter& operator=(const DynamicDocsumWriter &) = delete;
    ~DynamicDocsumWriter() override;

    const ResultConfig *GetResultConfig() { return _resultConfig.get(); }

    void initState(const search::IAttributeManager & attrMan, GetDocsumsState& state, const ResolveClassInfo& rci) override;
    void insertDocsum(const ResolveClassInfo & outputClassInfo, uint32_t docid, GetDocsumsState& state,
                      IDocsumStore &docinfos, Inserter & inserter) override;

    ResolveClassInfo resolveClassInfo(vespalib::stringref class_name,
                                      const vespalib::hash_set<vespalib::string>& fields) const override;
};

}