-
Notifications
You must be signed in to change notification settings - Fork 126
/
Expression.cs
180 lines (158 loc) · 7.78 KB
/
Expression.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
//
// Expression.cs
//
// Copyright (c) 2017 Couchbase, Inc All rights reserved.
//
// 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;
using System.Collections.Generic;
using Couchbase.Lite.Internal.Logging;
using Couchbase.Lite.Internal.Query;
using Couchbase.Lite.Util;
using JetBrains.Annotations;
namespace Couchbase.Lite.Query
{
/// <summary>
/// A factory for unary IExpression operators
/// </summary>
public static class Expression
{
#region Constants
private const string Tag = nameof(Expression);
#endregion
#region Public Methods
/// <summary>
/// Returns an expression to represent '*' in things like COUNT(*) and
/// SELECT *
/// </summary>
/// <returns>The expression representing '*'</returns>
[NotNull]
public static IPropertyExpression All() => new QueryTypeExpression("", ExpressionType.KeyPath);
/// <summary>
/// Returns an expression to represent a fixed array value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Array(IList value) => new QueryConstantExpression<IList>(value);
/// <summary>
/// Returns an expression to represent a fixed <see cref="bool"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Boolean(bool value) => new QueryConstantExpression<bool>(value);
/// <summary>
/// Returns an expression to represent a fixed <see cref="DateTimeOffset"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Date(DateTimeOffset value) => new QueryConstantExpression<string>(value.ToString("o")); //#1052 workaround
/// <summary>
/// Returns an expression to represent a fixed <see cref="IDictionary{TKey,TValue}"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Dictionary(IDictionary<string, object> value) => new QueryConstantExpression<IDictionary<string, object>>(value);
/// <summary>
/// Returns an expression to represent a fixed <see cref="double"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Double(double value) => new QueryConstantExpression<double>(value);
/// <summary>
/// Returns an expression to represent a fixed <see cref="Single"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Float(float value) => new QueryConstantExpression<float>(value);
/// <summary>
/// Returns an expression to represent a full text index to use when performing FTS queries
/// </summary>
/// <param name="name">The name of the index</param>
/// <returns>An expression representing the index</returns>
[NotNull]
public static IFullTextIndexExpression FullTextIndex(string name) => new FullTextIndexExpression(name);
/// <summary>
/// Returns an expression to represent a fixed <see cref="Int32"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Int(int value) => new QueryConstantExpression<int>(value);
/// <summary>
/// Returns an expression to represent a fixed <see cref="Int64"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Long(long value) => new QueryConstantExpression<long>(value);
/// <summary>
/// Returns an expression representing the negated result of an expression
/// </summary>
/// <param name="expression">The expression to evaluate</param>
/// <returns>The negated result of the expression</returns>
[NotNull]
public static IExpression Negated([NotNull]IExpression expression) =>
new QueryCompoundExpression("NOT", CBDebug.MustNotBeNull(WriteLog.To.Query, Tag, nameof(expression), expression));
/// <summary>
/// Returns an expression representing the negated result of an expression
/// </summary>
/// <param name="expression">The expression to evaluate</param>
/// <returns>The negated result of the expression</returns>
[NotNull]
public static IExpression Not([NotNull]IExpression expression) =>
Negated(CBDebug.MustNotBeNull(WriteLog.To.Query, Tag, nameof(expression), expression));
/// <summary>
/// Gets an expression representing a named parameter (as set in
/// <see cref="IQuery.Parameters"/>) for use in a query
/// </summary>
/// <param name="name">The name of the parameter in the parameter set</param>
/// <returns>The expression representing the parameter</returns>
[NotNull]
public static IExpression Parameter([NotNull]string name) =>
new QueryTypeExpression(CBDebug.MustNotBeNull(WriteLog.To.Query, Tag, nameof(name), name),
ExpressionType.Parameter);
/// <summary>
/// Returns an expression representing the value of a named property
/// </summary>
/// <param name="property">The name of the property to fetch</param>
/// <returns>An expression representing the value of a named property</returns>
[NotNull]
public static IPropertyExpression Property([NotNull]string property) =>
new QueryTypeExpression(CBDebug.MustNotBeNull(WriteLog.To.Query, Tag, nameof(property), property),
ExpressionType.KeyPath);
/// <summary>
/// Returns an expression to represent a fixed <see cref="string"/> value
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression String(string value) => new QueryConstantExpression<string>(value);
/// <summary>
/// Returns an expression to represent a fixed <see cref="Object"/> value. It must be one
/// of the allowed types (i.e. the ones allowed in other methods such as <see cref="String"/>
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>An expression representing the fixed value</returns>
[NotNull]
public static IExpression Value(object value) => new QueryConstantExpression<object>(value);
#endregion
}
}