aboutsummaryrefslogtreecommitdiffstats
path: root/searchsummary/src/vespa/searchsummary/docsummary/i_docsum_store_document.h
blob: a229e98bb4b10c9a66e6212eb1d70e12c48f01ef (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include "docsum_store_field_value.h"
#include <vespa/vespalib/stllike/string.h>

namespace vespalib::slime { struct Inserter; }

namespace search::docsummary {

class IJuniperConverter;
class IStringFieldConverter;

/**
 * Interface class providing access to a document retrieved from an IDocsumStore.
 *
 * Some implementations (e.g. DocsumStoreVsmDocument) might apply transforms when accessing some fields.
 **/
class IDocsumStoreDocument
{
public:
    virtual ~IDocsumStoreDocument() = default;
    virtual DocsumStoreFieldValue get_field_value(const vespalib::string& field_name) const = 0;
    virtual void insert_summary_field(const vespalib::string& field_name, vespalib::slime::Inserter& inserter, IStringFieldConverter* converter = nullptr) const = 0;
    virtual void insert_juniper_field(const vespalib::string& field_name, vespalib::slime::Inserter& inserter, IJuniperConverter& converter) const = 0;
    virtual void insert_document_id(vespalib::slime::Inserter& inserter) const = 0;
};

}