Renamed PropertyConfiguration.RelationshipKey to CollectionKey

JeremyCaney · JeremyCaney · commit 44dc3eb15797 · 2021-02-02T17:35:29.000-08:00
With the renaming of `[Relationship()]` to `[Collection()]` (f84ae66), it makes sense to rename the `PropertyConfiguration`'s `RelationshipKey` property to `CollectionKey`, since it maps to the `CollectionAttribute.Key` property.
diff --git a/OnTopic/Mapping/Internal/PropertyConfiguration.cs b/OnTopic/Mapping/Internal/PropertyConfiguration.cs
@@ -67,7 +67,7 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
       AttributePrefix           = attributePrefix;
       DefaultValue              = null;
       InheritValue              = false;
-      RelationshipKey           = AttributeKey;
+      CollectionKey             = AttributeKey;
       CollectionType            = CollectionType.Any;
       CrawlRelationships        = Relationships.None;
       MetadataKey               = null;
@@ -95,12 +95,12 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
       GetAttributeValue<CollectionAttribute>(
         property,
         a => {
-          RelationshipKey = a.Key ?? RelationshipKey;
+          CollectionKey = a.Key ?? CollectionKey;
           CollectionType = a.Type;
         }
       );
 
-      if (RelationshipKey.Equals("Children", StringComparison.OrdinalIgnoreCase)) {
+      if (CollectionKey.Equals("Children", StringComparison.OrdinalIgnoreCase)) {
         CollectionType = CollectionType.Children;
       }
 
@@ -244,15 +244,15 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
     ///     So, for instance, if the property on the DTO class is called <c>Cousins</c> then the <see
     ///     cref="ITopicMappingService"/> will search <see cref="Topic.Relationships"/>, <see
     ///     cref="Topic.IncomingRelationships"/>, and, finally, <see cref="Topic.Children"/> for an object named <c>Cousins</c>.
-    ///     If the <see cref="RelationshipKey"/> is set, however, then that value is used instead, thus allowing the property on
+    ///     If the <see cref="CollectionKey"/> is set, however, then that value is used instead, thus allowing the property on
     ///     the DTO to be aliased to a different collection name on the source <see cref="Topic"/>.
     ///   </para>
     ///   <para>
-    ///     The <see cref="RelationshipKey"/> property corresponds to the <see cref="CollectionAttribute.Key"/> property. It
+    ///     The <see cref="CollectionKey"/> property corresponds to the <see cref="CollectionAttribute.Key"/> property. It
     ///     can be assigned by decorating a DTO property with e.g. <c>[Relationship("AlternateRelationshipKey")]</c>.
     ///   </para>
     /// </remarks>
-    public string RelationshipKey { get; set; }
+    public string CollectionKey { get; set; }
 
     /*==========================================================================================================================
     | PROPERTY: RELATIONSHIP TYPE
@@ -265,7 +265,7 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
     ///     By default, a collection property on a DTO class will attempt to find a match from, in order, <see
     ///     cref="Topic.Relationships"/>, <see cref="Topic.IncomingRelationships"/>, and, finally, <see cref="Topic.Children"/>.
     ///     If the <see cref="CollectionType"/> is set, however, then the <see cref="ITopicMappingService"/> will <i>only</i>
-    ///     map the collection to a relationship of that type. This can be valuable when the <see cref="RelationshipKey"/> might
+    ///     map the collection to a relationship of that type. This can be valuable when the <see cref="CollectionKey"/> might
     ///     be ambiguous between multiple collections.
     ///   </para>
     ///   <para>
diff --git a/OnTopic/Mapping/TopicMappingService.cs b/OnTopic/Mapping/TopicMappingService.cs
@@ -521,7 +521,7 @@ private IList<Topic> GetSourceCollection(Topic source, Relationships relationshi
       | Establish source collection to store topics to be mapped
       \-----------------------------------------------------------------------------------------------------------------------*/
       var                       listSource                      = (IList<Topic>)Array.Empty<Topic>();
-      var                       relationshipKey                 = configuration.RelationshipKey;
+      var                       relationshipKey                 = configuration.CollectionKey;
       var                       collectionType                  = configuration.CollectionType;
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -616,7 +616,7 @@ IList<Topic> GetRelationship(CollectionType relationship, Func<string, bool> con
           (collectionType is CollectionType.Any || collectionType.Equals(relationship)) &&
           (collectionType is CollectionType.Children || relationship is not CollectionType.Children) &&
           (targetRelationships is Relationships.None || relationships.HasFlag(targetRelationships)) &&
-          contains(configuration.RelationshipKey);
+          contains(configuration.CollectionKey);
         return preconditionsMet? getTopics() : listSource;
       }
 
