BHoM_Adapter: refactoring-remove NextId and AssignId

[alelom]

Proposed actions

• Remove the AssignId method completely.
• Id assignment to be done always in the Create method.
• Remove the NextId method completely.

Explanation

The AssignId and NextId methods enforce on the user an additional structure that may not be needed.

We propose a shift of the Id assignment to the Create method in all cases.
This leads to simplification of the NextId method that can be removed as well.

This also helps clarifying the responsibility of the Create action.

[alelom]

After chat with @adecler and @kThorsager :

1. initally we thought to move the method in the Create() just to facilitate its implementation.
2. However, after a discussion on Load assignment, we decided to evaluate how to store the IDs in the Adapter itself to avoid issue risen after the DeepClone
3. This will be done thorugh a Dictionary<Type, Dictionary<string,object>> adaptersIds where:
   • Type is the type of the Adapter.
   • Dictionary<string,object>: the string key is the id of the object; the value object is the IBHoMObject reference.
     I believe this adaptersIds dictionary should be static, so it can be shared among all adapters.
     Potentially we could use a KeyedCollection like for the Fragments.

[alelom]

Action needed for Toolkits:

• If you had Config.UseAdapterId set to true, AND you are implementing the Create() method (e.g. it's not empty):
  • The NextId() method is now deleted in the base Adapter. The logic of the Id assignment should now go directly in the Create() method. It is not called automatically anymore by the base Adapter.
    You can either:
    • a) Put the logic for the id assignment in your Create() method(s) as appropriate, before creating the objects.
    • b) Alternatively, keep the existing logic. To do this, you need to:
      • b1) Keep the NextId() as is, but removing the override from its signature
      • b2) Appropriately call the NextId() at the start of your Create() method(s).
        This is needed because the AssignId() method, that was in the base Adapter and was responsible for calling NextId(), has been deleted. You need to place its logic in your toolkit just before the object creation.
        In short, you need to put the following as the first bit of code in your Create() method override:

      // (Feel free to wrap this bit into a method like `AssignId<T>(IEnumerable<T> objects) where T : IBHoMObject`)
      bool refresh = true;
      foreach (var item in objects)
      {
          if (!item.CustomData.ContainsKey(AdapterId)) 
          {
                  item.CustomData[AdapterId] = NextId(item.GetType(), refresh);
                  refresh = false;
          }
      }    

[alelom]

An issue is that it becomes difficult to live with this:

BHoM_Adapter/BHoM_Adapter/HelperMethods/CRUD.cs

Lines 83 to 89 in 7b6e246

	if (Config.UseAdapterId)
	{
	// Map Ids to the original set of objects (before we extracted the distincts elements from it)
	IEqualityComparer<T> comparer = Comparer<T>();
	foreach (T item in objectsToPush)
	item.CustomData[AdapterId] = newObjects.First(x => comparer.Equals(x, item)).CustomData[AdapterId];
	}

that should be either done in all cases (slow because you need to check if Ids have been assigned for each object) or altogether removed.

I need to experiment with the Adapter ID dictionary.

[alelom]

Strategy changed in #164