blob: 7c233608210c036fe2ab2883e62baaad5a2831c9 (
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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "fieldsearchspec.h"
#include <vespa/vsm/common/charbuffer.h>
#include <vespa/vsm/common/document.h>
#include <vespa/vsm/common/fieldmodifier.h>
#include <vespa/vsm/searcher/utf8substringsnippetmodifier.h>
#include <vespa/document/fieldvalue/fieldvalue.h>
#include <vespa/document/fieldvalue/iteratorhandler.h>
namespace vsm {
/**
* This class is responsible for modifying field values where we have substring search and that are used
* as input to snippet generation.
*
* The class implements the FieldModifier interface to modify field values, and the IteratorHandler interface
* to traverse complex field values. Primitive field values are passed to the underlying searcher that is
* responsible for modifying the field value by inserting unit separators before and after matches.
* A record separator is inserted between primitive field values the same way as done by FlattenDocsumWriter.
**/
class SnippetModifier : public FieldModifier, public document::fieldvalue::IteratorHandler
{
private:
UTF8SubstringSnippetModifier::SP _searcher;
CharBuffer::SP _valueBuf; // buffer to store the final modified field value
char _recordSep;
bool _useSep;
document::FieldPath _empty;
void considerSeparator();
// Inherrit doc from document::FieldValue::IteratorHandler
void onPrimitive(uint32_t, const Content & c) override;
void reset();
public:
/**
* Creates a new instance.
*
* @param searcher the searcher used to modify primitive field values.
**/
SnippetModifier(const UTF8SubstringSnippetModifier::SP & searcher);
/**
* Creates a new instance.
*
* @param searcher the searcher used to modify primitive field values.
* @param valueBuf the shared buffer used to store the final modified field value.
**/
SnippetModifier(const UTF8SubstringSnippetModifier::SP & searcher, const CharBuffer::SP & valueBuf);
~SnippetModifier();
/**
* Modifies the complete given field value.
**/
document::FieldValue::UP modify(const document::FieldValue & fv) override {
return modify(fv, _empty);
}
/**
* Modifies the given field value by passing all primitive field values to the searcher and
* inserting group separators between them. A string field value is returned.
* The iterating of the field value is limited by the given field path.
*
* @param fv the field value to modify.
* @param path the field path used to iterate the field value.
* @return the new modified field value.
**/
document::FieldValue::UP modify(const document::FieldValue & fv,
const document::FieldPath & path) override;
const CharBuffer & getValueBuf() const { return *_valueBuf; }
const UTF8SubstringSnippetModifier::SP & getSearcher() const { return _searcher; }
};
/**
* This class manages a set of snippet modifiers.
* The modifiers are instantiated and prepared in the setup function.
* This class also holds shared buffers that are used by the modifiers.
**/
class SnippetModifierManager
{
private:
FieldModifierMap _modifiers;
SharedSearcherBuf _searchBuf;
CharBuffer::SP _searchModifyBuf;
SharedOffsetBuffer _searchOffsetBuf;
CharBuffer::SP _modifierBuf;
public:
SnippetModifierManager();
~SnippetModifierManager();
/**
* Setups snippet modifiers for all fields where we have substring search.
*
* @param queryTerms the query terms to take into consideration.
* @param specMap mapping from field id to search spec objects.
* @param fieldMap mapping from index (used in the query) to a list of field ids.
* @param field_paths mapping from field id to document::FieldPath.
* @param query_env query environment containg e.g. query tensors.
**/
void setup(const search::streaming::QueryTermList& queryTerms,
const FieldSearchSpecMapT& specMap,
const IndexFieldMapT& fieldMap,
const vsm::FieldPathMapT& field_paths,
search::fef::IQueryEnvironment& query_env);
const FieldModifierMap & getModifiers() const { return _modifiers; }
};
}
|
