summaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/features/matchcountfeature.h
blob: 23c60d4f86719de8f44244bd9346dbf230bbf9a2 (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
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <vespa/searchlib/fef/blueprint.h>
#include <vespa/searchlib/fef/featureexecutor.h>

namespace search {
namespace features {

/**
 * Implements the executor for the matchCount feature for index and
 * attribute fields.
 */
class MatchCountExecutor : public fef::FeatureExecutor
{
private:
    std::vector<fef::TermFieldHandle> _handles;
    const fef::MatchData             *_md;

    virtual void handle_bind_match_data(fef::MatchData &md) override;

public:
    MatchCountExecutor(uint32_t fieldId, const fef::IQueryEnvironment &env);
    void execute(uint32_t docId) override;
};

/**
 * Implements the blueprint for the matchCount executor.
 *
 * matchCount(name)
 *  - returns number of matches of the query in the particular field.
 */
class MatchCountBlueprint : public fef::Blueprint
{
private:
    const fef::FieldInfo *_field;

public:
    MatchCountBlueprint();

    void visitDumpFeatures(const fef::IIndexEnvironment & env,
                           fef::IDumpFeatureVisitor & visitor) const override;

    fef::Blueprint::UP createInstance() const override;

    fef::ParameterDescriptions getDescriptions() const override {
        return fef::ParameterDescriptions().desc().field();
    }

    bool setup(const fef::IIndexEnvironment & env,
               const fef::ParameterList & params) override;

    fef::FeatureExecutor &createExecutor(const fef::IQueryEnvironment &env, vespalib::Stash &stash) const override;
};

} // namespace features
} // namespace search