container-search/src/main/java/com/yahoo/search/query/profiling/Profiling.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
63
64
65
66
67
68
69
70
71
72
73
74
75

// Copyright Yahoo. 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.Trace;
import com.yahoo.search.query.profile.types.FieldDescription;
import com.yahoo.search.query.profile.types.QueryProfileFieldType;
import com.yahoo.search.query.profile.types.QueryProfileType;

import java.util.Objects;

/**
 * Contains settings for different parts of the backend query evaluation that should be profiled.
 *
 * @author geirst
 */
public class Profiling implements Cloneable {

    public static final String MATCHING = "matching";
    public static final String FIRST_PHASE_RANKING = "firstPhaseRanking";
    public static final String SECOND_PHASE_RANKING = "secondPhaseRanking";

    private static final QueryProfileType argumentType;

    static {
        argumentType = new QueryProfileType(Trace.PROFILING);
        argumentType.setStrict(true);
        argumentType.setBuiltin(true);
        argumentType.addField(new FieldDescription(MATCHING, new QueryProfileFieldType(ProfilingParams.getArgumentType())));
        argumentType.addField(new FieldDescription(FIRST_PHASE_RANKING, new QueryProfileFieldType(ProfilingParams.getArgumentType())));
        argumentType.addField(new FieldDescription(SECOND_PHASE_RANKING, new QueryProfileFieldType(ProfilingParams.getArgumentType())));
        argumentType.freeze();
    }

    public static QueryProfileType getArgumentType() { return argumentType; }

    private final ProfilingParams matching = new ProfilingParams();
    private final ProfilingParams firstPhaseRanking = new ProfilingParams();
    private final ProfilingParams secondPhaseRanking = new ProfilingParams();

    public ProfilingParams getMatching() {
        return matching;
    }

    public ProfilingParams getFirstPhaseRanking() {
        return firstPhaseRanking;
    }

    public ProfilingParams getSecondPhaseRanking() {
        return secondPhaseRanking;
    }

    @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;
        Profiling profiling = (Profiling) o;
        return Objects.equals(matching, profiling.matching) &&
                Objects.equals(firstPhaseRanking, profiling.firstPhaseRanking) &&
                Objects.equals(secondPhaseRanking, profiling.secondPhaseRanking);
    }

    @Override
    public int hashCode() {
        return Objects.hash(matching, firstPhaseRanking, secondPhaseRanking);
    }
}