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
|
/**
* Copyright (C) 2015 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/db/matcher/expression_leaf.h"
namespace mongo {
namespace fts {
class FTSQuery;
} // namespace fts
/**
* Common base class for $text match expression implementations.
*/
class TextMatchExpressionBase : public LeafMatchExpression {
public:
struct TextParams {
std::string query;
std::string language;
bool caseSensitive;
bool diacriticSensitive;
};
static const bool kCaseSensitiveDefault;
static const bool kDiacriticSensitiveDefault;
TextMatchExpressionBase();
/**
* Returns a reference to the parsed text query that this TextMatchExpressionBase owns.
*/
virtual const fts::FTSQuery& getFTSQuery() const = 0;
//
// Methods inherited from MatchExpression.
//
bool matchesSingleElement(const BSONElement& e) const final {
// Text match expressions force the selection of the text index and always generate EXACT
// index bounds (which causes the MatchExpression node to be trimmed), so we don't currently
// implement any explicit text matching logic here. SERVER-17648 tracks the work to
// implement a real text matcher.
//
// TODO: simply returning 'true' here isn't quite correct. First, we should be overriding
// matches() instead of matchesSingleElement(), because the latter is only ever called if
// the matched document has an element with path "_fts". Second, there are scenarios where
// we will use the untrimmed expression tree for matching (for example, when deciding
// whether or not to retry an operation that throws WriteConflictException); in those cases,
// we won't be able to correctly determine whether or not the object matches the expression.
return true;
}
void debugString(StringBuilder& debug, int level = 0) const final;
void serialize(BSONObjBuilder* out) const final;
bool equivalent(const MatchExpression* other) const final;
};
} // namespace mongo
|