aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/search/schema/DocumentSummary.java
blob: 2181b12aeb211825c17cfa8bb88b0602cde1cecd (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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.schema;

import com.yahoo.api.annotations.Beta;

import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;

/**
 * A document summary definition: Defines the schema on which a document hit may be
 * represented in a Result.
 *
 * @author bratseth
 */
@Beta
public class DocumentSummary {

    private final String name;
    private final Map<String, Field> fields;
    private final boolean dynamic;

    private DocumentSummary(Builder builder) {
        this.name = builder.name;
        this.fields = Collections.unmodifiableMap(builder.fields);
        this.dynamic = builder.dynamic;
    }

    public String name() { return name; }
    public Map<String, Field> fields() { return fields; }

    /** Returns whether this contains fields which are generated dynamically from the query and field data. */
    public boolean isDynamic() { return dynamic; }

    @Override
    public boolean equals(Object o) {
        if (o == this) return true;
        if ( ! (o instanceof DocumentSummary)) return false;
        var other = (DocumentSummary)o;
        if ( ! other.name.equals(this.name)) return false;
        if ( other.dynamic != this.dynamic) return false;
        if ( ! other.fields.equals(this.fields)) return false;
        return true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, dynamic, fields);
    }

    @Override
    public String toString() {
        return "document summary '" + name + "'";
    }

    public static class Builder {

        private final String name;
        private final Map<String, Field> fields = new LinkedHashMap<>();
        private boolean dynamic;

        public Builder(String name) {
            this.name = name;
        }

        public Builder addField(String name, String type) {
            fields.put(name, new Field(name, type));
            return this;
        }

        public Builder add(Field field) {
            fields.put(field.name(), field);
            return this;
        }

        public Builder setDynamic(boolean dynamic) {
            this.dynamic = dynamic;
            return this;
        }

        public DocumentSummary build() { return new DocumentSummary(this); }

    }

    public static class Field {

        public enum Type {
            bool,
            byteType("byte"),
            shortType("short"),
            integer,
            int64,
            float16,
            floatType("float"),
            doubleType("double"),
            string,
            data,
            raw,
            longstring,
            longdata,
            jsonstring,
            featuredata,
            xmlstring,
            tensor;

            private final String name;

            Type() {
                this(null);
            }

            Type(String name) {
                this.name = name;
            }

            /** Use this, not name() to retrieve the string value of this. */
            public String asString() {
                return name != null ? name : name();
            }

            @Override
            public String toString() { return asString(); }

            public static Type fromString(String name) {
                return Arrays.stream(Type.values()).filter(t -> name.equals(t.asString())).findAny().orElseThrow();
            }

        }

        private final String name;
        private final Type type;

        public Field(String name, String type) {
            this(name, Type.fromString(type));
        }

        public Field(String name, Type type) {
            this.name = name;
            this.type = type;
        }

        public String name() { return name; }
        public Type type() { return type; }

        @Override
        public boolean equals(Object o) {
            if (o == this) return true;
            if ( ! (o instanceof Field)) return false;
            var other = (Field)o;
            if ( ! other.name.equals(this.name)) return false;
            if ( other.type != this.type) return false;
            return true;
        }

        @Override
        public int hashCode() {
            return Objects.hash(name, type);
        }

        @Override
        public String toString() {
            return "summary field '" + name + "' " + type;
        }

    }

}