aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/search/searchers/ValidateMatchPhaseSearcher.java
blob: c5ffb6c02ea154d5cdb4be911b66b9dde8f9fff2 (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.searchers;

import com.yahoo.search.Query;
import com.yahoo.search.Result;
import com.yahoo.search.Searcher;
import com.yahoo.search.result.ErrorMessage;
import com.yahoo.search.searchchain.Execution;
import com.yahoo.vespa.config.search.AttributesConfig;

import java.util.HashSet;
import java.util.Set;

/**
 * Validates that the attribute given as match-phase override is actually a valid numeric attribute
 * with fast-search enabled.
 *
 * @author baldersheim
 */
public class ValidateMatchPhaseSearcher extends Searcher {

    private Set<String> validMatchPhaseAttributes = new HashSet<>();
    private Set<String> validDiversityAttributes = new HashSet<>();

    public ValidateMatchPhaseSearcher(AttributesConfig attributesConfig) {
        for (AttributesConfig.Attribute a : attributesConfig.attribute()) {
            if (a.fastsearch() &&
                (a.collectiontype() == AttributesConfig.Attribute.Collectiontype.SINGLE) && isNumeric(a.datatype())) {
                validMatchPhaseAttributes.add(a.name());
            }
        }
        for (AttributesConfig.Attribute a : attributesConfig.attribute()) {
            if ((a.collectiontype() == AttributesConfig.Attribute.Collectiontype.SINGLE) &&
                ((a.datatype() == AttributesConfig.Attribute.Datatype.STRING) || isNumeric(a.datatype()))) {
                validDiversityAttributes.add(a.name());
            }
        }
    }

    private boolean isNumeric(AttributesConfig.Attribute.Datatype.Enum dt) {
        return  dt == AttributesConfig.Attribute.Datatype.DOUBLE ||
                dt == AttributesConfig.Attribute.Datatype.FLOAT ||
                dt == AttributesConfig.Attribute.Datatype.INT8 ||
                dt == AttributesConfig.Attribute.Datatype.INT16 ||
                dt == AttributesConfig.Attribute.Datatype.INT32 ||
                dt == AttributesConfig.Attribute.Datatype.INT64;
    }

    @Override
    public Result search(Query query, Execution execution) {
        ErrorMessage e = validate(query);
        return (e != null)
                ? new Result(query, e)
                : execution.search(query);
    }

    private ErrorMessage validate(Query query) {
        String attribute = query.getRanking().getMatchPhase().getAttribute();
        if ( attribute != null && ! validMatchPhaseAttributes.contains(attribute) ) {
            return ErrorMessage.createInvalidQueryParameter("The attribute '" + attribute + "' is not available for match-phase. " +
                                                            "It must be a single value numeric attribute with fast-search.");
        }
        attribute = query.getRanking().getMatchPhase().getDiversity().getAttribute();
        if (attribute != null && ! validDiversityAttributes.contains(attribute)) {
            return ErrorMessage.createInvalidQueryParameter("The attribute '" + attribute + "' is not available for match-phase diversification. " +
                    "It must be a single value numeric or string attribute.");
        }
        return null;
    }

}