/
IExpression.cs
228 lines (201 loc) · 9.67 KB
/
IExpression.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
//
// IExpression.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 JetBrains.Annotations;
namespace Couchbase.Lite.Query
{
/// <summary>
/// An interface representing an abstract expression that can act on
/// a given piece of data
/// </summary>
public interface IExpression
{
#region Public Methods
/// <summary>
/// Mathematically adds the given expression to the current expression
/// </summary>
/// <param name="expression">The expression to add</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Add([NotNull]IExpression expression);
/// <summary>
/// Logically "ands" the given expression with the current expression
/// </summary>
/// <param name="expression">The expression to "and"</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression And([NotNull]IExpression expression);
/// <summary>
/// Determines if the result is between the two given expressions
/// </summary>
/// <param name="expression1">The expression to use as the first bound</param>
/// <param name="expression2">The expression to use as the second bound</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Between([NotNull]IExpression expression1, [NotNull]IExpression expression2);
/// <summary>
/// Collates the previous expression using the given collation instance (normally
/// this is used directly after <see cref="Expression.Property(string)"/> when
/// it is part of a <see cref="IWhereRouter.Where(IExpression)"/> or
/// <see cref="IOrderByRouter.OrderBy(IOrdering[])"/>)
/// </summary>
/// <param name="collation">The collation instance to use when collating</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Collate([NotNull]ICollation collation);
/// <summary>
/// Matehematically divides the current and given expressions
/// </summary>
/// <param name="expression">The expression to divide</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Divide([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// and current expression are equal
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression EqualTo([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// expression is greater than the current one
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression GreaterThan([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// expression is greater than or equal to the current one
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression GreaterThanOrEqualTo([NotNull]IExpression expression);
/// <summary>
/// Returns an expression to test whether or not the given expression is contained
/// in the given list of expressions
/// </summary>
/// <param name="expressions">The list of expressions to check</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression In([ItemNotNull]params IExpression[] expressions);
/// <summary>
/// Returns an expression to test whether or not the given expression is
/// the same as the current current expression
/// </summary>
/// <param name="expression">The expression to compare to</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Is([NotNull]IExpression expression);
/// <summary>
/// Returns an expression to test whether or not the given expression is
/// NOT the same as the current current expression
/// </summary>
/// <param name="expression">The expression to compare to</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression IsNot([NotNull]IExpression expression);
/// <summary>
/// Gets an expression representing if the current expression is null
/// or missing (i.e. does not have a value)
/// </summary>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression IsNullOrMissing();
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// expression is less than the current one
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression LessThan([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// expression is less than or equal to the current one
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression LessThanOrEqualTo([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// expression is "LIKE" the current one
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Like([NotNull]IExpression expression);
/// <summary>
/// Returns an modulo math expression using the current and given expressions
/// as operands
/// </summary>
/// <param name="expression">The expression to mod with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Modulo([NotNull]IExpression expression);
/// <summary>
/// Returns a multiply expression using the current and given expressions as
/// operands
/// </summary>
/// <param name="expression">The expression to multiply with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Multiply([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// and current expression are not equal
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression NotEqualTo([NotNull]IExpression expression);
/// <summary>
/// Gets an expression representing if the current expression is neither null
/// nor missing (i.e. has a value)
/// </summary>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression NotNullOrMissing();
/// <summary>
/// Logically "ors" the given expression with the current expression
/// </summary>
/// <param name="expression">The expression to "and"</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Or([NotNull]IExpression expression);
/// <summary>
/// Returns an expression that will evaluate whether or not the given
/// expression regex matches the current one
/// </summary>
/// <param name="expression">The expression to compare with the current one</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Regex([NotNull]IExpression expression);
/// <summary>
/// Mathematically subtracts the given expression to the current expression
/// </summary>
/// <param name="expression">The expression to subtract</param>
/// <returns>The expression representing the new operation</returns>
[NotNull]
IExpression Subtract([NotNull]IExpression expression);
#endregion
}
}