/
ObjectSchema.cs
187 lines (160 loc) · 7.4 KB
/
ObjectSchema.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
////////////////////////////////////////////////////////////////////////////
//
// 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;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Diagnostics.Contracts;
using System.Linq;
using System.Reflection;
namespace Realms.Schema
{
/// <summary>
/// Public description of a class stored in a Realm, as a collection of managed Property objects.
/// </summary>
[DebuggerDisplay("Name = {Name}, Properties = {Count}")]
public class ObjectSchema : IReadOnlyCollection<Property>
{
private readonly ReadOnlyDictionary<string, Property> _properties;
/// <summary>
/// Gets the name of the original class declaration from which the schema was built.
/// </summary>
/// <value>The name of the class.</value>
public string Name { get; private set; }
/// <summary>
/// Gets the number of properties in the schema, which is the persistent properties from the original class.
/// </summary>
/// <value>The number of persistent properties for the object.</value>
public int Count => _properties.Count;
internal Property? PrimaryKeyProperty { get; }
internal Type Type;
internal IEnumerable<string> PropertyNames => _properties.Keys;
private ObjectSchema(string name, IDictionary<string, Property> properties)
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentException("Object name cannot be empty", nameof(name));
}
if (properties == null)
{
throw new ArgumentNullException(nameof(properties));
}
Name = name;
_properties = new ReadOnlyDictionary<string, Property>(properties);
var primaryKeyKvp = properties.FirstOrDefault(kvp => kvp.Value.IsPrimaryKey);
if (primaryKeyKvp.Key != null)
{
PrimaryKeyProperty = primaryKeyKvp.Value;
}
}
/// <summary>
/// Looks for a <see cref="Property"/> by <see cref="Property.Name"/>.
/// Failure to find means it is not regarded as a property to persist in a <see cref="Realm"/>.
/// </summary>
/// <returns><c>true</c>, if a <see cref="Property"/> was found matching <see cref="Property.Name"/>;
/// <c>false</c> otherwise.</returns>
/// <param name="name"><see cref="Property.Name"/> of the <see cref="Property"/> to match exactly.</param>
/// <param name="property"><see cref="Property"/> returned only if found matching Name.</param>
public bool TryFindProperty(string name, out Property property) => _properties.TryGetValue(name, out property);
/// <inheritdoc/>
public IEnumerator<Property> GetEnumerator() => _properties.Values.GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
/// <summary>
/// Creates a schema describing a <see cref="RealmObject"/> subclass in terms of its persisted members.
/// </summary>
/// <exception cref="ArgumentException">
/// Thrown if no class Type is provided or if it doesn't descend directly from <see cref="RealmObject"/>.
/// </exception>
/// <returns>An <see cref="ObjectSchema"/> describing the specified Type.</returns>
/// <param name="type">Type of a <see cref="RealmObject"/> descendant for which you want a schema.</param>
public static ObjectSchema FromType(Type type)
{
if (type == null)
{
throw new ArgumentNullException(nameof(type));
}
if (type.BaseType != typeof(RealmObject))
{
throw new ArgumentException($"The class {type.FullName} must descend directly from RealmObject");
}
var builder = new Builder(type.Name);
foreach (var property in type.GetProperties(BindingFlags.Instance | BindingFlags.DeclaredOnly | BindingFlags.NonPublic | BindingFlags.Public))
{
if (property.GetCustomAttribute<WovenPropertyAttribute>() == null)
{
continue;
}
var isPrimaryKey = property.GetCustomAttribute<PrimaryKeyAttribute>() != null;
var schemaProperty = new Property
{
Name = property.GetCustomAttribute<MapToAttribute>()?.Mapping ?? property.Name,
IsPrimaryKey = isPrimaryKey,
IsIndexed = isPrimaryKey || property.GetCustomAttribute<IndexedAttribute>() != null,
PropertyInfo = property
};
var backlinks = property.GetCustomAttribute<BacklinkAttribute>();
if (backlinks != null)
{
var innerType = property.PropertyType.GetGenericArguments().Single();
var linkOriginProperty = innerType.GetProperty(backlinks.Property);
schemaProperty.Type = PropertyType.LinkingObjects;
schemaProperty.ObjectType = innerType.Name;
schemaProperty.LinkOriginPropertyName = linkOriginProperty.GetCustomAttribute<MapToAttribute>()?.Mapping ?? linkOriginProperty.Name;
}
else
{
Type innerType;
bool isNullable;
schemaProperty.Type = property.PropertyType.ToPropertyType(out isNullable, out innerType);
schemaProperty.ObjectType = innerType?.Name;
schemaProperty.IsNullable = isNullable;
}
if (property.GetCustomAttribute<RequiredAttribute>() != null)
{
schemaProperty.IsNullable = false;
}
builder.Add(schemaProperty);
}
var ret = builder.Build();
ret.Type = type;
return ret;
}
internal class Builder : List<Property>
{
public string Name { get; }
public Builder(string name)
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentException("Object name cannot be empty", nameof(name));
}
Name = name;
}
public ObjectSchema Build()
{
if (Count == 0)
{
throw new InvalidOperationException(
$"No properties in {Name}, has linker stripped it? See https://realm.io/docs/xamarin/latest/#linker-stripped-schema");
}
return new ObjectSchema(Name, this.ToDictionary(p => p.Name));
}
}
}
}