Changeset 17330 for branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface

Timestamp:

10/15/19 15:29:36 (5 years ago)

Author:

dpiringe

Message:

#3026

• changed the access modifiers in Constants from public to internal
• added comments in JCGenerator
• the config file for JCInstantiator is now optional
• added Runner.cs (forgot last commit)

Location:

branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface

Files:

• Constants.cs (modified) (1 diff)
• Converters/ParameterizedItemConverter.cs (modified) (1 diff)
• JCGenerator.cs (modified) (3 diffs)
• JCInstantiator.cs (modified) (2 diffs)
• Plugin.cs.frame (modified) (1 diff)

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

@@ -8 +8 @@
   internal class Constants {
 
-    public const string Metadata = "Metadata";
-    public const string Algorithm = "Algorithm";
-    public const string Problem = "Problem";
-    public const string Objects = "Objects";
-    public const string Types = "Types";
-    public const string StaticParameters = "StaticParameters";
-    public const string FreeParameters = "FreeParameters";
+    internal const string Metadata = "Metadata";
+    internal const string Algorithm = "Algorithm";
+    internal const string Problem = "Problem";
+    internal const string Objects = "Objects";
+    internal const string Types = "Types";
+    internal const string StaticParameters = "StaticParameters";
+    internal const string FreeParameters = "FreeParameters";
 
-    public const string Template = @"{
+    internal const string Template = @"{
       'Metadata': {
         'Algorithm':'',

branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Converters/ParameterizedItemConverter.cs

@@ -27 +27 @@
         JsonItem data = JsonItemConverter.Extract(param);
         data.Name = param.Name;
-        data.Path = param.Name;
+        data.Path = data.Name;
         data.PrependPath(item.Path);
         data.UpdatePaths();

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

@@ -15 +15 @@
     private JArray JsonItems { get; set; } = new JArray();
 
+    public string GenerateTemplate(IAlgorithm algorithm) {
+      JsonItems.Clear();
+      TypeList.Clear();
+
+      // 1.1. 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
+      AddInstantiableIItem(Constants.Algorithm, algorithm);
+      if (algorithm.Problem != null) // 1.2. only when an problem exists
+        AddInstantiableIItem(Constants.Problem, algorithm.Problem);
+
+      // 2. save the JArray with JsonItems (= IParameterizedItems)
+      template[Constants.Objects] = JsonItems;
+      // 3. save the types of the JsonItems (for instatiation)
+      template[Constants.Types] = JObject.FromObject(TypeList);
+      // 4. serialize template and return string
+      return CustomJsonWriter.Serialize(template);
+    }
+
+    #region Helper
+    private void AddInstantiableIItem(string metaDataTagName, IItem item) {
+      JsonItem jsonItem = JsonItemConverter.Extract(item);
+      template[Constants.Metadata][metaDataTagName] = item.ItemName;
+      PopulateJsonItems(jsonItem);
+    }
+
     private void PopulateJsonItems(JsonItem item) {
       if (item.Parameters != null) {
-        if(item.Range == null)
+        if (item.Range == null)
           JsonItems.Add(Serialize(item));
         foreach (var p in item.Parameters)
-          if(p.Parameters != null)
+          if (p.Parameters != null)
             PopulateJsonItems(p);
       }
@@ -31 +57 @@
 
       obj.Property(nameof(JsonItem.Parameters))?.Remove();
-      RefactorFreeParameters(obj, null);
+      RefactorFreeParameters(obj);
       RefactorStaticParameters(obj);
 
@@ -41 +67 @@
     }
 
-    public string GenerateTemplate(IAlgorithm algorithm, IProblem problem, params string[] freeParameters) {
-      JsonItems.Clear();
-      TypeList.Clear();
-
-      algorithm.Problem = problem;
-      JsonItem algorithmData = JsonItemConverter.Extract(algorithm);
-      JsonItem problemData = JsonItemConverter.Extract(problem);
-      PopulateJsonItems(algorithmData);
-      PopulateJsonItems(problemData);
-
-      template[Constants.Metadata][Constants.Algorithm] = algorithm.Name;
-      template[Constants.Metadata][Constants.Problem] = problem.Name;
-      template[Constants.Objects] = JsonItems;
-      template[Constants.Types] = JObject.FromObject(TypeList);
-
-      return CustomJsonWriter.Serialize(template);
-    }
-
-    #region Helper
-    private void RefactorFreeParameters(JToken token, string[] freeParameters) {
+    private void RefactorFreeParameters(JToken token) {
       IList<JObject> objToRemove = new List<JObject>();
       TransformNodes(x => {
         var p = x.ToObject<JsonItem>();
-
-        /*bool isSelected = false;
-        string name = x["Name"].ToObject<string>();
-        foreach (var selected in freeParameters)
-          isSelected = (name == selected || isSelected);
-        */
-        if (/*!isSelected ||*/ p.Default == null || (p.Default != null && p.Default.GetType() == typeof(string) && p.Range == null)) {
+        if (p.Default == null || (p.Default != null && p.Default.GetType() == typeof(string) && p.Range == null)) {
           objToRemove.Add(x);
         } else {

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

@@ -23 +23 @@
     private IDictionary<string, JsonItem> ConfigurableItems { get; set; } = new Dictionary<string, JsonItem>();
     
-    public IAlgorithm Instantiate(string templateFile, string configFile) {
+    public IAlgorithm Instantiate(string templateFile, string configFile = "") {
 
       //1. Parse Template and Config files
       Template = JToken.Parse(File.ReadAllText(templateFile));
-      Config = JArray.Parse(File.ReadAllText(configFile));
+      if(!string.IsNullOrEmpty(configFile))
+        Config = JArray.Parse(File.ReadAllText(configFile));
       TypeList = Template[Constants.Types].ToObject<Dictionary<string, string>>();
       string algorithmName = Template[Constants.Metadata][Constants.Algorithm].ToString();
@@ -38 +39 @@
       SelectConfigurableItems();
 
-      //4. Merge Template and Config
-      MergeTemplateWithConfig();
+      //4. if config != null -> merge Template and Config 
+      if (Config != null)
+        MergeTemplateWithConfig();
 
       //5. resolve the references between parameterizedItems

branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Plugin.cs.frame

@@ -20 +20 @@
 #endregion
 
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.IO;
-using System.Text;
-using System.Threading.Tasks;
 using HeuristicLab.PluginInfrastructure;