Add ID property name constructor argument for MongoDB repository

Author: rpaschoal

DynamicRepository.MongoDB/MongoDBRepository.cs

@@ -23,37 +23,42 @@ namespace DynamicRepository.MongoDB
         /// <summary>
         /// Favoring composition on paged data.
         /// </summary>
-        private DataPager<Key, Entity> _dataPager;
+        private readonly DataPager<Key, Entity> _dataPager;
 
         /// <summary>
         /// The mongoDB database instance to access the desired collection for this repository.
         /// </summary>
-        private IMongoDatabase _mongoDatabase;
+        private readonly IMongoDatabase _mongoDatabase;
 
         /// <summary>
-        /// Current MongoDB collection being used by this Repository instance.
+        /// Name of the Id property for each document of the collection being accessed.
         /// </summary>
-        protected internal IMongoCollection<Entity> Collection;
+        private readonly string _idPropertyName;
 
         /// <summary>
-        /// The name of the MongoDB collection where the data for this entity is stored.
+        /// Delegate supplied via constructor for pre-condition filtering.
         /// </summary>
-        protected string CollectionName { get; }
+        private readonly Func<PagedDataSettings, Expression<Func<Entity, bool>>> _preConditionsToPagedDataFilterDelegate;
 
         /// <summary>
-        /// Global filter instance set by <see cref="HasGlobalFilter(Expression{Func{Entity, bool}})" />
+        /// Delegate supplied via constructor for extra paged data filtering.
         /// </summary>
-        private Expression<Func<Entity, bool>> GlobalFilter { get; set; }
+        private readonly Func<PagedDataSettings, Expression<Func<Entity, bool>>> _extraPagedDataFilterDelegate;
 
         /// <summary>
-        /// Delegate supplied via constructor for pre-condition filtering.
+        /// Current MongoDB collection being used by this Repository instance.
         /// </summary>
-        private Func<PagedDataSettings, Expression<Func<Entity, bool>>> PreConditionsToPagedDataFilterDelegate { get; set; }
+        protected internal IMongoCollection<Entity> Collection;
 
         /// <summary>
-        /// Delegate supplied via constructor for extra paged data filtering.
+        /// The name of the MongoDB collection where the data for this entity is stored.
         /// </summary>
-        private Func<PagedDataSettings, Expression<Func<Entity, bool>>> ExtraPagedDataFilterDelegate { get; set; }
+        protected string CollectionName { get; }
+
+        /// <summary>
+        /// Global filter instance set by <see cref="HasGlobalFilter(Expression{Func{Entity, bool}})" />
+        /// </summary>
+        private Expression<Func<Entity, bool>> GlobalFilter { get; set; }
 
         /// <summary>
         /// Default constructor of this Repository.
@@ -64,13 +69,15 @@ namespace DynamicRepository.MongoDB
         /// <param name="collectionName">The name of the MongoDB collection to be used with this repository.</param>
         public MongoDBRepository(IMongoDatabase mongoDatabase, 
             string collectionName,
+            string idPropertyName,
             Func<PagedDataSettings, Expression<Func<Entity, bool>>> preConditionsToPagedDataFilterDelegate,
             Func<PagedDataSettings, Expression<Func<Entity, bool>>> extraPagedDataFilterDelegate)
         {
             _mongoDatabase = mongoDatabase;
             CollectionName = collectionName;
-            PreConditionsToPagedDataFilterDelegate = preConditionsToPagedDataFilterDelegate;
-            ExtraPagedDataFilterDelegate = extraPagedDataFilterDelegate;
+            _idPropertyName = idPropertyName;
+            _preConditionsToPagedDataFilterDelegate = preConditionsToPagedDataFilterDelegate;
+            _extraPagedDataFilterDelegate = extraPagedDataFilterDelegate;
 
             Collection = GetCollection<Entity>(collectionName);
 
@@ -104,8 +111,7 @@ public IMongoCollection<T> GetCollection<T>(string collectionName) where T : cla
         /// </summary>
         protected FilterDefinition<Entity> GetIdFilter(Entity entity)
         {
-            // TODO: "Id" property name should be configurable
-            return Builders<Entity>.Filter.Eq("Id", entity.GetType().GetProperty("Id").GetValue(entity, null));
+            return Builders<Entity>.Filter.Eq(_idPropertyName, entity.GetType().GetProperty("Id").GetValue(entity, null));
         }
 
         /// <summary>
@@ -118,8 +124,7 @@ protected FilterDefinition<Entity> GetIdFilter(Entity entity)
         /// </example>
         protected FilterDefinition<Entity> GetIdFilter(Key id)
         {
-            // TODO: "Id" property name should be configurable
-            return Builders<Entity>.Filter.Eq("Id", id);
+            return Builders<Entity>.Filter.Eq(_idPropertyName, id);
         }
 
         /// <summary>
@@ -270,7 +275,7 @@ public IEnumerable<Entity> List(Expression<Func<Entity, bool>> filter = null, Fu
         /// <returns>Collection of filtered items result.</returns>
         public IPagedDataResult<Entity> GetPagedData(PagedDataSettings settings)
         {
-            return _dataPager.GetPagedData(GetQueryable(), settings, PreConditionsToPagedDataFilterDelegate(settings), ExtraPagedDataFilterDelegate(settings));
+            return _dataPager.GetPagedData(GetQueryable(), settings, _preConditionsToPagedDataFilterDelegate(settings), _extraPagedDataFilterDelegate(settings));
         }
     }
 }

DynamicRepository.MongoDB/Repository.cs

@@ -37,10 +37,12 @@ protected IMongoCollection<Entity> Collection
         /// The mongo database to be interfaced and fetch the data.
         /// </param>
         /// <param name="collectionName">The collection name to be accessed by this repository.</param>
-        public Repository(IMongoDatabase mongoDatabase, string collectionName)
+        /// <param name="idPropertyName">Name of the Id property for each document of the collection being accessed. Default is "Id".</param>
+        public Repository(IMongoDatabase mongoDatabase, string collectionName, string idPropertyName = "Id")
         {
             _mongoDBRepository = new MongoDBRepository<Key, Entity>(mongoDatabase,
                 collectionName,
+                idPropertyName,
                 AddPreConditionsPagedDataFilter,
                 AddExtraPagedDataFilter);