Merge pull request #20 from data-solution-automation-engine/dev-may-updates

Dev may updates

Author: RoelantVos

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation.sln

@@ -21,7 +21,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Sample Metadata", "Sample M
 		Sample_Metadata\sampleBasic.json = Sample_Metadata\sampleBasic.json
 		Sample_Metadata\sampleBasicWithExtensions.json = Sample_Metadata\sampleBasicWithExtensions.json
 		Sample_Metadata\sampleCalculation.json = Sample_Metadata\sampleCalculation.json
-		Sample_Metadata\sampleCustomFunctions.json = Sample_Metadata\sampleCustomFunctions.json
 		Sample_Metadata\sampleFreeForm.json = Sample_Metadata\sampleFreeForm.json
 		Sample_Metadata\sampleJsonStagingWithPsaDetails.json = Sample_Metadata\sampleJsonStagingWithPsaDetails.json
 		Sample_Metadata\sampleMultipleDataItemMappings.json = Sample_Metadata\sampleMultipleDataItemMappings.json
@@ -47,6 +46,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Sample Templates", "Sample
 		Sample_Templates\TemplateSampleFreeForm.Handlebars = Sample_Templates\TemplateSampleFreeForm.Handlebars
 		Sample_Templates\TemplateSampleMultipleDataItemMappings.Handlebars = Sample_Templates\TemplateSampleMultipleDataItemMappings.Handlebars
 		Sample_Templates\TemplateSampleSimpleDDL.Handlebars = Sample_Templates\TemplateSampleSimpleDDL.Handlebars
+		Sample_Templates\TemplateSampleSourceQuery.Handlebars = Sample_Templates\TemplateSampleSourceQuery.Handlebars
 		Sample_Templates\TemplateSatelliteView.Handlebars = Sample_Templates\TemplateSatelliteView.Handlebars
 	EndProjectSection
 EndProject

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/BusinessKeyDefinition.cs

@@ -1,5 +1,5 @@
 using System.Collections.Generic;
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 namespace DataWarehouseAutomation;
 
@@ -9,29 +9,39 @@ namespace DataWarehouseAutomation;
 /// </summary>
 public class BusinessKeyDefinition
 {
+    #nullable enable
+
+    /// <summary>
+    /// Optional identifier as a string value to allow various identifier approaches.
+    /// </summary>
+    [JsonPropertyName("id")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+    public string Id { get; set; } = string.Empty;
+
     /// <summary>
     /// Items that define the Business Key e.g. the collection of columns for a Business Key.
     /// </summary>
-    [JsonProperty("businessKeyComponentMapping")]
+    [JsonPropertyName("businessKeyComponentMapping")]
     public List<DataItemMapping> BusinessKeyComponentMapping { get; set; } = new();
 
-#nullable enable
-
     /// <summary>
     /// An optional label for the end result e.g. the target business key attribute.
     /// </summary>
-    [JsonProperty("surrogateKey", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("surrogateKey")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public string? SurrogateKey { get; set; }
 
     /// <summary>
     /// Free-form and optional classification for the Business Key for use in generation logic (evaluation).
     /// </summary>
-    [JsonProperty("businessKeyClassification", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("businessKeyClassification")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public List<DataClassification>? BusinessKeyClassification { get; set; }
 
     /// <summary>
     /// The collection of extension Key/Value pairs.
     /// </summary>
-    [JsonProperty("extensions", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("extensions")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public List<Extension>? Extensions { get; set; }
 }

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataClassification.cs

@@ -1,30 +1,61 @@
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 namespace DataWarehouseAutomation;
 
 /// <summary>
-/// A free form list of classifications (labels) and notes to add to a data object mapping.
+/// Used to define a list of classifications (labels) and notes to add to a data object mapping.
 /// A classification can be used to identify a certain type of data object mapping.
 /// </summary>
 public class DataClassification
 {
-#nullable enable
+    #nullable enable
 
     /// <summary>
-    /// Optional identifier for the classification.
+    /// Optional identifier as a string value to allow various identifier approaches.
     /// </summary>
-    [JsonProperty("id", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
-    public int? Id { get; set; }
+    [JsonPropertyName("id")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+    public string Id { get; set; } = string.Empty;
 
     /// <summary>
-    /// Type mandatory description, usually a keyword used for automation purposes.
+    /// The mandatory classification description, usually a keyword used for automation purposes.
     /// </summary>
-    [JsonProperty("classification")]
+    [JsonPropertyName("classification")]
     public string Classification { get; set; } = "NewClassification";
 
     /// <summary>
     /// Free-format notes on the classification.
     /// </summary>
-    [JsonProperty("notes", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("notes")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public string? Notes { get; set; }
-}
+
+    #region Methods
+    /// <summary>
+    /// Use this method to assert an object as a DataClassification (or not).
+    /// </summary>
+    /// <param name="o"></param>
+    /// <returns></returns>
+    public override bool Equals(object? o)
+    {
+        var other = o as DataClassification;
+        return other?.Id == Id;
+    }
+
+    /// <summary>
+    /// Override to get a hash value that represents the identifier. 
+    /// </summary>
+    /// <returns></returns>
+    public override int GetHashCode() => Id.GetHashCode();
+
+    /// <summary>
+    /// String override so that the object returns the classification value ('classification').
+    /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Classification" property will be returned.
+    /// </summary>
+    /// <returns></returns>
+    public override string ToString()
+    {
+        return Classification;
+    }
+    #endregion
+}

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataConnection.cs

@@ -1,5 +1,5 @@
 using System.Collections.Generic;
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
 
 namespace DataWarehouseAutomation;
 
@@ -8,17 +8,54 @@ namespace DataWarehouseAutomation;
 /// </summary>
 public class DataConnection
 {
-#nullable enable
+    #nullable enable
+
+    /// <summary>
+    /// Optional identifier as a string value to allow various identifier approaches.
+    /// </summary>
+    [JsonPropertyName("id")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+    public string Id { get; set; } = string.Empty;
 
     /// <summary>
     /// The connection information expressed in a key, token or (connection)string.
     /// </summary>
-    [JsonProperty("dataConnectionString")]
+    [JsonPropertyName("dataConnectionString")]
     public string DataConnectionString { get; set; } = "NewConnection";
 
     /// <summary>
     /// The collection of extension Key/Value pairs.
     /// </summary>
-    [JsonProperty("extensions", NullValueHandling = NullValueHandling.Ignore)]
+    [JsonPropertyName("extensions")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public List<Extension>? Extensions { get; set; }
+
+    #region Methods
+    /// <summary>
+    /// Use this method to assert an object as a DataConnection (or not).
+    /// </summary>
+    /// <param name="o"></param>
+    /// <returns></returns>
+    public override bool Equals(object? o)
+    {
+        var other = o as DataConnection;
+        return other?.Id == Id;
+    }
+
+    /// <summary>
+    /// Override to get a hash value that represents the identifier. 
+    /// </summary>
+    /// <returns></returns>
+    public override int GetHashCode() => Id.GetHashCode();
+
+    /// <summary>
+    /// String override so that the object returns its value ('connection string').
+    /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Connection String" property will be returned.
+    /// </summary>
+    /// <returns></returns>
+    public override string ToString()
+    {
+        return DataConnectionString;
+    }
+    #endregion
 }

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataItem.cs

@@ -1,51 +1,98 @@
-using Newtonsoft.Json;
-using System.Collections.Generic;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace DataWarehouseAutomation;
 
+
 public class DataItem
 {
-#nullable enable
+    #nullable enable
+
+    /// <summary>
+    /// Optional identifier as a string value to allow various identifier approaches.
+    /// </summary>
+    [JsonPropertyName("id")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+    public string Id { get; set; } = string.Empty;
 
-    [JsonProperty("name")]
+    [JsonPropertyName("name")]
     public string Name { get; set; } = "NewDataItemName"; // Mandatory
 
     /// <summary>
     /// The data object to which the data item belongs. This can be used to construct fully qualified names.
     /// </summary>
-    [JsonProperty("dataObject", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("dataObject")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public DataObject? DataObject { get; set; }
 
-    [JsonProperty("dataType", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("dataType")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public string? DataType { get; set; }
 
-    [JsonProperty("characterLength", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("characterLength")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public int? CharacterLength { get; set; }
 
-    [JsonProperty("numericPrecision", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("numericPrecision")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public int? NumericPrecision { get; set; }
 
-    [JsonProperty("numericScale", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("numericScale")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public int? NumericScale { get; set; }
 
-    [JsonProperty("ordinalPosition", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("ordinalPosition")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public int? OrdinalPosition { get; set; }
 
-    [JsonProperty("isPrimaryKey", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("isPrimaryKey")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public bool? IsPrimaryKey { get; set; }
 
-    [JsonProperty("isHardCodedValue", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("isHardCodedValue")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public bool? IsHardCodedValue { get; set; }
 
     /// <summary>
     /// Free-form and optional classification for the Data Item for use in generation logic (evaluation).
     /// </summary>
-    [JsonProperty("dataItemClassification", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
+    [JsonPropertyName("dataItemClassification")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public List<DataClassification>? DataItemClassification { get; set; }
 
     /// <summary>
     /// The collection of extension Key/Value pairs.
     /// </summary>
-    [JsonProperty("extensions", NullValueHandling = NullValueHandling.Ignore)]
+    [JsonPropertyName("extensions")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public List<Extension>? Extensions { get; set; }
+
+    #region Methods
+    /// <summary>
+    /// Use this method to assert an object as a DataItem (or not).
+    /// </summary>
+    /// <param name="o"></param>
+    /// <returns></returns>
+    public override bool Equals(object? o)
+    {
+        var other = o as DataItem;
+        return other?.Id == Id;
+    }
+
+    /// <summary>
+    /// Override to get a hash value that represents the identifier. 
+    /// </summary>
+    /// <returns></returns>
+    public override int GetHashCode() => Id.GetHashCode();
+
+    /// <summary>
+    /// String override so that the object returns its value ('name').
+    /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the "Name" property will be returned.
+    /// </summary>
+    /// <returns></returns>
+    public override string ToString()
+    {
+        return Name;
+    }
+    #endregion
 }

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataItemMapping.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
-using Newtonsoft.Json;
+using System.Text.Json.Serialization;
+using System.Xml.Linq;
 
 namespace DataWarehouseAutomation;
 
@@ -8,18 +9,54 @@ namespace DataWarehouseAutomation;
 /// </summary>
 public class DataItemMapping
 {
-#nullable enable
+    #nullable enable
 
-    [JsonProperty("sourceDataItems")]
+    /// <summary>
+    /// Optional identifier as a string value to allow various identifier approaches.
+    /// </summary>
+    [JsonPropertyName("id")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+    public string Id { get; set; } = string.Empty;
+
+    [JsonPropertyName("sourceDataItems")]
     public List<dynamic> SourceDataItems { get; set; } = new();
 
-    [JsonProperty("targetDataItem")]
+    [JsonPropertyName("targetDataItem")]
     public DataItem TargetDataItem { get; set; } = new() { Name = "NewTargetDataItem" };
 
     /// <summary>
     /// The collection of extension Key/Value pairs.
     /// </summary>
-    [JsonProperty("extensions", NullValueHandling = NullValueHandling.Ignore)]
+    [JsonPropertyName("extensions")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public List<Extension>? Extensions { get; set; }
 
+    #region Methods
+    /// <summary>
+    /// Use this method to assert an object as a DataItemMapping (or not).
+    /// </summary>
+    /// <param name="o"></param>
+    /// <returns></returns>
+    public override bool Equals(object? o)
+    {
+        var other = o as DataItemMapping;
+        return other?.Id == Id;
+    }
+
+    /// <summary>
+    /// Override to get a hash value that represents the identifier. 
+    /// </summary>
+    /// <returns></returns>
+    public override int GetHashCode() => Id.GetHashCode();
+
+    /// <summary>
+    /// String override so that the object returns its value ('name of the target data item').
+    /// When an instance of this class is passed to a method that expects a string, the ToString() method will be called implicitly to convert the object to a string, and the value of the Data Item "Name" property will be returned.
+    /// </summary>
+    /// <returns></returns>
+    public override string ToString()
+    {
+        return TargetDataItem.Name;
+    }
+    #endregion
 }