Changeset 17435 for branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/JCGenerator.cs

Timestamp:

02/11/20 17:35:28 (4 years ago)

Author:

dpiringe

Message:

#3026:

• set read-only to false for name input (in JsonItemBaseControl)
• result items now can be selected/deselected in export dialog
• removed metadata.problem property and renamed metadata.optimizer property to TemplateName in json template
• fixed bug with wrong description for result items in AlgorithmConverter
• refactored a lot of code in JCGenerator and added the need for a directory path (location for the template files)
• fixed a null reference bug in JsonItemValidator (cannot try to iterate through possible null referenced collections)

File:

• branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/JCGenerator.cs (modified) (2 diffs)

branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/JCGenerator.cs

@@ -9 +9 @@
 using Newtonsoft.Json.Linq;
 using HEAL.Attic;
+using System.IO;
 
 namespace HeuristicLab.JsonInterface {
@@ -15 +16 @@
   /// </summary>
   public class JCGenerator {
-    private JObject Template { get; set; } = JObject.Parse(Constants.Template);
-    private JArray JArrayItems { get; set; }
-    private IList<IJsonItem> JsonItems { get; set; }
-    private IOptimizer Optimizer { get; set; }
 
-    
-    public string GenerateTemplate(IOptimizer optimizer) {
-      // data container
-      JArrayItems = new JArray();
-      JArray ResultItems = new JArray();
-      JsonItems = new List<IJsonItem>();
+    public void GenerateTemplate(string path, IOptimizer optimizer) =>
+      GenerateTemplate(path, optimizer.Name, optimizer);
 
+    public void GenerateTemplate(string path, string templateName, IOptimizer optimizer) =>
+      GenerateTemplate(path, templateName, optimizer, JsonItemConverter.Extract(optimizer));
+
+    public void GenerateTemplate(string path, string templateName, IOptimizer optimizer, IJsonItem rootItem) {
+      // init
+      JObject template = JObject.Parse(Constants.Template);
+      JArray parameterItems = new JArray();
+      JArray resultItems = new JArray();
+      IList<IJsonItem> jsonItems = new List<IJsonItem>();
+      string fullPath = Path.GetDirectoryName(Path.GetFullPath(path));
+      
+      // recursively filter items with values/ranges/actualNames
+      PopulateJsonItems(rootItem, jsonItems);
+
+      // serialize hl file
       ProtoBufSerializer serializer = new ProtoBufSerializer();
-      serializer.Serialize(optimizer, @"C:\Workspace\template.hl");
-      Template[Constants.Metadata][Constants.HLFileLocation] = @"C:\Workspace\template.hl";
+      string hlFilePath = fullPath + @"\" + templateName + ".hl";
+      serializer.Serialize(optimizer, hlFilePath);
 
-      // extract JsonItem, save the name in the metadata section of the 
-      // template and save it an JArray incl. all parameters of the JsonItem, 
-      // which have parameters aswell
-      AddIItem(optimizer);
-      // save the JArray with JsonItems (= IParameterizedItems)
+      // filter result items
+      foreach (var item in jsonItems) {
+        if (item is ResultItem)
+          resultItems.Add(Serialize(item));
+        else
+          parameterItems.Add(Serialize(item));
+      }
+      
+      // set template data
+      template[Constants.Metadata][Constants.TemplateName] = templateName;
+      template[Constants.Metadata][Constants.HLFileLocation] = hlFilePath;
+      template[Constants.Parameters] = parameterItems;
+      template[Constants.ActivatedResults] = resultItems;
 
-      JArrayItems = new JArray();
-      foreach (var item in JsonItems) {
-        if (item is ResultItem)
-          ResultItems.Add(Serialize(item));
-        else
-          JArrayItems.Add(Serialize(item));
-      }
-      Template[Constants.Parameters] = JArrayItems;
-      Template[Constants.ActivatedResults] = ResultItems;
-      // serialize template and return string
-      return SingleLineArrayJsonWriter.Serialize(Template);
+      // serialize template and write file
+      File.WriteAllText(fullPath + @"\" + templateName + ".json", SingleLineArrayJsonWriter.Serialize(template));
     }
 
-    public string GenerateTemplate(IEnumerable<IJsonItem> items) {
-      ProtoBufSerializer serializer = new ProtoBufSerializer();
-      serializer.Serialize(Optimizer, @"C:\Workspace\template.hl");
-      Template[Constants.Metadata][Constants.HLFileLocation] = @"C:\Workspace\template.hl";
-
-      JArray ResultItems = new JArray();
-
-      JArrayItems = new JArray();
-      foreach (var item in items) {
-        if (item is ResultItem)
-          ResultItems.Add(Serialize(item));
-        else
-          JArrayItems.Add(Serialize(item));
-      }
-      Template[Constants.Parameters] = JArrayItems;
-      Template[Constants.ActivatedResults] = ResultItems;
-
-      // serialize template and return string
-      return SingleLineArrayJsonWriter.Serialize(Template);
-    }
-
-    public string GenerateTemplate(IJsonItem rootItem, IOptimizer optimizer) {
-      // data container
-      Template = JObject.Parse(Constants.Template);
-      JsonItems = new List<IJsonItem>();
-
-      // extract JsonItem, save the name in the metadata section of the 
-      // template and save it an JArray incl. all parameters of the JsonItem, 
-      // which have parameters aswell
-      Template[Constants.Metadata][Constants.Optimizer] = optimizer.Name;
-      PopulateJsonItems(rootItem);
-
-      ProtoBufSerializer serializer = new ProtoBufSerializer();
-      serializer.Serialize(Optimizer, @"C:\Workspace\template.hl");
-      Template[Constants.Metadata][Constants.HLFileLocation] = @"C:\Workspace\template.hl";
-
-      JArray ResultItems = new JArray();
-
-      JArrayItems = new JArray();
-      foreach (var item in JsonItems) {
-        if (item is ResultItem)
-          ResultItems.Add(Serialize(item));
-        else
-          JArrayItems.Add(Serialize(item));
-      }
-      Template[Constants.Parameters] = JArrayItems;
-      Template[Constants.ActivatedResults] = ResultItems;
-
-      // serialize template and return string
-      return SingleLineArrayJsonWriter.Serialize(Template);
-    }
-
-    public IEnumerable<IJsonItem> FetchJsonItems(IOptimizer optimizer) {
-      // data container
-      Template = JObject.Parse(Constants.Template);
-      JsonItems = new List<IJsonItem>();
-      Optimizer = optimizer;
-
-      // extract JsonItem, save the name in the metadata section of the 
-      // template and save it an JArray incl. all parameters of the JsonItem, 
-      // which have parameters aswell
-      AddIItem(optimizer);
-
-      // serialize template and return string
-      return JsonItems;
-    }
-    
-    #region Helper
-
-    private void AddIItem(IItem item) {
-      IJsonItem jsonItem = JsonItemConverter.Extract(item);
-      Template[Constants.Metadata][Constants.Optimizer] = item.ItemName;
-      PopulateJsonItems(jsonItem);
-    }
-
+    #region Helper    
     // serializes ParameterizedItems and saves them in list "JsonItems".
-    private void PopulateJsonItems(IJsonItem item) {
+    private void PopulateJsonItems(IJsonItem item, IList<IJsonItem> jsonItems) {
       IEnumerable<IJsonItem> tmpParameter = item.Children;
       
       if (item.Value != null || item.Range != null || item is ResultItem || item.ActualName != null) {
-        JsonItems.Add(item);
+        jsonItems.Add(item);
       }
 
       if (tmpParameter != null) {
         foreach (var p in tmpParameter) {
-          PopulateJsonItems(p);
+          PopulateJsonItems(p, jsonItems);
         }
       }