-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
SearchFacetBuilder.cs
275 lines (255 loc) · 12.2 KB
/
SearchFacetBuilder.cs
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
/* Copyright 2010-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using MongoDB.Bson;
using MongoDB.Driver.Core.Misc;
namespace MongoDB.Driver.Search
{
/// <summary>
/// A builder for a search facet.
/// </summary>
/// <typeparam name="TDocument">The type of the document.</typeparam>
public sealed class SearchFacetBuilder<TDocument>
{
/// <summary>
/// Creates a facet that narrows down search result based on a date.
/// </summary>
/// <param name="name">The name of the fact.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of date values that specify the boundaries for each bucket.
/// </param>
/// <param name="default">
/// The name of an additional bucket that counts documents returned from the operator that
/// do not fall within the specified boundaries.
/// </param>
/// <returns>A date search facet.</returns>
public SearchFacet<TDocument> Date(
string name,
SearchPathDefinition<TDocument> path,
IEnumerable<DateTime> boundaries,
string @default = null) =>
new DateSearchFacet<TDocument>(name, path, boundaries, @default);
/// <summary>
/// Creates a facet that narrows down search result based on a date.
/// </summary>
/// <param name="name">The name of the fact.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of date values that specify the boundaries for each bucket.
/// </param>
/// <returns>A date search facet.</returns>
public SearchFacet<TDocument> Date(
string name,
SearchPathDefinition<TDocument> path,
params DateTime[] boundaries) =>
Date(name, path, (IEnumerable<DateTime>)boundaries);
/// <summary>
/// Creates a facet that narrows down search result based on a date.
/// </summary>
/// <typeparam name="TField">The type of the field.</typeparam>
/// <param name="name">The name of the fact.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of date values that specify the boundaries for each bucket.
/// </param>
/// <param name="default">
/// The name of an additional bucket that counts documents returned from the operator that
/// do not fall within the specified boundaries.
/// </param>
/// <returns>A date search facet.</returns>
public SearchFacet<TDocument> Date<TField>(
string name,
Expression<Func<TDocument, TField>> path,
IEnumerable<DateTime> boundaries,
string @default = null) =>
Date(name, new ExpressionFieldDefinition<TDocument>(path), boundaries, @default);
/// <summary>
/// Creates a facet that narrows down search result based on a date.
/// </summary>
/// <typeparam name="TField">The type of the field.</typeparam>
/// <param name="name">The name of the fact.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of date values that specify the boundaries for each bucket.
/// </param>
/// <returns>A date search facet.</returns>
public SearchFacet<TDocument> Date<TField>(
string name,
Expression<Func<TDocument, TField>> path,
params DateTime[] boundaries) =>
Date(name, new ExpressionFieldDefinition<TDocument>(path), boundaries);
/// <summary>
/// Creates a facet that determines the frequency of numeric values by breaking the search
/// results into separate ranges of numbers.
/// </summary>
/// <param name="name">The name of the facet.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of numeric values that specify the boundaries for each bucket.
/// </param>
/// <param name="default">
/// The name of an additional bucket that counts documents returned from the operator that
/// do not fall within the specified boundaries.
/// </param>
/// <returns>A number search facet.</returns>
public SearchFacet<TDocument> Number(
string name,
SearchPathDefinition<TDocument> path,
IEnumerable<BsonValue> boundaries,
string @default = null) =>
new NumberSearchFacet<TDocument>(name, path, boundaries, @default);
/// <summary>
/// Creates a facet that determines the frequency of numeric values by breaking the search
/// results into separate ranges of numbers.
/// </summary>
/// <param name="name">The name of the facet.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of numeric values that specify the boundaries for each bucket.
/// </param>
/// <returns>A number search facet.</returns>
public SearchFacet<TDocument> Number(
string name,
SearchPathDefinition<TDocument> path,
params BsonValue[] boundaries) =>
Number(name, path, (IEnumerable<BsonValue>)boundaries);
/// <summary>
/// Creates a facet that determines the frequency of numeric values by breaking the search
/// results into separate ranges of numbers.
/// </summary>
/// <typeparam name="TField">The type of the field.</typeparam>
/// <param name="name">The name of the facet.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of numeric values that specify the boundaries for each bucket.
/// </param>
/// <param name="default">
/// The name of an additional bucket that counts documents returned from the operator that
/// do not fall within the specified boundaries.
/// </param>
/// <returns>A number search facet.</returns>
public SearchFacet<TDocument> Number<TField>(
string name,
Expression<Func<TDocument, TField>> path,
IEnumerable<BsonValue> boundaries,
string @default = null) =>
Number(name, new ExpressionFieldDefinition<TDocument>(path), boundaries, @default);
/// <summary>
/// Creates a facet that determines the frequency of numeric values by breaking the search
/// results into separate ranges of numbers.
/// </summary>
/// <typeparam name="TField">The type of the field.</typeparam>
/// <param name="name">The name of the facet.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="boundaries">
/// A list of numeric values that specify the boundaries for each bucket.
/// </param>
/// <returns>A number search facet.</returns>
public SearchFacet<TDocument> Number<TField>(
string name,
Expression<Func<TDocument, TField>> path,
params BsonValue[] boundaries) =>
Number(name, new ExpressionFieldDefinition<TDocument>(path), boundaries);
/// <summary>
/// Creates a facet that narrows down Atlas Search results based on the most frequent
/// string values in the specified string field.
/// </summary>
/// <param name="name">The name of the facet.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="numBuckets">
/// The maximum number of facet categories to return in the results.
/// </param>
/// <returns>A string search facet.</returns>
public SearchFacet<TDocument> String(string name, SearchPathDefinition<TDocument> path, int? numBuckets = null) =>
new StringSearchFacet<TDocument>(name, path, numBuckets);
/// <summary>
/// Creates a facet that narrows down Atlas Search result based on the most frequent
/// string values in the specified string field.
/// </summary>
/// <typeparam name="TField">The type of the field.</typeparam>
/// <param name="name">The name of the facet.</param>
/// <param name="path">The field path to facet on.</param>
/// <param name="numBuckets">
/// The maximum number of facet categories to return in the results.
/// </param>
/// <returns>A string search facet.</returns>
public SearchFacet<TDocument> String<TField>(string name, Expression<Func<TDocument, TField>> path, int? numBuckets = null) =>
String(name, new ExpressionFieldDefinition<TDocument>(path), numBuckets);
}
internal sealed class DateSearchFacet<TDocument> : SearchFacet<TDocument>
{
private readonly DateTime[] _boundaries;
private readonly string _default;
private readonly SearchPathDefinition<TDocument> _path;
public DateSearchFacet(string name, SearchPathDefinition<TDocument> path, IEnumerable<DateTime> boundaries, string @default)
: base(name)
{
_path = Ensure.IsNotNull(path, nameof(path));
_boundaries = Ensure.IsNotNull(boundaries, nameof(boundaries)).ToArray();
_default = @default;
}
public override BsonDocument Render(SearchDefinitionRenderContext<TDocument> renderContext) =>
new()
{
{ "type", "date" },
{ "path", _path.Render(renderContext) },
{ "boundaries", new BsonArray(_boundaries) },
{ "default", _default, _default != null }
};
}
internal sealed class NumberSearchFacet<TDocument> : SearchFacet<TDocument>
{
private readonly BsonValue[] _boundaries;
private readonly string _default;
private readonly SearchPathDefinition<TDocument> _path;
public NumberSearchFacet(string name, SearchPathDefinition<TDocument> path, IEnumerable<BsonValue> boundaries, string @default)
: base(name)
{
_path = Ensure.IsNotNull(path, nameof(path));
_boundaries = Ensure.IsNotNull(boundaries, nameof(boundaries)).ToArray();
_default = @default;
}
public override BsonDocument Render(SearchDefinitionRenderContext<TDocument> renderContext) =>
new()
{
{ "type", "number" },
{ "path", _path.Render(renderContext) },
{ "boundaries", new BsonArray(_boundaries) },
{ "default", _default, _default != null }
};
}
internal sealed class StringSearchFacet<TDocument> : SearchFacet<TDocument>
{
private readonly int? _numBuckets;
private readonly SearchPathDefinition<TDocument> _path;
public StringSearchFacet(string name, SearchPathDefinition<TDocument> path, int? numBuckets = null)
: base(name)
{
_path = Ensure.IsNotNull(path, nameof(path));
_numBuckets = Ensure.IsNullOrBetween(numBuckets, 1, 1000, nameof(numBuckets));
}
public override BsonDocument Render(SearchDefinitionRenderContext<TDocument> renderContext) =>
new()
{
{ "type", "string" },
{ "path", _path.Render(renderContext) },
{ "numBuckets", _numBuckets, _numBuckets != null }
};
}
}