summaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/queryeval/field_spec.h
blob: 0d66de954adf461452f28c563d4a7f2aae5946b9 (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <vespa/searchlib/fef/handle.h>
#include <vespa/vespalib/stllike/string.h>
#include <vector>

namespace search::fef {
    class MatchData;
    class TermFieldMatchData;
}
namespace search::queryeval {

/**
 * Base description of a single field to be searched.
 **/
class FieldSpecBase
{
public:
    FieldSpecBase(uint32_t fieldId, fef::TermFieldHandle handle, bool isFilter_ = false);

    // resolve where to put match information for this term/field combination
    fef::TermFieldMatchData *resolve(fef::MatchData &md) const;
    const fef::TermFieldMatchData *resolve(const fef::MatchData &md) const;
    uint32_t getFieldId() const { return _fieldId & 0xffffff; }
    fef::TermFieldHandle getHandle() const { return _handle; }
    /// a filter produces less detailed match data
    bool isFilter() const { return _fieldId & 0x1000000; }
private:
    uint32_t             _fieldId;  // field id in ranking framework
    fef::TermFieldHandle _handle;   // handle used when exposing match data to ranking framework
};

/**
 * Description of a single field to be searched.
 **/
class FieldSpec : public FieldSpecBase
{
public:
    FieldSpec(const vespalib::string & name, uint32_t fieldId,
              fef::TermFieldHandle handle, bool isFilter_ = false)
        : FieldSpecBase(fieldId, handle, isFilter_),
          _name(name)
    {}

    const vespalib::string & getName() const { return _name; }
private:
    vespalib::string     _name;     // field name
};

/**
 * List of fields to be searched.
 **/
class FieldSpecBaseList
{
private:
    using List = std::vector<FieldSpecBase>;
    List _list;

public:
    ~FieldSpecBaseList();
    using const_iterator = List::const_iterator;
    FieldSpecBaseList &add(const FieldSpecBase &spec) {
        _list.push_back(spec);
        return *this;
    }
    bool empty() const { return _list.empty(); }
    size_t size() const { return _list.size(); }
    const_iterator begin() const { return _list.begin(); }
    const_iterator end() const { return _list.end(); }
    const FieldSpecBase &operator[](size_t i) const { return _list[i]; }
    void clear() { _list.clear(); }
    void swap(FieldSpecBaseList & rhs) { _list.swap(rhs._list); }
};

/**
 * List of fields to be searched.
 **/
class FieldSpecList
{
private:
    std::vector<FieldSpec> _list;

public:
    ~FieldSpecList();
    FieldSpecList &add(const FieldSpec &spec) {
        _list.push_back(spec);
        return *this;
    }
    bool empty() const { return _list.empty(); }
    size_t size() const { return _list.size(); }
    const FieldSpec &operator[](size_t i) const { return _list[i]; }
    void clear() { _list.clear(); }
    void swap(FieldSpecList & rhs) { _list.swap(rhs._list); }
};

}