blob: 992c44f0ed2bdb7fc6fbd9b3c1194e5ab30ea342 (
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "res_config_entry.h"
#include <vespa/vespalib/stllike/hash_map.h>
#include <vespa/vespalib/stllike/hash_set.h>
#include <vespa/vespalib/stllike/string.h>
namespace search::docsummary {
/**
* This class represents a specific docsum format (docsum class). It
* contains an array of ResConfigEntry instances (config
* entries). It also contains methods for mapping both
* field name and field name enum value into field index.
**/
class ResultClass
{
public:
struct DynamicInfo
{
uint32_t _overrideCnt; // # fields overridden
uint32_t _generateCnt; // # fields generated
DynamicInfo() noexcept
: _overrideCnt(0),
_generateCnt(0)
{
}
void update_override_counts(bool generated) noexcept {
++_overrideCnt;
if (generated) {
++_generateCnt;
}
}
};
private:
using NameIdMap = vespalib::hash_map<vespalib::string, int>;
using Configs = std::vector<ResConfigEntry>;
vespalib::string _name; // name of this class
Configs _entries; // config entries for this result class
NameIdMap _nameMap; // fieldname -> entry index
DynamicInfo _dynInfo; // fields overridden and generated
// Whether or not summary features should be omitted when filling this summary class.
// As default, summary features are always included.
bool _omit_summary_features;
size_t _num_field_writer_states;
public:
using UP = std::unique_ptr<ResultClass>;
/**
* Constructor. Assign name and id to this result class. Also gain
* ref. to shared string enum object and insert into linked list.
*
* @param name the name of this result class.
**/
explicit ResultClass(const char *name);
ResultClass(const ResultClass &) = delete;
ResultClass& operator=(const ResultClass &) = delete;
/**
* Destructor. Delete internal structures.
**/
~ResultClass();
/**
* Obtain the number of config entries (size of the
* ResConfigEntry array) held by this result class.
*
* @return number of config entries held by this object.
**/
uint32_t getNumEntries() const { return _entries.size(); }
/**
* Add a config entry to this result class. Each config entry
* contains the name and type of a field present in the docsum blobs
* conforming to this result class. This method will fail if the
* field name given already has been used to name a field in this
* result class.
*
* @return true(success)/false(fail)
* @param name the name of the field to add.
* @param docsum_field_writer field writer for writing field
**/
bool addConfigEntry(const char *name, std::unique_ptr<DocsumFieldWriter> docsum_field_writer);
bool addConfigEntry(const char *name);
/**
* Obtain the field index from the field name. The field index may
* be used to look up a config entry in this object, or to look up a
* result entry in a GeneralResult object. NOTE: When using
* the return value from this method to look up a result entry in a
* GeneralResult object, make sure that the
* GeneralResult object has this object as it's result
* class. NOTE2: This method is called by the
* GeneralResult::getEntry(string) method; no need to call it
* directly.
*
* @return field index or -1 if not found
**/
int getIndexFromName(const char* name) const;
/**
* Obtain config entry by field index.
*
* @return config entry or NULL if not found.
**/
const ResConfigEntry *getEntry(uint32_t offset) const {
return (offset < _entries.size()) ? &_entries[offset] : nullptr;
}
/**
* Returns whether the given fields are generated in this result class (do not require the document instance).
*
* If the given fields set is empty, check all fields defined in this result class.
*/
bool all_fields_generated(const vespalib::hash_set<vespalib::string>& fields) const;
void set_omit_summary_features(bool value) {
_omit_summary_features = value;
}
bool omit_summary_features() const {
return _omit_summary_features;
}
size_t get_num_field_writer_states() const noexcept { return _num_field_writer_states; }
};
}
|
