forked from mongodb/mongo-csharp-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
BsonDocument.cs
1236 lines (1138 loc) · 45.1 KB
/
BsonDocument.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
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright 2010-2012 10gen 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.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Xml;
using MongoDB.Bson.IO;
using MongoDB.Bson.Serialization;
using MongoDB.Bson.Serialization.IdGenerators;
using MongoDB.Bson.Serialization.Options;
namespace MongoDB.Bson
{
/// <summary>
/// Represents a BSON document.
/// </summary>
[Serializable]
public class BsonDocument : BsonValue, IBsonSerializable, IComparable<BsonDocument>, IConvertibleToBsonDocument, IEnumerable<BsonElement>, IEquatable<BsonDocument>
{
// private fields
// use a list and a dictionary because we want to preserve the order in which the elements were added
// if duplicate names are present only the first one will be in the dictionary (the others can only be accessed by index)
private List<BsonElement> _elements = new List<BsonElement>();
private Dictionary<string, int> _indexes = new Dictionary<string, int>(); // maps names to indexes into elements list
private bool _allowDuplicateNames;
// constructors
/// <summary>
/// Initializes a new instance of the BsonDocument class.
/// </summary>
public BsonDocument()
: base(BsonType.Document)
{
}
/// <summary>
/// Initializes a new instance of the BsonDocument class specifying whether duplicate element names are allowed
/// (allowing duplicate element names is not recommended).
/// </summary>
/// <param name="allowDuplicateNames">Whether duplicate element names are allowed.</param>
public BsonDocument(bool allowDuplicateNames)
: base(BsonType.Document)
{
_allowDuplicateNames = allowDuplicateNames;
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds one element.
/// </summary>
/// <param name="element">An element to add to the document.</param>
public BsonDocument(BsonElement element)
: base(BsonType.Document)
{
Add(element);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">A dictionary to initialize the document from.</param>
public BsonDocument(Dictionary<string, object> dictionary)
: base(BsonType.Document)
{
Add(dictionary);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">A dictionary to initialize the document from.</param>
/// <param name="keys">A list of keys to select values from the dictionary.</param>
public BsonDocument(Dictionary<string, object> dictionary, IEnumerable<string> keys)
: base(BsonType.Document)
{
Add(dictionary, keys);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">A dictionary to initialize the document from.</param>
public BsonDocument(IDictionary<string, object> dictionary)
: base(BsonType.Document)
{
Add(dictionary);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">A dictionary to initialize the document from.</param>
/// <param name="keys">A list of keys to select values from the dictionary.</param>
public BsonDocument(IDictionary<string, object> dictionary, IEnumerable<string> keys)
: base(BsonType.Document)
{
Add(dictionary, keys);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">A dictionary to initialize the document from.</param>
public BsonDocument(IDictionary dictionary)
: base(BsonType.Document)
{
Add(dictionary);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">A dictionary to initialize the document from.</param>
/// <param name="keys">A list of keys to select values from the dictionary.</param>
public BsonDocument(IDictionary dictionary, IEnumerable keys)
: base(BsonType.Document)
{
Add(dictionary, keys);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds new elements from a list of elements.
/// </summary>
/// <param name="elements">A list of elements to add to the document.</param>
public BsonDocument(IEnumerable<BsonElement> elements)
: base(BsonType.Document)
{
Add(elements);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and adds one or more elements.
/// </summary>
/// <param name="elements">One or more elements to add to the document.</param>
public BsonDocument(params BsonElement[] elements)
: base(BsonType.Document)
{
Add(elements);
}
/// <summary>
/// Initializes a new instance of the BsonDocument class and creates and adds a new element.
/// </summary>
/// <param name="name">The name of the element to add to the document.</param>
/// <param name="value">The value of the element to add to the document.</param>
public BsonDocument(string name, BsonValue value)
: base(BsonType.Document)
{
Add(name, value);
}
// public operators
/// <summary>
/// Compares two BsonDocument values.
/// </summary>
/// <param name="lhs">The first BsonDocument.</param>
/// <param name="rhs">The other BsonDocument.</param>
/// <returns>True if the two BsonDocument values are not equal according to ==.</returns>
public static bool operator !=(BsonDocument lhs, BsonDocument rhs)
{
return !(lhs == rhs);
}
/// <summary>
/// Compares two BsonDocument values.
/// </summary>
/// <param name="lhs">The first BsonDocument.</param>
/// <param name="rhs">The other BsonDocument.</param>
/// <returns>True if the two BsonDocument values are equal according to ==.</returns>
public static bool operator ==(BsonDocument lhs, BsonDocument rhs)
{
if (object.ReferenceEquals(lhs, null)) { return object.ReferenceEquals(rhs, null); }
return lhs.Equals(rhs);
}
// public properties
/// <summary>
/// Gets or sets whether to allow duplicate names (allowing duplicate names is not recommended).
/// </summary>
public bool AllowDuplicateNames
{
get { return _allowDuplicateNames; }
set { _allowDuplicateNames = value; }
}
// ElementCount could be greater than the number of Names if allowDuplicateNames is true
/// <summary>
/// Gets the number of elements.
/// </summary>
public int ElementCount
{
get { return _elements.Count; }
}
/// <summary>
/// Gets the elements.
/// </summary>
public IEnumerable<BsonElement> Elements
{
get { return _elements; }
}
/// <summary>
/// Gets the element names.
/// </summary>
public IEnumerable<string> Names
{
get { return _elements.Select(e => e.Name); }
}
/// <summary>
/// Gets the raw values (see BsonValue.RawValue).
/// </summary>
public IEnumerable<object> RawValues
{
get { return _elements.Select(e => e.Value.RawValue); }
}
/// <summary>
/// Gets the values.
/// </summary>
public IEnumerable<BsonValue> Values
{
get { return _elements.Select(e => e.Value); }
}
// public indexers
// note: the return type of the indexers is BsonValue and NOT BsonElement so that we can write code like:
// BsonDocument car;
// car["color"] = "red"; // changes value of existing element or adds new element
// note: we are using implicit conversion from string to BsonValue
// to convert the returned BsonValue to a .NET type you have two approaches (explicit cast or As method):
// string color = (string) car["color"]; // throws exception if value is not a string (returns null if not found)
// string color = car["color"].AsString; // throws exception if value is not a string (results in a NullReferenceException if not found)
// string color = car["color", "none"].AsString; // throws exception if value is not a string (default to "none" if not found)
// the second approach offers a more fluent interface (with fewer parenthesis!)
// string name = car["brand"].AsBsonSymbol.Name;
// string name = ((BsonSymbol) car["brand"]).Name; // the extra parenthesis are required and harder to read
// there are also some conversion methods (and note that ToBoolean uses the JavaScript definition of truthiness)
// bool ok = result["ok"].ToBoolean(); // works whether ok is false, true, 0, 0.0, 1, 1.0, "", "xyz", BsonNull.Value, etc...
// bool ok = result["ok", false].ToBoolean(); // defaults to false if ok element is not found
// int n = result["n"].ToInt32(); // works whether n is Int32, Int64, Double or String (if it can be parsed)
// long n = result["n"].ToInt64(); // works whether n is Int32, Int64, Double or String (if it can be parsed)
// double d = result["n"].ToDouble(); // works whether d is Int32, Int64, Double or String (if it can be parsed)
// to work in terms of BsonElements use Add, GetElement and SetElement
// car.Add(new BsonElement("color", "red")); // might throw exception if allowDuplicateNames is false
// car.SetElement(new BsonElement("color", "red")); // replaces existing element or adds new element
// BsonElement colorElement = car.GetElement("color"); // returns null if element "color" is not found
/// <summary>
/// Gets or sets the value of an element.
/// </summary>
/// <param name="index">The zero based index of the element.</param>
/// <returns>The value of the element.</returns>
public BsonValue this[int index]
{
get { return _elements[index].Value; }
set { _elements[index].Value = value; }
}
/// <summary>
/// Gets the value of an element or a default value if the element is not found.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <param name="defaultValue">The default value to return if the element is not found.</param>
/// <returns>Teh value of the element or a default value if the element is not found.</returns>
public BsonValue this[string name, BsonValue defaultValue]
{
get
{
int index;
if (_indexes.TryGetValue(name, out index))
{
return _elements[index].Value;
}
else
{
return defaultValue;
}
}
}
/// <summary>
/// Gets or sets the value of an element.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <returns>The value of the element.</returns>
public BsonValue this[string name]
{
get
{
int index;
if (_indexes.TryGetValue(name, out index))
{
return _elements[index].Value;
}
else
{
string message = string.Format("Element '{0}' not found.", name);
throw new KeyNotFoundException(message);
}
}
set
{
int index;
if (_indexes.TryGetValue(name, out index))
{
_elements[index].Value = value;
}
else
{
Add(new BsonElement(name, value));
}
}
}
// public static methods
/// <summary>
/// Creates a new BsonDocument by mapping an object to a BsonDocument.
/// </summary>
/// <param name="value">The object to be mapped to a BsonDocument.</param>
/// <returns>A BsonDocument.</returns>
public new static BsonDocument Create(object value)
{
if (value != null)
{
return (BsonDocument)BsonTypeMapper.MapToBsonValue(value, BsonType.Document);
}
else
{
return null;
}
}
/// <summary>
/// Parses a JSON string and returns a BsonDocument.
/// </summary>
/// <param name="json">The JSON string.</param>
/// <returns>A BsonDocument.</returns>
public static BsonDocument Parse(string json)
{
using (var bsonReader = BsonReader.Create(json))
{
var document = new BsonDocument();
return (BsonDocument)document.Deserialize(bsonReader, typeof(BsonDocument), null);
}
}
/// <summary>
/// Reads a BsonDocument from a BsonBuffer.
/// </summary>
/// <param name="buffer">The BsonBuffer.</param>
/// <returns>A BsonDocument.</returns>
public static BsonDocument ReadFrom(BsonBuffer buffer)
{
using (BsonReader bsonReader = BsonReader.Create(buffer))
{
return ReadFrom(bsonReader);
}
}
/// <summary>
/// Reads a BsonDocument from a BsonReader.
/// </summary>
/// <param name="bsonReader">The BsonReader.</param>
/// <returns>A BsonDocument.</returns>
public static new BsonDocument ReadFrom(BsonReader bsonReader)
{
BsonDocument document = new BsonDocument();
return (BsonDocument)document.Deserialize(bsonReader, typeof(BsonDocument), null);
}
/// <summary>
/// Reads a BsonDocument from a byte array.
/// </summary>
/// <param name="bytes">The byte array.</param>
/// <returns>A BsonDocument.</returns>
public static BsonDocument ReadFrom(byte[] bytes)
{
MemoryStream stream = new MemoryStream(bytes);
using (BsonReader bsonReader = BsonReader.Create(stream))
{
return ReadFrom(bsonReader);
}
}
/// <summary>
/// Reads a BsonDocument from a stream.
/// </summary>
/// <param name="stream">The stream.</param>
/// <returns>A BsonDocument.</returns>
public static BsonDocument ReadFrom(Stream stream)
{
using (BsonReader bsonReader = BsonReader.Create(stream))
{
return ReadFrom(bsonReader);
}
}
/// <summary>
/// Reads a BsonDocument from a file.
/// </summary>
/// <param name="filename">The name of the file.</param>
/// <returns>A BsonDocument.</returns>
public static BsonDocument ReadFrom(string filename)
{
FileStream stream = new FileStream(filename, FileMode.Open, FileAccess.Read, FileShare.None);
using (BsonReader bsonReader = BsonReader.Create(stream))
{
return ReadFrom(bsonReader);
}
}
// public methods
/// <summary>
/// Adds an element to the document.
/// </summary>
/// <param name="element">The element to add.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(BsonElement element)
{
if (element != null)
{
bool found;
int index;
if ((found = _indexes.TryGetValue(element.Name, out index)) && !_allowDuplicateNames)
{
var message = string.Format("Duplicate element name '{0}'.", element.Name);
throw new InvalidOperationException(message);
}
else
{
_elements.Add(element);
if (!found)
{
_indexes.Add(element.Name, _elements.Count - 1); // index of the newly added element
}
}
}
return this;
}
/// <summary>
/// Adds elements to the document from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">The dictionary.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(Dictionary<string, object> dictionary)
{
return Add((IDictionary<string, object>)dictionary);
}
/// <summary>
/// Adds elements to the document from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">The dictionary.</param>
/// <param name="keys">Which keys of the hash table to add.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(Dictionary<string, object> dictionary, IEnumerable<string> keys)
{
return Add((IDictionary<string, object>)dictionary, keys);
}
/// <summary>
/// Adds elements to the document from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">The dictionary.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(IDictionary<string, object> dictionary)
{
if (dictionary != null)
{
Add(dictionary, dictionary.Keys);
}
return this;
}
/// <summary>
/// Adds elements to the document from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">The dictionary.</param>
/// <param name="keys">Which keys of the hash table to add.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(IDictionary<string, object> dictionary, IEnumerable<string> keys)
{
if (dictionary != null)
{
foreach (var key in keys)
{
Add(key, BsonValue.Create(dictionary[key]));
}
}
return this;
}
/// <summary>
/// Adds elements to the document from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">The dictionary.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(IDictionary dictionary)
{
if (dictionary != null)
{
Add(dictionary, dictionary.Keys);
}
return this;
}
/// <summary>
/// Adds elements to the document from a dictionary of key/value pairs.
/// </summary>
/// <param name="dictionary">The dictionary.</param>
/// <param name="keys">Which keys of the hash table to add.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(IDictionary dictionary, IEnumerable keys)
{
if (dictionary != null)
{
foreach (string key in keys)
{
Add(key, BsonValue.Create(dictionary[key]));
}
}
return this;
}
/// <summary>
/// Adds a list of elements to the document.
/// </summary>
/// <param name="elements">The list of elements.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(IEnumerable<BsonElement> elements)
{
if (elements != null)
{
foreach (var element in elements)
{
Add(element);
}
}
return this;
}
/// <summary>
/// Adds a list of elements to the document.
/// </summary>
/// <param name="elements">The list of elements.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(params BsonElement[] elements)
{
return Add((IEnumerable<BsonElement>)elements);
}
/// <summary>
/// Creates and adds an element to the document.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <param name="value">The value of the element.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(string name, BsonValue value)
{
if (value != null)
{
Add(new BsonElement(name, value));
}
return this;
}
/// <summary>
/// Creates and adds an element to the document, but only if the condition is true.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <param name="value">The value of the element.</param>
/// <param name="condition">Whether to add the element to the document.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Add(string name, BsonValue value, bool condition)
{
if (condition)
{
Add(name, value);
}
return this;
}
/// <summary>
/// Clears the document (removes all elements).
/// </summary>
public void Clear()
{
_elements.Clear();
_indexes.Clear();
}
/// <summary>
/// Creates a shallow clone of the document (see also DeepClone).
/// </summary>
/// <returns>A shallow clone of the document.</returns>
public override BsonValue Clone()
{
BsonDocument clone = new BsonDocument();
foreach (BsonElement element in _elements)
{
clone.Add(element.Clone());
}
return clone;
}
/// <summary>
/// Compares this document to another document.
/// </summary>
/// <param name="other">The other document.</param>
/// <returns>A 32-bit signed integer that indicates whether this document is less than, equal to, or greather than the other.</returns>
public int CompareTo(BsonDocument other)
{
if (other == null) { return 1; }
for (int i = 0; i < _elements.Count && i < other._elements.Count; i++)
{
int r = _elements[i].Name.CompareTo(other._elements[i].Name);
if (r != 0) { return r; }
r = _elements[i].Value.CompareTo(other._elements[i].Value);
if (r != 0) { return r; }
}
return _elements.Count.CompareTo(other._elements.Count);
}
/// <summary>
/// Compares the BsonDocument to another BsonValue.
/// </summary>
/// <param name="other">The other BsonValue.</param>
/// <returns>A 32-bit signed integer that indicates whether this BsonDocument is less than, equal to, or greather than the other BsonValue.</returns>
public override int CompareTo(BsonValue other)
{
if (other == null) { return 1; }
var otherDocument = other as BsonDocument;
if (otherDocument != null)
{
return CompareTo(otherDocument);
}
return CompareTypeTo(other);
}
/// <summary>
/// Tests whether the document contains an element with the specified name.
/// </summary>
/// <param name="name">The name of the element to look for.</param>
/// <returns>True if the document contains an element with the specified name.</returns>
public bool Contains(string name)
{
return _indexes.ContainsKey(name);
}
/// <summary>
/// Tests whether the document contains an element with the specified value.
/// </summary>
/// <param name="value">The value of the element to look for.</param>
/// <returns>True if the document contains an element with the specified value.</returns>
public bool ContainsValue(BsonValue value)
{
return _elements.Any(e => e.Value == value);
}
/// <summary>
/// Creates a deep clone of the document (see also Clone).
/// </summary>
/// <returns>A deep clone of the document.</returns>
public override BsonValue DeepClone()
{
BsonDocument clone = new BsonDocument();
foreach (BsonElement element in _elements)
{
clone.Add(element.DeepClone());
}
return clone;
}
/// <summary>
/// Deserializes the document from a BsonReader.
/// </summary>
/// <param name="bsonReader">The BsonReader.</param>
/// <param name="nominalType">The nominal type of the object (ignored, but should be BsonDocument).</param>
/// <param name="options">The serialization options (ignored).</param>
/// <returns>The document (which has now been initialized by deserialization), or null.</returns>
public object Deserialize(BsonReader bsonReader, Type nominalType, IBsonSerializationOptions options)
{
if (bsonReader.CurrentBsonType == Bson.BsonType.Null)
{
bsonReader.ReadNull();
return null;
}
else
{
bsonReader.ReadStartDocument();
Clear();
BsonElement element;
while (BsonElement.ReadFrom(bsonReader, out element))
{
Add(element);
}
bsonReader.ReadEndDocument();
return this;
}
}
/// <summary>
/// Gets the Id of the document.
/// </summary>
/// <param name="id">The Id of the document (the RawValue if it has one, otherwise the element Value).</param>
/// <param name="idNominalType">The nominal type of the Id.</param>
/// <param name="idGenerator">The IdGenerator for the Id (or null).</param>
/// <returns>True (a BsonDocument either has an Id member or one can be added).</returns>
public bool GetDocumentId(out object id, out Type idNominalType, out IIdGenerator idGenerator)
{
BsonElement idElement;
if (TryGetElement("_id", out idElement))
{
id = idElement.Value.RawValue;
if (id == null)
{
id = idElement.Value;
}
idGenerator = BsonSerializer.LookupIdGenerator(id.GetType());
}
else
{
id = null;
idGenerator = ObjectIdGenerator.Instance;
}
idNominalType = typeof(BsonValue);
return true;
}
/// <summary>
/// Compares this document to another document.
/// </summary>
/// <param name="rhs">The other document.</param>
/// <returns>True if the two documents are equal.</returns>
public bool Equals(BsonDocument rhs)
{
if (object.ReferenceEquals(rhs, null) || GetType() != rhs.GetType()) { return false; }
return object.ReferenceEquals(this, rhs) || _elements.SequenceEqual(rhs._elements);
}
/// <summary>
/// Compares this BsonDocument to another object.
/// </summary>
/// <param name="obj">The other object.</param>
/// <returns>True if the other object is a BsonDocument and equal to this one.</returns>
public override bool Equals(object obj)
{
return Equals(obj as BsonDocument); // works even if obj is null or of a different type
}
/// <summary>
/// Gets an element of this document.
/// </summary>
/// <param name="index">The zero based index of the element.</param>
/// <returns>The element.</returns>
public BsonElement GetElement(int index)
{
return _elements[index];
}
/// <summary>
/// Gets an element of this document.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <returns>A BsonElement.</returns>
public BsonElement GetElement(string name)
{
int index;
if (_indexes.TryGetValue(name, out index))
{
return _elements[index];
}
else
{
string message = string.Format("Element '{0}' not found.", name);
throw new KeyNotFoundException(message);
}
}
/// <summary>
/// Gets an enumerator that can be used to enumerate the elements of this document.
/// </summary>
/// <returns>An enumerator.</returns>
public IEnumerator<BsonElement> GetEnumerator()
{
return _elements.GetEnumerator();
}
/// <summary>
/// Gets the hash code.
/// </summary>
/// <returns>The hash code.</returns>
public override int GetHashCode()
{
// see Effective Java by Joshua Bloch
int hash = 17;
hash = 37 * _bsonType.GetHashCode();
foreach (BsonElement element in _elements)
{
hash = 37 * hash + element.GetHashCode();
}
return hash;
}
/// <summary>
/// Gets the value of an element.
/// </summary>
/// <param name="index">The zero based index of the element.</param>
/// <returns>The value of the element.</returns>
public BsonValue GetValue(int index)
{
return this[index];
}
/// <summary>
/// Gets the value of an element.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <returns>The value of the element.</returns>
public BsonValue GetValue(string name)
{
return this[name];
}
/// <summary>
/// Gets the value of an element or a default value if the element is not found.
/// </summary>
/// <param name="name">The name of the element.</param>
/// <param name="defaultValue">The default value returned if the element is not found.</param>
/// <returns>The value of the element or the default value if the element is not found.</returns>
public BsonValue GetValue(string name, BsonValue defaultValue)
{
return this[name, defaultValue];
}
/// <summary>
/// Inserts a new element at a specified position.
/// </summary>
/// <param name="index">The position of the new element.</param>
/// <param name="element">The element.</param>
public void InsertAt(int index, BsonElement element)
{
if (element != null)
{
if (_indexes.ContainsKey(element.Name) && !_allowDuplicateNames)
{
var message = string.Format("Duplicate element name '{0}' not allowed.", element.Name);
throw new InvalidOperationException(message);
}
else
{
_elements.Insert(index, element);
RebuildDictionary();
}
}
}
/// <summary>
/// Merges another document into this one. Existing elements are not overwritten.
/// </summary>
/// <param name="document">The other document.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Merge(BsonDocument document)
{
Merge(document, false); // don't overwriteExistingElements
return this;
}
/// <summary>
/// Merges another document into this one, specifying whether existing elements are overwritten.
/// </summary>
/// <param name="document">The other document.</param>
/// <param name="overwriteExistingElements">Whether to overwrite existing elements.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Merge(BsonDocument document, bool overwriteExistingElements)
{
if (document != null)
{
foreach (BsonElement element in document)
{
if (overwriteExistingElements || !Contains(element.Name))
{
this[element.Name] = element.Value;
}
}
}
return this;
}
/// <summary>
/// Removes an element from this document (if duplicate element names are allowed
/// then all elements with this name will be removed).
/// </summary>
/// <param name="name">The name of the element to remove.</param>
public void Remove(string name)
{
if (_indexes.ContainsKey(name))
{
_elements.RemoveAll(e => e.Name == name);
RebuildDictionary();
}
}
/// <summary>
/// Removes an element from this document.
/// </summary>
/// <param name="index">The zero based index of the element to remove.</param>
public void RemoveAt(int index)
{
_elements.RemoveAt(index);
RebuildDictionary();
}
/// <summary>
/// Removes an element from this document.
/// </summary>
/// <param name="element">The element to remove.</param>
public void RemoveElement(BsonElement element)
{
_elements.Remove(element);
RebuildDictionary();
}
/// <summary>
/// Serializes this document to a BsonWriter.
/// </summary>
/// <param name="bsonWriter">The writer.</param>
/// <param name="nominalType">The nominalType.</param>
/// <param name="options">The serialization options (can be null).</param>
public void Serialize(BsonWriter bsonWriter, Type nominalType, IBsonSerializationOptions options)
{
bsonWriter.WriteStartDocument();
var documentOptions = (options == null) ? DocumentSerializationOptions.Defaults : (DocumentSerializationOptions)options;
int idIndex;
if (documentOptions.SerializeIdFirst && _indexes.TryGetValue("_id", out idIndex))
{
_elements[idIndex].WriteTo(bsonWriter);
}
else
{
idIndex = -1; // remember that when TryGetValue returns false it sets idIndex to 0
}
for (int i = 0; i < _elements.Count; i++)
{
// if serializeIdFirst is false then idIndex will be -1 and no elements will be skipped
if (i != idIndex)
{
_elements[i].WriteTo(bsonWriter);
}
}
bsonWriter.WriteEndDocument();
}
/// <summary>
/// Sets the value of an element.
/// </summary>
/// <param name="index">The zero based index of the element whose value is to be set.</param>
/// <param name="value">The new value.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Set(int index, BsonValue value)
{
this[index] = value;
return this;
}
/// <summary>
/// Sets the value of an element (an element will be added if no element with this name is found).
/// </summary>
/// <param name="name">The name of the element whose value is to be set.</param>
/// <param name="value">The new value.</param>
/// <returns>The document (so method calls can be chained).</returns>
public BsonDocument Set(string name, BsonValue value)
{
this[name] = value;
return this;