aboutsummaryrefslogtreecommitdiffstats
path: root/document/src/vespa/document/datatype/structureddatatype.h
blob: 3146d6be3ab6c3aa6067f875e30e42368eff979c (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
/**
 * \class document::StructuredDataType
 * \ingroup datatype
 *
 * \brief Data type describing common parts for structured datatypes.
 *
 * This class contains common functionality for structured data types, like
 * structs and documents.
 */
#pragma once

#include "datatype.h"
#include <vespa/document/base/field.h>

namespace document {

class StructuredDataType : public DataType {
    void onBuildFieldPath(FieldPath & path, vespalib::stringref remainFieldName) const override;
protected:
    StructuredDataType(vespalib::stringref name);
    StructuredDataType(vespalib::stringref name, int32_t dataTypeId);

public:
    virtual uint32_t getFieldCount() const noexcept = 0;

    /** @throws FieldNotFoundException if field does not exist. */
    virtual const Field& getField(vespalib::stringref name) const = 0;

    virtual bool hasField(vespalib::stringref name) const noexcept = 0;
    virtual bool hasField(int32_t fieldId) const noexcept = 0;

    virtual Field::Set getFieldSet() const = 0;
    bool isStructured() const noexcept override { return true; }
    bool equals(const DataType& type) const noexcept override;

    static int32_t createId(vespalib::stringref name);
};

}