Adam Hathcock
105 lines
3.4 KiB
C#
105 lines
3.4 KiB
C#
using Speckle.Core.Common;
|
|
|
|
namespace Speckle.Core.Models.GraphTraversal;
|
|
|
|
/// <summary>
|
|
/// A traversal rule defines the conditional traversal behaviour when traversing a given <see cref="Base"/> objects.
|
|
/// Specifies what members to traverse if any provided <see cref="_conditions"/> are met.
|
|
/// </summary>
|
|
/// <remarks>Follows the builder pattern to ensure that a rule is complete before usable, see usages</remarks>
|
|
public sealed class TraversalRule : ITraversalBuilderReturn, ITraversalBuilderTraverse
|
|
{
|
|
private readonly List<WhenCondition> _conditions;
|
|
private SelectMembers? _membersToTraverse;
|
|
public bool ShouldReturn { get; private set; } = true;
|
|
|
|
private TraversalRule()
|
|
{
|
|
_conditions = new List<WhenCondition>();
|
|
}
|
|
|
|
public ITraversalBuilderReturn ContinueTraversing(SelectMembers membersToTraverse)
|
|
{
|
|
this._membersToTraverse = membersToTraverse;
|
|
return this;
|
|
}
|
|
|
|
public ITraversalRule ShouldReturnToOutput(bool shouldReturn = true)
|
|
{
|
|
ShouldReturn = shouldReturn;
|
|
return this;
|
|
}
|
|
|
|
public ITraversalBuilderTraverse When(WhenCondition condition)
|
|
{
|
|
_conditions.Add(condition);
|
|
return this;
|
|
}
|
|
|
|
bool ITraversalRule.DoesRuleHold(Base o)
|
|
{
|
|
foreach (var condition in _conditions)
|
|
{
|
|
if (condition.Invoke(o))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
IEnumerable<string> ITraversalRule.MembersToTraverse(Base o)
|
|
{
|
|
return _membersToTraverse.NotNull()(o).Distinct(); //TODO distinct is expensive, there may be a better way for us to avoid duplicates
|
|
}
|
|
|
|
/// <returns>a new Traversal Rule to be initialised using the Builder Pattern interfaces</returns>
|
|
public static ITraversalBuilderWhen NewTraversalRule()
|
|
{
|
|
return new TraversalRule();
|
|
}
|
|
}
|
|
|
|
public delegate bool WhenCondition(Base o);
|
|
|
|
/// <summary>
|
|
/// Builder Pattern Interface for a traversal rule in a partially built (unusable state)
|
|
/// </summary>
|
|
public interface ITraversalBuilderWhen
|
|
{
|
|
/// <summary>
|
|
/// Adds a condition to this rule. This rule will hold true when ANY of its conditions holds true.
|
|
/// </summary>
|
|
/// <param name="condition"></param>
|
|
/// <returns>Traversal rule in a building (unusable) state</returns>
|
|
ITraversalBuilderTraverse When(WhenCondition condition);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Delegate for selecting members (by member name) of an given <see cref="Base"/> object
|
|
/// </summary>
|
|
public delegate IEnumerable<string> SelectMembers(Base o);
|
|
|
|
/// <summary>
|
|
/// Builder Pattern Interface for a traversal rule in a partially built (unusable state)
|
|
/// </summary>
|
|
public interface ITraversalBuilderTraverse : ITraversalBuilderWhen
|
|
{
|
|
/// <seealso cref="ITraversalRule.MembersToTraverse"/>
|
|
/// <param name="membersToTraverse">Function returning the members that should be traversed for objects where this rule holds <see langword = "true"/></param>
|
|
/// <returns>Traversal rule in a usable state</returns>
|
|
ITraversalBuilderReturn ContinueTraversing(SelectMembers membersToTraverse);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Builder Pattern Interface for a traversal rule in a usable state, with an (optional) final step to set the value of <see cref="ITraversalRule.ShouldReturn"/>
|
|
/// </summary>
|
|
public interface ITraversalBuilderReturn : ITraversalRule
|
|
{
|
|
/// <seealso cref="ITraversalRule.MembersToTraverse"/>
|
|
/// <param name="shouldReturn">value to set <see cref="ITraversalRule.ShouldReturn"/></param>
|
|
/// <returns>Traversal rule in a usable state</returns>
|
|
ITraversalRule ShouldReturnToOutput(bool shouldReturn = true);
|
|
}
|