Merge pull request #4 from RoelantVos/Development_Branch_v1.1

Development branch v1.1

Author: RoelantVos

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation.sln

@@ -1,11 +1,14 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.28307.779
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29920.165
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DataWarehouseAutomation", "DataWarehouseAutomation\DataWarehouseAutomation.csproj", "{F0458983-9646-42E6-9E18-90AD91288B40}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataWarehouseAutomation", "DataWarehouseAutomation\DataWarehouseAutomation.csproj", "{F0458983-9646-42E6-9E18-90AD91288B40}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{D3FD1325-9F54-481B-8363-BC1CF463F589}"
+	ProjectSection(SolutionItems) = preProject
+		..\..\GenericInterface\interfaceDataWarehouseAutomationMetadata.json = ..\..\GenericInterface\interfaceDataWarehouseAutomationMetadata.json
+	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Example_Handlebars", "..\..\Examples\DV_Handlebars\Example_Handlebars.csproj", "{F77AC518-6300-4927-8775-B92CDF15CC8E}"
 EndProject

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/BusinessKey.cs

@@ -8,8 +8,16 @@ namespace DataWarehouseAutomation
     /// </summary>
     public class BusinessKey
     {
-        [JsonProperty]
+        /// <summary>
+        /// Items that define the Business Key e.g. the collection of columns for a Business Key.
+        /// </summary>
+        [JsonProperty("businessKeyComponentMapping")]
         public List<DataItemMapping> businessKeyComponentMapping { get; set; }
+
+        /// <summary>
+        /// An optional label for the end result e.g. the target business key attribute.
+        /// </summary>
+        [JsonProperty("surrogateKey")]
         public string surrogateKey { get; set; }
     }
 }

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/Classification.cs

@@ -0,0 +1,28 @@
+using Newtonsoft.Json;
+
+namespace DataWarehouseAutomation
+{
+    /// <summary>
+    /// A free form list of classifications (labels) and notes to add to a source-to-target mapping
+    /// </summary>
+    public class Classification
+    {
+        /// <summary>
+        /// Optional identifier for the classification
+        /// </summary>
+        [JsonProperty("id")]
+        public int id { get; set; }
+
+        /// <summary>
+        /// Type description, usually a keyword used for automation purposes.
+        /// </summary>
+        [JsonProperty("classification")]
+        public string classification { get; set; }
+
+        /// <summary>
+        /// Free-format notes on the classification.
+        /// </summary>
+        [JsonProperty("notes")]
+        public string notes { get; set; }
+    }
+}

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataConnection.cs

@@ -10,7 +10,10 @@ namespace DataWarehouseAutomation
     /// </summary>
     public class DataConnection
     {
-        [JsonProperty]
+        /// <summary>
+        /// The connection information expressed in a key, token or (connection)string.
+        /// </summary>
+        [JsonProperty("dataConnectionString")]
         public string dataConnectionString { get; set; }
     }
 }

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataObject.cs

@@ -1,18 +1,38 @@
 using Newtonsoft.Json;
-using System;
 using System.Collections.Generic;
-using System.Text;
 
 namespace DataWarehouseAutomation
 {
     public class DataObject
     {
-        [JsonProperty]
+        /// <summary>
+        /// An optional identifier for the Data Object.
+        /// </summary>
+        [JsonProperty("id")]
         public int id { get; set; }
+
+        /// <summary>
+        /// The name of the Data Object.
+        /// </summary>
+        [JsonProperty("name")]
         public string name { get; set; }
 
+        /// <summary>
+        /// The collection of Data Items associated with this Data Object.
+        /// </summary>
+        [JsonProperty("dataItems")]
         public List<DataItem> dataItems { get; set; }
 
+        /// <summary>
+        /// The connection information associated to the Data Object.
+        /// </summary>
+        [JsonProperty("dataObjectConnection")]
         public DataConnection dataObjectConnection { get; set; }
+
+        /// <summary>
+        /// Free-form and optional classification for the Data Object for use in ETL generation logic (evaluation).
+        /// </summary>
+        [JsonProperty("dataObjectClassification")]
+        public List<Classification> dataObjectClassification { get; set; }
     }
 }

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataObjectMapping.cs

@@ -15,17 +15,11 @@ public class DataObjectMapping
         [JsonProperty("mappingName")]
         public string mappingName { get; set; }
 
-        /// <summary>
-        /// TEMPORARY - NEEDS REFACTORING IN RELATED DATA OBJECT CONCEPT
-        /// </summary>
-        [JsonProperty("lookupTable")]
-        public string lookupTable { get; set; }
-
         /// <summary>
         /// Free-form and optional classification for the mapping for use in ETL generation logic (evaluation).
         /// </summary>
         [JsonProperty("mappingClassification")]
-        public List<DataObjectMappingClassification> mappingClassification { get; set; }
+        public List<Classification> mappingClassification { get; set; }
 
         /// <summary>
         /// The source object of the mapping.
@@ -39,6 +33,13 @@ public class DataObjectMapping
         [JsonProperty("targetDataObject")]
         public DataObject targetDataObject { get; set; }
 
+        /// <summary>
+        /// Optional associated data object (collection) for purposes other than source- and target relationship.
+        /// For example Lookups, merge joins etc.
+        /// </summary>
+        [JsonProperty("relatedDataObject")]
+        public List<DataObject> relatedDataObject { get; set; }
+
         /// <summary>
         /// The collection of individual attribute (column) mappings.
         /// </summary>

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataObjectMappingClassification.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace DataWarehouseAutomation
+{
+    public class DataQuery
+    {
+        /// <summary>
+        /// An optional name for the query.
+        /// </summary>
+        [JsonProperty("dataQueryName")]
+        public string dataQueryName { get; set; }
+
+        /// <summary>
+        /// The actual code that constitutes the query.
+        /// </summary>
+        [JsonProperty("dataQueryCode")]
+        public string dataQueryCode { get; set; }
+
+        /// <summary>
+        /// The language that the code was written in (e.g. SQL).
+        /// </summary>
+        [JsonProperty("dataQueryLanguage")]
+        public string dataQueryLanguage { get; set; }
+
+        /// <summary>
+        /// The connection for the query.
+        /// </summary>
+        [JsonProperty("dataQueryConnection")]
+        public DataConnection dataQueryConnection { get; set; }
+    }
+}

ClassLibrary/DataWarehouseAutomation/DataWarehouseAutomation/DataQuery.cs

@@ -19,6 +19,8 @@ static void Main(string[] args)
             fileList.Add(AppDomain.CurrentDomain.BaseDirectory + @"..\..\SampleFiles\sampleTEAM_LSAT.json"); // Validating a Json generated by TEAM / VDW
             fileList.Add(AppDomain.CurrentDomain.BaseDirectory + @"..\..\SampleFiles\sampleVDW_Hub.json"); // Validating a Json generated by TEAM / VDW
             fileList.Add(AppDomain.CurrentDomain.BaseDirectory + @"..\..\SampleFiles\sampleVDW_StagingArea.json"); // Validating a Json generated by TEAM / VDW
+            fileList.Add(AppDomain.CurrentDomain.BaseDirectory + @"..\..\sampleFiles\sampleVDW_HubWithLookup.json"); // Validating a Json generated by TEAM / VDW
+            fileList.Add(AppDomain.CurrentDomain.BaseDirectory + @"..\..\sampleFiles\sampleTEAMv16.json"); // Validating a Json generated by TEAM / VDW
 
             foreach (string jsonFile in fileList)
             {

ClassLibrary/DataWarehouseAutomation/Test_Project/Program.cs

@@ -3,7 +3,10 @@
     {
       "mappingName": "Mapping1",
       "sourceDataObject": {
-        "dataQueryCode": "SELECT GETDATE()"
+        "dataQueryCode": "SELECT GETDATE()",
+        "dataQueryConnection": {
+          "dataConnectionString": "TestConnectionString"
+        }
       },
       "targetDataObject": {
         "name": "TableOneTarget"