Introduced new AttributeValuesDataTable class

JeremyCaney · JeremyCaney · commit 313fe716dcf5 · 2020-05-28T14:22:42.000-07:00
The new `AttributeValuesDataTable` centralizes the definition of the `AttributeValues` table-valued type from the SQL Server database schema, and exposes a convenience method for constructing new records.
diff --git a/OnTopic.Data.Sql/Models/AttributeValuesDataTable.cs b/OnTopic.Data.Sql/Models/AttributeValuesDataTable.cs
@@ -0,0 +1,75 @@
+﻿/*==============================================================================================================================
+| Author        Ignia, LLC
+| Client        Ignia, LLC
+| Project       Topics Library
+\=============================================================================================================================*/
+using System.Data;
+
+namespace OnTopic.Data.Sql.Models {
+
+  /*============================================================================================================================
+  | CLASS: ATTRIBUTE VALUES (DATA TABLE)
+  \---------------------------------------------------------------------------------------------------------------------------*/
+  /// <summary>
+  ///   Extends <see cref="DataTable"/> to model the schema for the <c>AttributeValues</c> user-defined table type.
+  /// </summary>
+  public class AttributeValuesDataTable: DataTable {
+
+    /*==========================================================================================================================
+    | CONSTRUCTOR
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Establishes a new <see cref="DataTable"/> with the appropriate schema for the <c>AttributeValues</c> user-defined
+    ///   table type.
+    /// </summary>
+    public AttributeValuesDataTable() {
+
+      /*------------------------------------------------------------------------------------------------------------------------
+      | COLUMN: Attribute Key
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      Columns.Add(
+        new DataColumn("AttributeKey") {
+          MaxLength             = 128
+        }
+      );
+
+      /*------------------------------------------------------------------------------------------------------------------------
+      | COLUMN: Attribute Value
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      Columns.Add(
+        new DataColumn("AttributeValue") {
+          MaxLength             = 255
+        }
+      );
+
+    }
+
+    /*==========================================================================================================================
+    | ADD ROW
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Provides a convenience method for adding a new <see cref="DataRow"/> based on the expected column values.
+    /// </summary>
+    public DataRow AddRow(string attributeKey, string? attributeValue = null) {
+
+      /*------------------------------------------------------------------------------------------------------------------------
+      | Define record
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      var record                = NewRow();
+      record["AttributeKey"]    = attributeKey;
+      record["AttributeValue"]  = attributeValue;
+
+      /*------------------------------------------------------------------------------------------------------------------------
+      | Add record
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      Rows.Add(record);
+
+      /*------------------------------------------------------------------------------------------------------------------------
+      | Return record
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      return record;
+
+    }
+
+  } //Class
+} //Namespaces
