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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
/**
* \class document::StructFieldValue
* \ingroup fieldvalue
*
* \brief Stores a set of predefined field <-> fieldvalue mappings.
*/
#include "structuredfieldvalue.h"
#include "serializablearray.h"
namespace document {
class Document;
class DocumentType;
class DocumentTypeRepo;
struct FieldValueWriter;
class FixedTypeRepo;
class FieldSet;
class StructDataType;
class StructFieldValue final : public StructuredFieldValue
{
private:
SerializableArray _fields;
// As we do lazy deserialization, we need these saved
const DocumentTypeRepo *_repo;
const DocumentType *_doc_type;
uint16_t _version;
mutable bool _hasChanged;
public:
using UP = std::unique_ptr<StructFieldValue>;
explicit StructFieldValue(const DataType &type);
explicit StructFieldValue(const DocumentTypeRepo& repo, const DataType& type);
StructFieldValue(const StructFieldValue & rhs);
StructFieldValue & operator = (const StructFieldValue & rhs);
StructFieldValue(StructFieldValue && rhs) noexcept = default;
StructFieldValue & operator = (StructFieldValue && rhs) noexcept = default;
~StructFieldValue() noexcept override;
void setRepo(const DocumentTypeRepo & repo) { _repo = & repo; }
const DocumentTypeRepo * getRepo() const { return _repo; }
void setDocumentType(const DocumentType & docType) { _doc_type = & docType; }
const SerializableArray & getFields() const { return _fields; }
void lazyDeserialize(const FixedTypeRepo &repo, uint16_t version, SerializableArray::EntryMap && fields, ByteBuffer buffer);
// returns false if the field could not be serialized.
bool serializeField(int raw_field_id, uint16_t version, FieldValueWriter &writer) const;
uint16_t getVersion() const { return _version; }
// raw_ids may contain ids for elements not in the struct's datatype.
std::vector<int> getRawFieldIds() const;
void getRawFieldIds(std::vector<int> &raw_ids, const FieldSet& fieldSet) const;
void accept(FieldValueVisitor &visitor) override { visitor.visit(*this); }
void accept(ConstFieldValueVisitor &visitor) const override { visitor.visit(*this); }
bool hasField(vespalib::stringref name) const override;
const Field& getField(vespalib::stringref name) const override;
void clear() override;
// FieldValue implementation.
FieldValue& assign(const FieldValue&) override;
int compare(const FieldValue& other) const override;
StructFieldValue* clone() const override{
return new StructFieldValue(*this);
}
void printXml(XmlOutputStream& out) const override;
void print(std::ostream& out, bool verbose, const std::string& indent) const override;
bool empty() const override;
/**
* Returns true if this object have been altered since last
* serialization/deserialization. If hasChanged() is false, then cached
* information from last serialization effort is still valid.
*/
bool hasChanged() const { return _hasChanged; }
/**
* Called by document to reset struct when deserializing where this struct
* has no content. This clears content and sets changed to false.
*/
void reset();
private:
void setFieldValue(const Field&, FieldValue::UP value) override;
FieldValue::UP getFieldValue(const Field&) const override;
bool getFieldValue(const Field&, FieldValue&) const override;
bool hasFieldValue(const Field&) const override;
void removeFieldValue(const Field&) override;
VESPA_DLL_LOCAL vespalib::ConstBufferRef getRawField(uint32_t id) const;
VESPA_DLL_LOCAL const StructDataType & getStructType() const;
struct FieldIterator;
StructuredIterator::UP getIterator(const Field* toFind) const override;
/** Called from Document when deserializing alters type. */
void setType(const DataType& type) override;
friend class Document; // Hide from others to prevent misuse
};
} // document
|