aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/prelude/fastsearch/DocsumDefinition.java
blob: 20615a099b6920f9b2f6fc90bb40b6d87b41a7ea (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
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.prelude.fastsearch;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.yahoo.data.access.Inspector;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * A docsum definition which knows how to decode a certain class of document
 * summaries. The docsum definition has a name and a list of field definitions
 *
 * @author bratseth
 * @author Bjørn Borud
 */
public class DocsumDefinition {

    private final String name;
    private final ImmutableList<DocsumField> fields;

    /** True if this contains dynamic fields */
    private final boolean dynamic;

    // Mapping between field names and their index in this.fields
    private final ImmutableMap<String, Integer> fieldNameToIndex;

    public DocsumDefinition(String name, List<DocsumField> fields) {
        this.name = name;
        this.dynamic = false;
        this.fields = ImmutableList.copyOf(fields);
        ImmutableMap.Builder<String, Integer> fieldNameToIndexBuilder = new ImmutableMap.Builder<>();
        int i = 0;
        for (DocsumField field : fields)
            fieldNameToIndexBuilder.put(field.name, i++);
        this.fieldNameToIndex = fieldNameToIndexBuilder.build();
    }

    DocsumDefinition(DocumentdbInfoConfig.Documentdb.Summaryclass config) {
        this.name = config.name();

        List<DocsumField> fieldsBuilder = new ArrayList<>();
        Map<String, Integer> fieldNameToIndexBuilder = new HashMap<>();
        boolean dynamic = false;
        for (DocumentdbInfoConfig.Documentdb.Summaryclass.Fields field : config.fields()) {
            // no, don't switch the order of the two next lines :)
            fieldNameToIndexBuilder.put(field.name(), fieldsBuilder.size());
            fieldsBuilder.add(DocsumField.create(field.name(), field.type()));
            if (field.dynamic())
                dynamic = true;
        }
        this.dynamic = dynamic;
        fields = ImmutableList.copyOf(fieldsBuilder);
        fieldNameToIndex = ImmutableMap.copyOf(fieldNameToIndexBuilder);
    }

    /** Returns the field at this index, or null if none */
    public DocsumField getField(int fieldIndex) {
        if (fieldIndex >= fields.size()) return null;
        return fields.get(fieldIndex);
    }

    /** Returns the field with this name, or null if none */
    public DocsumField getField(String fieldName) {
        Integer index = fieldNameToIndex.get(fieldName);
        if (index == null) return null;
        return getField(index);
    }

    /**
     * Returns the given slime value as the type specified in this, or null if the type is not known.
     * Even in a correctly configured system we may encounter field names for which we do not know the type,
     * in the time period when a configuration is changing and one node has received the new configuration and
     * another has not.
     */
    public Object convert(String fieldName, Inspector value) {
        DocsumField fieldType = getField(fieldName);
        if (fieldType == null) return null;
        return fieldType.convert(value);
    }

    public Set<String> fieldNames() {
        return fieldNameToIndex.keySet();
    }

    @Override
    public String toString() {
        return "docsum definition '" + getName() + "'";
    }

    public String getName() {
        return name;
    }

    public int getFieldCount() {
        return fields.size();
    }

    public List<DocsumField> getFields() {
        return fields;
    }

    /** Returns whether this summary contains one or more dynamic fields */
    public boolean isDynamic() {
        return dynamic;
    }

}