aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/aggregation/hitsaggregationresult.h
blob: 300590789203c7f664f7e615c4bb76c9386335f6 (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include "aggregationresult.h"
#include "hitlist.h"
#include <vespa/searchlib/expression/floatresultnode.h>

namespace search::aggregation {

class HitsAggregationResult : public AggregationResult
{
public:
    using FloatResultNode = expression::FloatResultNode;
    using SummaryClassType = vespalib::string;

    class SummaryGenerator
    {
    public:
        virtual ~SummaryGenerator() { }
        virtual vespalib::ConstBufferRef fillSummary(DocId lid, const SummaryClassType & summaryClass) = 0;
    };

private:
    void onPrepare(const ResultNode & result, bool useForInit) override;
    void onAggregate(const ResultNode &result, DocId docId, HitRank rank) override;
    void onAggregate(const ResultNode &result, const document::Document & doc, HitRank rank) override;
    const ResultNode & onGetRank() const override;

    SummaryClassType          _summaryClass;
    uint32_t                  _maxHits;
    HitList                   _hits;
    bool                      _isOrdered;
    mutable FloatResultNode   _bestHitRank;
    SummaryGenerator         *_summaryGenerator;

public:
    class SetOrdered : public vespalib::ObjectOperation, public vespalib::ObjectPredicate
    {
    private:
        void execute(vespalib::Identifiable &obj) override { static_cast<HitsAggregationResult &>(obj)._isOrdered = true; }
        bool check(const vespalib::Identifiable &obj) const override { return obj.getClass().inherits(HitsAggregationResult::classId); }
    };

    DECLARE_AGGREGATIONRESULT(HitsAggregationResult);
    HitsAggregationResult();
    HitsAggregationResult(HitsAggregationResult &&) noexcept;
    HitsAggregationResult & operator=(HitsAggregationResult &&) noexcept;
    HitsAggregationResult(const HitsAggregationResult &);
    HitsAggregationResult & operator=(const HitsAggregationResult &);
    ~HitsAggregationResult() override;
    void postMerge() override { _hits.postMerge(_maxHits); }
    void setSummaryGenerator(SummaryGenerator & summaryGenerator) { _summaryGenerator = &summaryGenerator; }
    const SummaryClassType & getSummaryClass() const { return _summaryClass; }
    HitsAggregationResult setSummaryClass(const SummaryClassType & summaryClass) { _summaryClass = summaryClass; return *this; }
    HitsAggregationResult &setMaxHits(uint32_t maxHits) {
        _maxHits = (maxHits == 0) ? std::numeric_limits<uint32_t>::max() : maxHits;
        return *this;
    }
    HitsAggregationResult & addHit(const FS4Hit &hit) { _hits.addHit(hit, _maxHits); return *this; }
    HitsAggregationResult & addHit(const VdsHit &hit) { _hits.addHit(hit, _maxHits); return *this; }
    void visitMembers(vespalib::ObjectVisitor &visitor) const override;
    void selectMembers(const vespalib::ObjectPredicate &predicate, vespalib::ObjectOperation &operation) override;
    HitsAggregationResult & sort() { _hits.sort(); return *this; }
    const ResultNode * getResult() const override { return &_hits; }
    ResultNode & getResult() override { return _hits; }
};

}