/
RealmObject.cs
663 lines (538 loc) · 27.9 KB
/
RealmObject.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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
////////////////////////////////////////////////////////////////////////////
//
// Copyright 2016 Realm 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.ComponentModel;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using Realms.DataBinding;
using Realms.Helpers;
using Realms.Schema;
namespace Realms
{
/// <summary>
/// Base for any object that can be persisted in a <see cref="Realm"/>.
/// </summary>
[Preserve(AllMembers = true, Conditional = false)]
public class RealmObject : INotifyPropertyChanged, ISchemaSource, IThreadConfined, NotificationsHelper.INotifiable, IReflectableType
{
private Realm _realm;
private ObjectHandle _objectHandle;
private Metadata _metadata;
private NotificationTokenHandle _notificationToken;
private event PropertyChangedEventHandler _propertyChanged;
/// <inheritdoc />
public event PropertyChangedEventHandler PropertyChanged
{
add
{
if (IsManaged && _propertyChanged == null)
{
SubscribeForNotifications();
}
_propertyChanged += value;
}
remove
{
_propertyChanged -= value;
if (IsManaged &&
_propertyChanged == null)
{
UnsubscribeFromNotifications();
}
}
}
internal ObjectHandle ObjectHandle => _objectHandle;
internal Metadata ObjectMetadata => _metadata;
/// <summary>
/// Gets a value indicating whether the object has been associated with a Realm, either at creation or via
/// <see cref="Realm.Add"/>.
/// </summary>
/// <value><c>true</c> if object belongs to a Realm; <c>false</c> if standalone.</value>
public bool IsManaged => _realm != null;
/// <summary>
/// Gets a value indicating whether this object is managed and represents a row in the database.
/// If a managed object has been removed from the Realm, it is no longer valid and accessing properties on it
/// will throw an exception.
/// Unmanaged objects are always considered valid.
/// </summary>
/// <value><c>true</c> if managed and part of the Realm or unmanaged; <c>false</c> if managed but deleted.</value>
public bool IsValid => _objectHandle?.IsValid != false;
/// <summary>
/// Gets the <see cref="Realm"/> instance this object belongs to, or <c>null</c> if it is unmanaged.
/// </summary>
/// <value>The <see cref="Realm"/> instance this object belongs to.</value>
public Realm Realm => _realm;
/// <summary>
/// Gets the <see cref="Schema.ObjectSchema"/> instance that describes how the <see cref="Realm"/> this object belongs to sees it.
/// </summary>
/// <value>A collection of properties describing the underlying schema of this object.</value>
public ObjectSchema ObjectSchema => _metadata?.Schema;
/// <summary>
/// Gets the number of objects referring to this one via either a to-one or to-many relationship.
/// </summary>
/// <remarks>
/// This property is not observable so the <see cref="PropertyChanged"/> event will not fire when its value changes.
/// </remarks>
public int BacklinksCount => _objectHandle?.GetBacklinkCount() ?? 0;
Metadata IThreadConfined.Metadata => ObjectMetadata;
IThreadConfinedHandle IThreadConfined.Handle => ObjectHandle;
/// <inheritdoc/>
~RealmObject()
{
UnsubscribeFromNotifications();
}
internal void _SetOwner(Realm realm, ObjectHandle objectHandle, Metadata metadata)
{
_realm = realm;
_objectHandle = objectHandle;
_metadata = metadata;
if (_propertyChanged != null)
{
SubscribeForNotifications();
}
}
#region Getters
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected string GetStringValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetString(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected char GetCharValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return (char)_objectHandle.GetInt64(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected char? GetNullableCharValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return (char?)_objectHandle.GetNullableInt64(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected float GetSingleValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetSingle(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected float? GetNullableSingleValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetNullableSingle(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected double GetDoubleValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetDouble(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected double? GetNullableDoubleValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetNullableDouble(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected bool GetBooleanValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetBoolean(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected bool? GetNullableBooleanValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetNullableBoolean(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected DateTimeOffset GetDateTimeOffsetValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetDateTimeOffset(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected DateTimeOffset? GetNullableDateTimeOffsetValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetNullableDateTimeOffset(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected internal IList<T> GetListValue<T>(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_metadata.Schema.TryFindProperty(propertyName, out var property);
return _objectHandle.GetList<T>(_realm, _metadata.PropertyIndices[propertyName], property.ObjectType);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected T GetObjectValue<T>(string propertyName) where T : RealmObject
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
if (_objectHandle.TryGetLink(_metadata.PropertyIndices[propertyName], out var objectHandle))
{
_metadata.Schema.TryFindProperty(propertyName, out var property);
return (T)_realm.MakeObject(_realm.Metadata[property.ObjectType], objectHandle);
}
return null;
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected byte[] GetByteArrayValue(string propertyName)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
return _objectHandle.GetByteArray(_metadata.PropertyIndices[propertyName]);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected IQueryable<T> GetBacklinks<T>(string propertyName) where T : RealmObject
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
var resultsHandle = _objectHandle.GetBacklinks(_metadata.PropertyIndices[propertyName]);
return GetBacklinksForHandle<T>(propertyName, resultsHandle);
}
internal RealmResults<T> GetBacklinksForHandle<T>(string propertyName, ResultsHandle resultsHandle) where T : RealmObject
{
_metadata.Schema.TryFindProperty(propertyName, out var property);
var relatedMeta = _realm.Metadata[property.ObjectType];
return new RealmResults<T>(_realm, relatedMeta, resultsHandle);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected RealmInteger<T> GetRealmIntegerValue<T>(string propertyName)
where T : struct, IFormattable, IComparable<T>
{
var propertyIndex = _metadata.PropertyIndices[propertyName];
var result = Operator.Convert<long, T>(_objectHandle.GetInt64(propertyIndex));
return new RealmInteger<T>(result, ObjectHandle, propertyIndex);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected RealmInteger<T>? GetNullableRealmIntegerValue<T>(string propertyName)
where T : struct, IFormattable, IComparable<T>
{
var propertyIndex = _metadata.PropertyIndices[propertyName];
var result = _objectHandle.GetNullableInt64(propertyIndex);
if (result.HasValue)
{
return new RealmInteger<T>(Operator.Convert<long, T>(result.Value), ObjectHandle, propertyIndex);
}
return null;
}
#endregion
#region Setters
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetStringValue(string propertyName, string value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetString(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetStringValueUnique(string propertyName, string value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetStringUnique(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetCharValue(string propertyName, char value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableInt64(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetCharValueUnique(string propertyName, char value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetInt64Unique(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableCharValue(string propertyName, char? value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableInt64(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableCharValueUnique(string propertyName, char? value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableInt64Unique(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetSingleValue(string propertyName, float value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetSingle(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableSingleValue(string propertyName, float? value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableSingle(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetDoubleValue(string propertyName, double value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetDouble(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableDoubleValue(string propertyName, double? value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableDouble(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetBooleanValue(string propertyName, bool value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetBoolean(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableBooleanValue(string propertyName, bool? value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableBoolean(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetDateTimeOffsetValue(string propertyName, DateTimeOffset value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetDateTimeOffset(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableDateTimeOffsetValue(string propertyName, DateTimeOffset? value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableDateTimeOffset(_metadata.PropertyIndices[propertyName], value);
}
// Originally a generic fallback, now used only for RealmObject To-One relationship properties
// most other properties handled with woven type-specific setters above
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetObjectValue<T>(string propertyName, T value) where T : RealmObject
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
if (value == null)
{
_objectHandle.ClearLink(_metadata.PropertyIndices[propertyName]);
}
else
{
if (!value.IsManaged)
{
_realm.Add(value);
}
_objectHandle.SetLink(_metadata.PropertyIndices[propertyName], value.ObjectHandle);
}
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetByteArrayValue(string propertyName, byte[] value)
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetByteArray(_metadata.PropertyIndices[propertyName], value);
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetRealmIntegerValue<T>(string propertyName, RealmInteger<T> value)
where T : struct, IComparable<T>, IFormattable
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetInt64(_metadata.PropertyIndices[propertyName], value.ToLong());
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableRealmIntegerValue<T>(string propertyName, RealmInteger<T>? value)
where T : struct, IComparable<T>, IFormattable
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableInt64(_metadata.PropertyIndices[propertyName], value.ToLong());
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetRealmIntegerValueUnique<T>(string propertyName, RealmInteger<T> value)
where T : struct, IComparable<T>, IFormattable
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetInt64Unique(_metadata.PropertyIndices[propertyName], value.ToLong());
}
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented")]
protected void SetNullableRealmIntegerValueUnique<T>(string propertyName, RealmInteger<T>? value)
where T : struct, IComparable<T>, IFormattable
{
Debug.Assert(IsManaged, "Object is not managed, but managed access was attempted");
_objectHandle.SetNullableInt64Unique(_metadata.PropertyIndices[propertyName], value.ToLong());
}
#endregion
/// <summary>
/// Returns all the objects that link to this object in the specified relationship.
/// </summary>
/// <param name="objectType">The type of the object that is on the other end of the relationship.</param>
/// <param name="property">The property that is on the other end of the relationship.</param>
/// <returns>A queryable collection containing all objects of <c>objectType</c> that link to the current object via <c>property</c>.</returns>
public IQueryable<dynamic> GetBacklinks(string objectType, string property)
{
Argument.Ensure(Realm.Metadata.TryGetValue(objectType, out var relatedMeta), $"Could not find schema for type {objectType}", nameof(objectType));
Argument.Ensure(relatedMeta.PropertyIndices.ContainsKey(property), $"Type {objectType} does not contain property {property}", nameof(property));
var resultsHandle = ObjectHandle.GetBacklinksForType(objectType, property);
return new RealmResults<RealmObject>(Realm, relatedMeta, resultsHandle);
}
/// <inheritdoc/>
public override bool Equals(object obj)
{
// If parameter is null, return false.
if (ReferenceEquals(obj, null))
{
return false;
}
// Optimization for a common success case.
if (ReferenceEquals(this, obj))
{
return true;
}
// If run-time types are not exactly the same, return false.
if (GetType() != obj.GetType())
{
return false;
}
// standalone objects cannot participate in the same store check
if (!IsManaged)
{
return false;
}
// Return true if the fields match.
// Note that the base class is not invoked because it is
// System.Object, which defines Equals as reference equality.
return ObjectHandle.Equals(((RealmObject)obj).ObjectHandle);
}
/// <summary>
/// Allows you to raise the PropertyChanged event.
/// </summary>
/// <param name="propertyName">The name of the property that has changed. If not specified, we'll use the caller name.</param>
protected void RaisePropertyChanged([CallerMemberName] string propertyName = null)
{
_propertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
OnPropertyChanged(propertyName);
}
/// <summary>
/// Called when a property has changed on this class.
/// </summary>
/// <param name="propertyName">The name of the property.</param>
/// <remarks>
/// For this method to be called, you need to have first subscribed to <see cref="PropertyChanged"/>.
/// This can be used to react to changes to the current object, e.g. raising <see cref="PropertyChanged"/> for computed properties.
/// </remarks>
/// <example>
/// <code>
/// class MyClass : RealmObject
/// {
/// public int StatusCodeRaw { get; set; }
/// public StatusCodeEnum StatusCode => (StatusCodeEnum)StatusCodeRaw;
/// protected override void OnPropertyChanged(string propertyName)
/// {
/// if (propertyName == nameof(StatusCodeRaw))
/// {
/// RaisePropertyChanged(nameof(StatusCode));
/// }
/// }
/// }
/// </code>
/// Here, we have a computed property that depends on a persisted one. In order to notify any <see cref="PropertyChanged"/>
/// subscribers that <c>StatusCode</c> has changed, we override <see cref="OnPropertyChanged"/> and
/// raise <see cref="PropertyChanged"/> manually by calling <see cref="RaisePropertyChanged"/>.
/// </example>
protected virtual void OnPropertyChanged(string propertyName)
{
}
/// <summary>
/// Called when the object has been managed by a Realm.
/// </summary>
/// <remarks>
/// This method will be called either when a managed object is materialized or when an unmanaged object has been
/// added to the Realm. It can be useful for providing some initialization logic as when the constructor is invoked,
/// it is not yet clear whether the object is managed or not.
/// </remarks>
protected internal virtual void OnManaged()
{
}
private void SubscribeForNotifications()
{
Debug.Assert(_notificationToken == null, "_notificationToken must be null before subscribing.");
_realm.ExecuteOutsideTransaction(() =>
{
if (ObjectHandle.IsValid)
{
var managedObjectHandle = GCHandle.Alloc(this, GCHandleType.Weak);
_notificationToken = ObjectHandle.AddNotificationCallback(GCHandle.ToIntPtr(managedObjectHandle), NotificationsHelper.NotificationCallback);
}
});
}
private void UnsubscribeFromNotifications()
{
_notificationToken?.Dispose();
_notificationToken = null;
}
void NotificationsHelper.INotifiable.NotifyCallbacks(NotifiableObjectHandleBase.CollectionChangeSet? changes, NativeException? exception)
{
var managedException = exception?.Convert();
if (managedException != null)
{
Realm.NotifyError(managedException);
}
else if (changes.HasValue)
{
foreach (int propertyIndex in changes.Value.Properties.AsEnumerable())
{
// Due to a yet another Mono compiler bug, using LINQ fails here :/
var i = 0;
foreach (var property in ObjectSchema)
{
// Backlinks should be ignored. See Realm.CreateRealmObjectMetadata
if (property.Type.IsComputed())
{
continue;
}
if (i == propertyIndex)
{
RaisePropertyChanged(property.PropertyInfo?.Name ?? property.Name);
break;
}
++i;
}
}
if (changes.Value.Deletions.AsEnumerable().Any())
{
RaisePropertyChanged(nameof(IsValid));
if (!IsValid)
{
// We can proactively unsubscribe because the object has been deleted
UnsubscribeFromNotifications();
}
}
}
}
/// <inheritdoc />
public TypeInfo GetTypeInfo()
{
return TypeInfoHelper.GetInfo(this);
}
internal class Metadata
{
internal TableHandle Table;
internal Weaving.IRealmObjectHelper Helper;
internal Dictionary<string, IntPtr> PropertyIndices;
internal ObjectSchema Schema;
}
}
}