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
|
/**
* Copyright (C) 2012 10gen 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 <map>
#include <string>
#include <vector>
#include "mongo/base/status_with.h"
#include "mongo/db/fts/fts_language.h"
#include "mongo/db/fts/fts_util.h"
#include "mongo/db/fts/stemmer.h"
#include "mongo/db/fts/stop_words.h"
#include "mongo/db/fts/tokenizer.h"
#include "mongo/stdx/unordered_map.h"
#include "mongo/util/string_map.h"
namespace mongo {
namespace fts {
extern const double MAX_WEIGHT;
extern const double MAX_WORD_WEIGHT;
extern const double DEFAULT_WEIGHT;
typedef std::map<std::string, double> Weights; // TODO cool map
typedef stdx::unordered_map<std::string, double> TermFrequencyMap;
struct ScoreHelperStruct {
ScoreHelperStruct() : freq(0), count(0), exp(0) {}
double freq;
double count;
double exp;
};
typedef StringMap<ScoreHelperStruct> ScoreHelperMap;
class FTSSpec {
struct Tools {
Tools(const FTSLanguage& _language, const Stemmer* _stemmer, const StopWords* _stopwords)
: language(_language), stemmer(_stemmer), stopwords(_stopwords) {}
const FTSLanguage& language;
const Stemmer* stemmer;
const StopWords* stopwords;
};
public:
FTSSpec(const BSONObj& indexInfo);
bool wildcard() const {
return _wildcard;
}
const FTSLanguage& defaultLanguage() const {
return *_defaultLanguage;
}
const std::string& languageOverrideField() const {
return _languageOverrideField;
}
size_t numExtraBefore() const {
return _extraBefore.size();
}
const std::string& extraBefore(unsigned i) const {
return _extraBefore[i];
}
size_t numExtraAfter() const {
return _extraAfter.size();
}
const std::string& extraAfter(unsigned i) const {
return _extraAfter[i];
}
/**
* Calculates term/score pairs for a BSONObj as applied to this spec.
* @arg obj document to traverse; can be a subdocument or array
* @arg term_freqs output parameter to store (term,score) results
*/
void scoreDocument(const BSONObj& obj, TermFrequencyMap* term_freqs) const;
/**
* given a query, pulls out the pieces (in order) that go in the index first
*/
Status getIndexPrefix(const BSONObj& filter, BSONObj* out) const;
const Weights& weights() const {
return _weights;
}
static StatusWith<BSONObj> fixSpec(const BSONObj& spec);
/**
* Returns text index version.
*/
TextIndexVersion getTextIndexVersion() const {
return _textIndexVersion;
}
private:
//
// Helper methods. Invoked for TEXT_INDEX_VERSION_2 spec objects only.
//
/**
* Calculate the term scores for 'raw' and update 'term_freqs' with the result. Parses
* 'raw' using 'tools', and weights term scores based on 'weight'.
*/
void _scoreStringV2(FTSTokenizer* tokenizer,
StringData raw,
TermFrequencyMap* term_freqs,
double weight) const;
public:
/**
* Get the language override for the given BSON doc. If no language override is
* specified, returns currentLanguage.
*/
const FTSLanguage* _getLanguageToUseV2(const BSONObj& userDoc,
const FTSLanguage* currentLanguage) const;
private:
//
// Deprecated helper methods. Invoked for TEXT_INDEX_VERSION_1 spec objects only.
//
void _scoreStringV1(const Tools& tools,
StringData raw,
TermFrequencyMap* docScores,
double weight) const;
bool _weightV1(StringData field, double* out) const;
void _scoreRecurseV1(const Tools& tools,
const BSONObj& obj,
TermFrequencyMap* term_freqs) const;
void _scoreDocumentV1(const BSONObj& obj, TermFrequencyMap* term_freqs) const;
const FTSLanguage& _getLanguageToUseV1(const BSONObj& userDoc) const;
static StatusWith<BSONObj> _fixSpecV1(const BSONObj& spec);
//
// Instance variables.
//
TextIndexVersion _textIndexVersion;
const FTSLanguage* _defaultLanguage;
std::string _languageOverrideField;
bool _wildcard;
// mapping : fieldname -> weight
Weights _weights;
// Prefix compound key - used to partition search index
std::vector<std::string> _extraBefore;
// Suffix compound key - used for covering index behavior
std::vector<std::string> _extraAfter;
};
} // namespace fts
} // namespace mongo
|
