container-search/src/main/java/com/yahoo/search/query/profiling/ProfilingParams.java


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

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.query.profiling;

import com.yahoo.search.query.profile.types.FieldDescription;
import com.yahoo.search.query.profile.types.QueryProfileType;

import java.util.Objects;

/**
 * Contains parameters for a part of the backend query evaluation that should be profiled.
 *
 * @author geirst
 */
public class ProfilingParams {

    public static final String PROFILING_PARAMS = "profilingParams";
    public static final String DEPTH = "depth";

    private static final QueryProfileType argumentType;

    static {
        argumentType = new QueryProfileType(PROFILING_PARAMS);
        argumentType.setStrict(true);
        argumentType.setBuiltin(true);
        argumentType.addField(new FieldDescription(DEPTH, "integer"));
        argumentType.freeze();
    }

    public static QueryProfileType getArgumentType() { return argumentType; }

    private int depth = 0;

    public int getDepth() {
        return depth;
    }

    public void setDepth(int value) {
        depth = value;
    }

    @Override
    public ProfilingParams clone() {
        try {
            return (ProfilingParams) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new RuntimeException("Someone inserted a non-cloneable superclass", e);
        }
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        ProfilingParams that = (ProfilingParams) o;
        return Objects.equals(depth, that.depth);
    }

    @Override
    public int hashCode() {
        return Objects.hash(depth);
    }
}