-
Notifications
You must be signed in to change notification settings - Fork 349
/
EdmValueUtils.cs
395 lines (337 loc) · 17 KB
/
EdmValueUtils.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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
//---------------------------------------------------------------------
// <copyright file="EdmValueUtils.cs" company="Microsoft">
// Copyright (C) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
// </copyright>
//---------------------------------------------------------------------
using System;
using System.Diagnostics;
using Microsoft.OData.Edm;
using Microsoft.OData.Edm.Vocabularies;
using Microsoft.Spatial;
#if ODATA_CLIENT
using Microsoft.OData;
using ErrorStrings = Microsoft.OData.Client.Strings;
using PlatformHelpers = Microsoft.OData.Client.PlatformHelper;
#else
using ErrorStrings = Microsoft.OData.Strings;
using PlatformHelpers = Microsoft.OData.PlatformHelper;
#endif
#if ODATA_CLIENT
namespace Microsoft.OData.Client
#else
namespace Microsoft.OData.Evaluation
#endif
{
/// <summary>
/// Class with utility methods to deal with EDM values
/// </summary>
internal static class EdmValueUtils
{
/// <summary>
/// Converts a primitive OData value to the corresponding <see cref="IEdmDelayedValue"/>.
/// </summary>
/// <param name="primitiveValue">The primitive OData value to convert.</param>
/// <param name="type">The <see cref="IEdmTypeReference"/> for the primitive value (if available).</param>
/// <returns>An <see cref="IEdmDelayedValue"/> for the <paramref name="primitiveValue"/>.</returns>
internal static IEdmDelayedValue ConvertPrimitiveValue(object primitiveValue, IEdmPrimitiveTypeReference type)
{
Debug.Assert(primitiveValue != null, "primitiveValue != null");
if (primitiveValue is Boolean)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Boolean);
return new EdmBooleanConstant(type, (bool)primitiveValue);
}
if (primitiveValue is Byte)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Byte);
return new EdmIntegerConstant(type, (byte)primitiveValue);
}
if (primitiveValue is SByte)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.SByte);
return new EdmIntegerConstant(type, (sbyte)primitiveValue);
}
if (primitiveValue is Int16)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Int16);
return new EdmIntegerConstant(type, (Int16)primitiveValue);
}
if (primitiveValue is Int32)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Int32);
return new EdmIntegerConstant(type, (Int32)primitiveValue);
}
if (primitiveValue is Int64)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Int64);
return new EdmIntegerConstant(type, (Int64)primitiveValue);
}
if (primitiveValue is Decimal)
{
var decimalType =
(IEdmDecimalTypeReference)EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Decimal);
return new EdmDecimalConstant(decimalType, (decimal)primitiveValue);
}
if (primitiveValue is Single)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Single);
return new EdmFloatingConstant(type, (Single)primitiveValue);
}
if (primitiveValue is Double)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Double);
return new EdmFloatingConstant(type, (Double)primitiveValue);
}
var str = primitiveValue as string;
if (str != null)
{
var stringType =
(IEdmStringTypeReference)EnsurePrimitiveType(type, EdmPrimitiveTypeKind.String);
return new EdmStringConstant(stringType, str);
}
return ConvertPrimitiveValueWithoutTypeCode(primitiveValue, type);
}
/// <summary>
/// Gets the clr value of the edm value based on its type.
/// </summary>
/// <param name="edmValue">The edm value.</param>
/// <returns>The clr value</returns>
internal static object ToClrValue(this IEdmPrimitiveValue edmValue)
{
Debug.Assert(edmValue != null, "edmValue != null");
EdmPrimitiveTypeKind primitiveKind = edmValue.Type.PrimitiveKind();
switch (edmValue.ValueKind)
{
case EdmValueKind.Binary:
return ((IEdmBinaryValue)edmValue).Value;
case EdmValueKind.Boolean:
return ((IEdmBooleanValue)edmValue).Value;
case EdmValueKind.DateTimeOffset:
return ((IEdmDateTimeOffsetValue)edmValue).Value;
case EdmValueKind.Decimal:
return ((IEdmDecimalValue)edmValue).Value;
case EdmValueKind.Guid:
return ((IEdmGuidValue)edmValue).Value;
case EdmValueKind.String:
return ((IEdmStringValue)edmValue).Value;
case EdmValueKind.Duration:
return ((IEdmDurationValue)edmValue).Value;
case EdmValueKind.Floating:
return ConvertFloatingValue((IEdmFloatingValue)edmValue, primitiveKind);
case EdmValueKind.Integer:
return ConvertIntegerValue((IEdmIntegerValue)edmValue, primitiveKind);
case EdmValueKind.Date:
return ((IEdmDateValue)edmValue).Value;
case EdmValueKind.TimeOfDay:
return ((IEdmTimeOfDayValue)edmValue).Value;
}
throw new ODataException(ErrorStrings.EdmValueUtils_CannotConvertTypeToClrValue(edmValue.ValueKind));
}
#if !ODATA_CLIENT
/// <summary>
/// Tries to get a stream property of the specified name.
/// </summary>
/// <param name="entityInstance">The instance of the entity to get the stream property for.</param>
/// <param name="streamPropertyName">The stream property name to find.</param>
/// <param name="streamProperty">The stream property found.</param>
/// <returns>true if the stream property was found or if the stream property name was null (default stream).
/// false if the stream property doesn't exist.</returns>
internal static bool TryGetStreamProperty(IEdmStructuredValue entityInstance, string streamPropertyName, out IEdmProperty streamProperty)
{
Debug.Assert(entityInstance != null, "entityInstance != null");
streamProperty = null;
if (streamPropertyName != null)
{
streamProperty = entityInstance.Type.AsEntity().FindProperty(streamPropertyName);
if (streamProperty == null)
{
return false;
}
}
return true;
}
/// <summary>
/// Gets the the CLR value for a primitive property.
/// </summary>
/// <param name="structuredValue">The structured value.</param>
/// <param name="propertyName">Name of the property.</param>
/// <returns>The clr value of the property.</returns>
internal static object GetPrimitivePropertyClrValue(this IEdmStructuredValue structuredValue, string propertyName)
{
Debug.Assert(structuredValue != null, "entityInstance != null");
IEdmStructuredTypeReference valueType = structuredValue.Type.AsStructured();
IEdmPropertyValue propertyValue = structuredValue.FindPropertyValue(propertyName);
if (propertyValue == null)
{
throw new ODataException(ErrorStrings.EdmValueUtils_PropertyDoesntExist(valueType.FullName(), propertyName));
}
if (propertyValue.Value.ValueKind == EdmValueKind.Null)
{
return null;
}
IEdmPrimitiveValue primitiveValue = propertyValue.Value as IEdmPrimitiveValue;
if (primitiveValue == null)
{
throw new ODataException(ErrorStrings.EdmValueUtils_NonPrimitiveValue(propertyValue.Name, valueType.FullName()));
}
return primitiveValue.ToClrValue();
}
#endif
/// <summary>
/// Converts a floating-point edm value to a clr value
/// </summary>
/// <param name="floatingValue">The edm floating-point value.</param>
/// <param name="primitiveKind">Kind of the primitive.</param>
/// <returns>The converted value</returns>
private static object ConvertFloatingValue(IEdmFloatingValue floatingValue, EdmPrimitiveTypeKind primitiveKind)
{
Debug.Assert(floatingValue != null, "floatingValue != null");
double doubleValue = floatingValue.Value;
if (primitiveKind == EdmPrimitiveTypeKind.Single)
{
return Convert.ToSingle(doubleValue);
}
Debug.Assert(primitiveKind == EdmPrimitiveTypeKind.Double, "primitiveKind == EdmPrimitiveTypeKind.Double");
return doubleValue;
}
/// <summary>
/// Converts an integer edm value to a clr value.
/// </summary>
/// <param name="integerValue">The integer value.</param>
/// <param name="primitiveKind">Kind of the primitive.</param>
/// <returns>The converted value</returns>
private static object ConvertIntegerValue(IEdmIntegerValue integerValue, EdmPrimitiveTypeKind primitiveKind)
{
Debug.Assert(integerValue != null, "integerValue != null");
long longValue = integerValue.Value;
switch (primitiveKind)
{
case EdmPrimitiveTypeKind.Int16:
return Convert.ToInt16(longValue);
case EdmPrimitiveTypeKind.Int32:
return Convert.ToInt32(longValue);
case EdmPrimitiveTypeKind.Byte:
return Convert.ToByte(longValue);
case EdmPrimitiveTypeKind.SByte:
return Convert.ToSByte(longValue);
default:
Debug.Assert(primitiveKind == EdmPrimitiveTypeKind.Int64, "primitiveKind == EdmPrimitiveTypeKind.Int64");
return longValue;
}
}
/// <summary>
/// Convert a primitive value which didn't match any of the known values of the TypeCode enumeration.
/// </summary>
/// <param name="primitiveValue">The value to convert.</param>
/// <param name="type">The expected primitive type or null.</param>
/// <returns>The converted value.</returns>
private static IEdmDelayedValue ConvertPrimitiveValueWithoutTypeCode(object primitiveValue, IEdmPrimitiveTypeReference type)
{
byte[] bytes = primitiveValue as byte[];
if (bytes != null)
{
IEdmBinaryTypeReference binaryType = (IEdmBinaryTypeReference)EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Binary);
return new EdmBinaryConstant(binaryType, bytes);
}
if (primitiveValue is Date)
{
IEdmPrimitiveTypeReference dateType = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Date);
return new EdmDateConstant(dateType, (Date)primitiveValue);
}
if (primitiveValue is DateTimeOffset)
{
IEdmTemporalTypeReference dateTimeOffsetType = (IEdmTemporalTypeReference)EnsurePrimitiveType(type, EdmPrimitiveTypeKind.DateTimeOffset);
return new EdmDateTimeOffsetConstant(dateTimeOffsetType, (DateTimeOffset)primitiveValue);
}
if (primitiveValue is Guid)
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Guid);
return new EdmGuidConstant(type, (Guid)primitiveValue);
}
if (primitiveValue is TimeOfDay)
{
IEdmTemporalTypeReference timeOfDayType = (IEdmTemporalTypeReference)EnsurePrimitiveType(type, EdmPrimitiveTypeKind.TimeOfDay);
return new EdmTimeOfDayConstant(timeOfDayType, (TimeOfDay)primitiveValue);
}
if (primitiveValue is TimeSpan)
{
IEdmTemporalTypeReference timeType = (IEdmTemporalTypeReference)EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Duration);
return new EdmDurationConstant(timeType, (TimeSpan)primitiveValue);
}
if (primitiveValue is ISpatial)
{
// TODO: [JsonLight] Add support for spatial values in ODataEdmStructuredValue
throw new NotImplementedException();
}
#if ODATA_CLIENT
IEdmDelayedValue convertPrimitiveValueWithoutTypeCode;
if (TryConvertClientSpecificPrimitiveValue(primitiveValue, type, out convertPrimitiveValueWithoutTypeCode))
{
return convertPrimitiveValueWithoutTypeCode;
}
#endif
throw new ODataException(ErrorStrings.EdmValueUtils_UnsupportedPrimitiveType(primitiveValue.GetType().FullName));
}
#if ODATA_CLIENT
/// <summary>
/// Tries to convert the given value if it is of a type specific to the client library but still able to be mapped to EDM.
/// </summary>
/// <param name="primitiveValue">The value to convert.</param>
/// <param name="type">The expected type of the value or null.</param>
/// <param name="convertedValue">The converted value, if conversion was possible.</param>
/// <returns>Whether or not conversion was possible.</returns>
private static bool TryConvertClientSpecificPrimitiveValue(object primitiveValue, IEdmPrimitiveTypeReference type, out IEdmDelayedValue convertedValue)
{
byte[] byteArray;
if (ClientConvert.TryConvertBinaryToByteArray(primitiveValue, out byteArray))
{
type = EnsurePrimitiveType(type, EdmPrimitiveTypeKind.Binary);
convertedValue = new EdmBinaryConstant((IEdmBinaryTypeReference)type, byteArray);
return true;
}
PrimitiveType clientPrimitiveType;
if (PrimitiveType.TryGetPrimitiveType(primitiveValue.GetType(), out clientPrimitiveType))
{
type = EnsurePrimitiveType(type, clientPrimitiveType.PrimitiveKind);
if (clientPrimitiveType.PrimitiveKind == EdmPrimitiveTypeKind.String)
{
{
convertedValue = new EdmStringConstant((IEdmStringTypeReference)type, clientPrimitiveType.TypeConverter.ToString(primitiveValue));
return true;
}
}
}
convertedValue = null;
return false;
}
#endif
/// <summary>
/// Ensures a primitive type reference for a given primitive type kind.
/// </summary>
/// <param name="type">The possibly null type reference.</param>
/// <param name="primitiveKindFromValue">The primitive type kind to ensure.</param>
/// <returns>An <see cref="IEdmPrimitiveTypeReference"/> instance created for the <paramref name="primitiveKindFromValue"/>
/// if <paramref name="type"/> is null; if <paramref name="type"/> is not null, validates it and then returns it.</returns>
private static IEdmPrimitiveTypeReference EnsurePrimitiveType(IEdmPrimitiveTypeReference type, EdmPrimitiveTypeKind primitiveKindFromValue)
{
if (type == null)
{
type = EdmCoreModel.Instance.GetPrimitive(primitiveKindFromValue, /*isNullable*/ true);
}
else
{
EdmPrimitiveTypeKind primitiveKindFromType = type.PrimitiveDefinition().PrimitiveKind;
if (primitiveKindFromType != primitiveKindFromValue)
{
string typeName = type.FullName();
if (typeName == null)
{
throw new ODataException(ErrorStrings.EdmValueUtils_IncorrectPrimitiveTypeKindNoTypeName(primitiveKindFromType.ToString(), primitiveKindFromValue.ToString()));
}
throw new ODataException(ErrorStrings.EdmValueUtils_IncorrectPrimitiveTypeKind(typeName, primitiveKindFromValue.ToString(), primitiveKindFromType.ToString()));
}
}
return type;
}
}
}