-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
SearchPathDefinition.cs
115 lines (105 loc) · 5.06 KB
/
SearchPathDefinition.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
/* 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.Collections.Generic;
using System.Linq;
using MongoDB.Bson;
namespace MongoDB.Driver.Search
{
/// <summary>
/// Base class for search paths.
/// </summary>
/// <typeparam name="TDocument">The type of the document.</typeparam>
public abstract class SearchPathDefinition<TDocument>
{
/// <summary>
/// Renders the path to a <see cref="BsonValue"/>.
/// </summary>
/// <param name="renderContext">The render context.</param>
/// <returns>A <see cref="BsonValue"/>.</returns>
public abstract BsonValue Render(SearchDefinitionRenderContext<TDocument> renderContext);
/// <summary>
/// Performs an implicit conversion from <see cref="FieldDefinition{TDocument}"/> to
/// <see cref="SearchPathDefinition{TDocument}"/>.
/// </summary>
/// <param name="field">The field.</param>
/// <returns>
/// The result of the conversion.
/// </returns>
public static implicit operator SearchPathDefinition<TDocument>(FieldDefinition<TDocument> field) =>
new SingleSearchPathDefinition<TDocument>(field);
/// <summary>
/// Performs an implicit conversion from a field name to <see cref="SearchPathDefinition{TDocument}"/>.
/// </summary>
/// <param name="fieldName">The field name.</param>
/// <returns>
/// The result of the conversion.
/// </returns>
public static implicit operator SearchPathDefinition<TDocument>(string fieldName) =>
new SingleSearchPathDefinition<TDocument>(new StringFieldDefinition<TDocument>(fieldName));
/// <summary>
/// Performs an implicit conversion from an array of <see cref="FieldDefinition{TDocument}"/> to
/// <see cref="SearchPathDefinition{TDocument}"/>.
/// </summary>
/// <param name="fields">The array of fields.</param>
/// <returns>
/// The result of the conversion.
/// </returns>
public static implicit operator SearchPathDefinition<TDocument>(FieldDefinition<TDocument>[] fields) =>
new MultiSearchPathDefinition<TDocument>(fields);
/// <summary>
/// Performs an implicit conversion from a list of <see cref="FieldDefinition{TDocument}"/> to
/// <see cref="SearchPathDefinition{TDocument}"/>.
/// </summary>
/// <param name="fields">The list of fields.</param>
/// <returns>
/// The result of the conversion.
/// </returns>
public static implicit operator SearchPathDefinition<TDocument>(List<FieldDefinition<TDocument>> fields) =>
new MultiSearchPathDefinition<TDocument>(fields);
/// <summary>
/// Performs an implicit conversion from an array of field names to
/// <see cref="SearchPathDefinition{TDocument}"/>.
/// </summary>
/// <param name="fieldNames">The array of field names.</param>
/// <returns>
/// The result of the conversion.
/// </returns>
public static implicit operator SearchPathDefinition<TDocument>(string[] fieldNames) =>
new MultiSearchPathDefinition<TDocument>(fieldNames.Select(fieldName => new StringFieldDefinition<TDocument>(fieldName)));
/// <summary>
/// Performs an implicit conversion from an array of field names to
/// <see cref="SearchPathDefinition{TDocument}"/>.
/// </summary>
/// <param name="fieldNames">The list of field names.</param>
/// <returns>
/// The result of the conversion.
/// </returns>
public static implicit operator SearchPathDefinition<TDocument>(List<string> fieldNames) =>
new MultiSearchPathDefinition<TDocument>(fieldNames.Select(fieldName => new StringFieldDefinition<TDocument>(fieldName)));
/// <summary>
/// Renders the field.
/// </summary>
/// <param name="fieldDefinition">The field definition.</param>
/// <param name="renderContext">The render context.</param>
/// <returns>The rendered field.</returns>
protected string RenderField(FieldDefinition<TDocument> fieldDefinition, SearchDefinitionRenderContext<TDocument> renderContext)
{
var renderedField = fieldDefinition.Render(renderContext.DocumentSerializer, renderContext.SerializerRegistry);
return renderContext.PathPrefix == null ?
renderedField.FieldName :
$"{renderContext.PathPrefix}.{renderedField.FieldName}";
}
}
}