summaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/features/fieldinfofeature.cpp
blob: e1a2fb33d4f56b72e765d55cd30b10e114eea67f (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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "fieldinfofeature.h"
#include "valuefeature.h"
#include "utils.h"
#include <vespa/searchlib/fef/properties.h>
#include <vespa/searchlib/fef/fieldinfo.h>
#include <vespa/searchlib/fef/fieldtype.h>
#include <vespa/searchlib/fef/featurenamebuilder.h>
#include <vespa/searchlib/fef/handle.h>
#include <vespa/vespalib/util/stash.h>
#include <sstream>

namespace search::features {

IndexFieldInfoExecutor::IndexFieldInfoExecutor(feature_t type, feature_t isFilter,
                                               [[maybe_unused]] uint32_t field, uint32_t fieldHandle)
    : fef::FeatureExecutor(),
      _type(type),
      _isFilter(isFilter),
      _fieldHandle(fieldHandle),
      _md(nullptr)
{
    // empty
}

void
IndexFieldInfoExecutor::execute(uint32_t docId)
{
    outputs().set_number(0, _type);
    outputs().set_number(1, _isFilter);
    outputs().set_number(2, 1.0f); // searched
    const fef::TermFieldMatchData *tfmd = _md->resolveTermField(_fieldHandle);
    if (tfmd->getDocId() == docId) {
        outputs().set_number(3, 1.0f); // hit
    } else {
        outputs().set_number(3, 0.0f); // no hit
    }
    fef::FieldPositionsIterator itr = tfmd->getIterator();
    outputs().set_number(4, itr.getFieldLength());
    if (itr.valid()) {
        uint32_t first = itr.getPosition();
        uint32_t last  = 0;
        uint32_t cnt   = 0;
        for (; itr.valid(); itr.next()) {
            last = itr.getPosition();
            ++cnt;
        }
        outputs().set_number(5, first);
        outputs().set_number(6, last);
        outputs().set_number(7, cnt);
    } else {
        outputs().set_number(5, fef::FieldPositionsIterator::UNKNOWN_LENGTH); // first
        outputs().set_number(6, fef::FieldPositionsIterator::UNKNOWN_LENGTH); // last
        outputs().set_number(7, 0.0f);
    }
}

void
IndexFieldInfoExecutor::handle_bind_match_data(const fef::MatchData &md)
{
    _md = &md;
}

//-----------------------------------------------------------------------------

AttrFieldInfoExecutor::AttrFieldInfoExecutor(feature_t type, uint32_t fieldHandle) :
    FeatureExecutor(),
    _type(type),
    _fieldHandle(fieldHandle),
    _md(nullptr)
{
    // empty
}

void
AttrFieldInfoExecutor::execute(uint32_t docId)
{
    outputs().set_number(0, _type);
    outputs().set_number(1, 0.0); // not filter
    outputs().set_number(2, 1.0f); // searched
    const fef::TermFieldMatchData *tfmd = _md->resolveTermField(_fieldHandle);
    if (tfmd->getDocId() == docId) {
        outputs().set_number(3, 1.0f); // hit
        outputs().set_number(4, fef::FieldPositionsIterator::UNKNOWN_LENGTH); // len
        outputs().set_number(5, 0.0f); // first
        outputs().set_number(6, 0.0f); // last
        outputs().set_number(7, 1.0f);
    } else {
        outputs().set_number(3, 0.0f); // no hit
        outputs().set_number(4, fef::FieldPositionsIterator::UNKNOWN_LENGTH); // len
        outputs().set_number(5, fef::FieldPositionsIterator::UNKNOWN_LENGTH); // first
        outputs().set_number(6, fef::FieldPositionsIterator::UNKNOWN_LENGTH); // last
        outputs().set_number(7, 0.0f);
    }
}

void
AttrFieldInfoExecutor::handle_bind_match_data(const fef::MatchData &md)
{
    _md = &md;
}

//-----------------------------------------------------------------------------

FieldInfoBlueprint::FieldInfoBlueprint() :
    fef::Blueprint("fieldInfo"),
    _overview(false),
    _indexcnt(0.0f),
    _attrcnt(0.0f),
    _type(0.0f),
    _isFilter(0.0f),
    _fieldId(fef::IllegalFieldId)
{
    // empty
}

void
FieldInfoBlueprint::visitDumpFeatures(const fef::IIndexEnvironment &indexEnv,
                                      fef::IDumpFeatureVisitor &visitor) const
{
    if (!indexEnv.getProperties().lookup(getBaseName(), "enable").get("").empty()) {
        fef::FeatureNameBuilder fnb;
        fnb.baseName(getBaseName());
        for (uint32_t i = 0; i < indexEnv.getNumFields(); ++i) {
            const fef::FieldInfo *fi = indexEnv.getField(i);
            fnb.clearParameters().parameter(fi->name());
            fnb.output("type");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("filter");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("search");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("hit");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("len");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("first");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("last");
            visitor.visitDumpFeature(fnb.buildName());
            fnb.output("cnt");
            visitor.visitDumpFeature(fnb.buildName());
        }
        fnb.clearParameters();
        fnb.output("indexCnt");
        visitor.visitDumpFeature(fnb.buildName());
        fnb.output("attrCnt");
        visitor.visitDumpFeature(fnb.buildName());
    }
}

bool
FieldInfoBlueprint::setup(const fef::IIndexEnvironment &indexEnv,
                          const fef::ParameterList &params)
{
    if (params.empty()) {
        _overview = true;
        for (uint32_t i = 0; i < indexEnv.getNumFields(); ++i) {
            if (indexEnv.getField(i)->type() == fef::FieldType::INDEX) {
                _indexcnt += 1.0;
            }
            if (indexEnv.getField(i)->type() == fef::FieldType::ATTRIBUTE) {
                _attrcnt += 1.0;
            }
        }
        describeOutput("indexCnt", "total number of fields of type index");
        describeOutput("attrCnt", "total number of fields of type attribute");
        return true;
    }
    if (params.size() == 1) {
        vespalib::string name = params[0].getValue();
        const fef::FieldInfo *fi = indexEnv.getFieldByName(name);
        if (fi != 0) {
            _fieldId = fi->id();
            if (fi->type() == fef::FieldType::INDEX) {
                _type = 1.0;
            } else if (fi->type() == fef::FieldType::ATTRIBUTE) {
                _type = 2.0;
            }
            if (fi->isFilter()) {
                _isFilter = 1.0;
            } else {
                _isFilter = 0.0;
            }
        }
        describeOutput("type", "1.0 for INDEX, 2.0 for ATTRIBUTE, 0.0 for unknown (from index env)");
        describeOutput("filter", "1.0 if this is a filter, 0.0 otherwise (from index env)");
        describeOutput("search", "1.0 means first term searched this field, 0.0 means it did not");
        describeOutput("hit", "1.0 means first term got a hit in this field, 0.0 means it did not");
        describeOutput("len", "field length in number of words");
        describeOutput("first", "position of the first hit of the first term in this field");
        describeOutput("last", "position of the last hit of the first term in this field");
        describeOutput("cnt", "number of hits for the first term in this field");
        return true;
    }
    return false;
}

fef::FeatureExecutor &
FieldInfoBlueprint::createExecutor(const fef::IQueryEnvironment &queryEnv, vespalib::Stash &stash) const
{
    if (_overview) {
        std::vector<feature_t> values;
        values.push_back(_indexcnt);
        values.push_back(_attrcnt);
        return stash.create<ValueExecutor>(values);
    }
    uint32_t fieldHandle = util::getTermFieldHandle(queryEnv, 0, _fieldId);
    if (fieldHandle == fef::IllegalHandle) {
        std::vector<feature_t> values;
        values.push_back(_type);
        values.push_back(_isFilter);
        values.push_back(0.0f); // not searched
        values.push_back(0.0f); // no hit
        values.push_back(fef::FieldPositionsIterator::UNKNOWN_LENGTH); // default field length
        values.push_back(fef::FieldPositionsIterator::UNKNOWN_LENGTH); // default first pos
        values.push_back(fef::FieldPositionsIterator::UNKNOWN_LENGTH); // default last pos
        values.push_back(0.0f); // number of hits
        return stash.create<ValueExecutor>(values);
    }
    if (_type == 1.0) {  // index
        return stash.create<IndexFieldInfoExecutor>(_type, _isFilter, _fieldId, fieldHandle);
    } else if (_type == 2.0) {  // attribute
        return stash.create<AttrFieldInfoExecutor>(_type, fieldHandle);
    }
    std::vector<feature_t> values;
    values.push_back(_type);
    values.push_back(_isFilter);
    values.push_back(1.0f); // searched
    values.push_back(0.0f); // no hit
    values.push_back(fef::FieldPositionsIterator::UNKNOWN_LENGTH); // default field length
    values.push_back(fef::FieldPositionsIterator::UNKNOWN_LENGTH); // default first pos
    values.push_back(fef::FieldPositionsIterator::UNKNOWN_LENGTH); // default last pos
    values.push_back(0.0f); // number of hits
    return stash.create<ValueExecutor>(values);
}

}