Changeset 17481 for branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Models/JsonItem.cs

Timestamp:

03/17/20 17:03:24 (4 years ago)

Author:

dpiringe

Message:

#3026:

• refactored json item validation process -> every method now returns a ValidationResult containing bool Success (true if validation is successful) and IEnumerable<string> Errors (error messages)
  • this design allows to specify error messages directly in json items

File:

• branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Models/JsonItem.cs (modified) (4 diffs)

branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Models/JsonItem.cs

@@ -8 +8 @@
 
 namespace HeuristicLab.JsonInterface {
+
+  public readonly struct ValidationResult {
+
+    public static ValidationResult Successful() => new ValidationResult(true, Enumerable.Empty<string>());
+    public static ValidationResult Faulty(IEnumerable<string> errors) => new ValidationResult(false, errors);
+    public static ValidationResult Faulty(string error) => new ValidationResult(false, error);
+
+    public ValidationResult(bool success, IEnumerable<string> errors) {
+      Success = success;
+      Errors = errors;
+    }
+
+    public ValidationResult(bool success, string error) {
+      Success = success;
+      Errors = Enumerable.Repeat(error, 1);
+    }
+
+    public bool Success { get; }
+    public IEnumerable<string> Errors { get; }
+  }
+
   /// <summary>
   /// Main data class for json interface.
@@ -20 +41 @@
       }
 
-      public bool Validate(ref IList<IJsonItem> faultyItems) {
-        faultyItems = new List<IJsonItem>();
-        return ValidateHelper(Root, ref faultyItems);
-      }
-
-      // TODO: return ValidationResult ?
-      private bool ValidateHelper(JsonItem item, ref IList<IJsonItem> faultyItems) {
-        int hash = item.GetHashCode();
-        if (Cache.TryGetValue(hash, out bool r))
-          return r;
-
-        bool res = item.Validate();
-        if (!res) faultyItems.Add(item);
-        Cache.Add(hash, res);
-        if(item.Children != null) {
-          foreach (var child in item.Children)
-            if (!ValidateHelper(child as JsonItem, ref faultyItems))
-              res = false && res;
+      public ValidationResult Validate() {
+        IEnumerable<string> errors = Enumerable.Empty<string>();
+        bool success = true;
+        foreach(var x in Root) {
+          var res = ((JsonItem)x).Validate();
+          //if one success is false -> whole validation is false
+          success = success && res.Success; 
+          errors.Concat(res.Errors);
         }
-        return res;
+        return new ValidationResult(success, errors);
       }
     }
@@ -96 +107 @@
     }
 
-    public virtual IJsonItemValidator GetValidator() => new JsonItemValidator(this);
+    public IJsonItemValidator GetValidator() => new JsonItemValidator(this);
 
     public void FixatePath() => fixedPath = Path;
@@ -112 +123 @@
 
     #region Abstract Methods
-    protected abstract bool Validate();
+    protected abstract ValidationResult Validate();
     #endregion