New statement RETRIEVE for SQL Data Adapter

Author: aafent

FAST.FBasic.InteractiveConsole/Tests/ApplicationForm.bas

@@ -0,0 +1,60 @@
+REM Word Templating - ApplicationForm (example5)
+REM (This example is similar to example1 at wordTest1.bas)
+REM Create a Loan Application Form by populating with data the template and 
+REM attaching a second document at the end of the first. The example demonstrating
+REM how to retrieve only the necessary for the template data from the database.
+REM
+
+rem Prepare template documents
+FILESTREAM template, inmemory, "", "other", "LoanTemplate.docx"    ' Streams Library
+FILESTREAM final, out, "", "Output", "example5.docx"
+WORDEXTRACTBODY template, text   ' Templating Library
+
+rem Extract metadata
+PHVSDATA allNames text          ' TextReplacer Library
+PHSdata cnames text             ' TextReplacer Library
+
+rem Orchestrate the needed data 
+print "Load data on demand..."
+let AppID=1010  ' Input from the caller application
+let Today = date()
+
+foreach cnames 
+   loginfo "Setting up...."+[cnames.ph]
+   phgosub [cnames.ph] else notfound ' TextReplacer Library
+endforeach cnames
+
+
+rem (v) Do the replacement and save the document
+loginfo "Creating the new document"
+WORDREPALCEBODY template, ALL, allNames   ' Templating Library
+
+
+rem (v) Append Consent 
+FILESTREAM Consent, in, "", "other", "Consent.docx"
+WORDAPPEND Consent, template
+
+SCOPY template,final    ' Streams Library
+
+halt
+
+rem
+rem ...............DATA SOURCES...................
+rem 
+Appl:
+loginfo "Loading Application: "+AppID
+retrieve Appl,NEW,1, "select CustomerID,RequestedAmount,LoanTerms,Purpose,ApplicationDate from Applications  where ApplicationID="+sql(AppID)   ' SQLData Adapter 
+
+return
+
+Cust:
+loginfo "Loading Customer:"+[Appl.CustomerID]
+retrieve Cust,NEW,1, "select Name,VatNumber,Email,Address,City from Customers where CustomerID="+sql([Appl.CustomerID])
+
+return
+
+notfound:
+print "***NOT FOUND***"
+return
+
+End

FAST.FBasic.InteractiveConsole/Tests/Output/example5.docx

@@ -0,0 +1,14 @@
+rem
+
+' RETRIEVE array_name, NEW|APPEND, number|*, SQL Data retrieval statement
+retrieve Cust, APPEND, *, "select CustomerID, Name, Email,City from Customers where CustomerID=1"  
+retrieve Cust, APPEND, 1, "select CustomerID, Name, Email,City from Customers"  
+retrieve Cust, APPEND, 2, "select CustomerID, Name, Email,City from Customers"  
+
+print "Count="+ubound("Cust")
+print [Cust.CustomerID]+": Name:"+[Cust.Name]+", Email: "+[Cust.Email]
+
+
+
+halt
+

FAST.FBasic.InteractiveConsole/Tests/test.bas

@@ -23,6 +23,8 @@ public interface IInterpreter
         InterpretationState GetState();
         FBasicArray GetArray(string name);
         IBasicCollection GetCollection(string name);
+        void DropCollection(string name);
+
         Marker GetCurrentInstructionMarker();
         T GetDataAdapter<T>(string name) where T : IFBasicDataAdapter;
         Value GetVar(string name);

FAST.FBasic.LibraryToolkit/Interfaces/IInterpreter.cs

@@ -11,7 +11,7 @@ public static class ToolKitHelper
         /// <param name="value"></param>
         /// <param name="placeholder"></param>
         /// <returns></returns>
-        public static string FormatStringValue(string placeholder, string value )
+        public static string FormatStringValue(string placeholder, string value)
         {
             // Check for formatter: {name:specifier,modifiers}
             string name = placeholder;
@@ -69,11 +69,11 @@ public static string FormatStringValue(string placeholder, string value )
                 if (modifiers.Contains("D"))
                 {
                     // Date: YYYY-MM-DD to DD-MM-YYYY 
-                    if (value.Length >= 10 )
+                    if (value.Length >= 10)
                     {
                         value = value.Substring(8, 2) + value[4]
-                              + value.Substring(5,2) + value[4]
-                              + value.Substring(0,4) 
+                              + value.Substring(5, 2) + value[4]
+                              + value.Substring(0, 4)
                               + value.Substring(10);
                     }
                 }
@@ -151,5 +151,79 @@ public static string ToProperCase(string input)
             return firstCharUpper + restOfStringLower;
         }
 
+        /// <summary>
+        /// Convert any variable to FBasic Value
+        /// Does not support arrays
+        /// </summary>
+        /// <param name="obj">Input value</param>
+        /// <param name="acceptObjects">Set to true, if object as value type is supported. Default is false</param>
+        /// <returns>Value</returns>
+        public static Value ToValue(object obj, bool acceptObjects = false)
+        {
+            if (obj == null) return Value.Zero;
+            switch (obj)
+            {
+                case char c:
+                    return new Value(c);
+
+                case string s:
+                    return new Value(s);
+
+                case double d:
+                    return new Value(d);
+
+                case float f:
+                    return new Value(f);
+
+                case decimal d:
+                    return new Value(d);
+
+                case int i:
+                    return new Value(i);
+                case uint i:
+                    return new Value(i);
+                case long l:
+                    return new Value(l);
+                case ulong ul:
+                    return new Value(ul);
+
+                case byte b:
+                    return new Value(b);
+
+                case sbyte sb:
+                    return new Value(sb);
+
+                case short sh:
+                    return new Value(sh);
+
+                case ushort sh:
+                    return new Value(sh);
+
+                case DateTime dt:
+                    return new Value(DateOnly.FromDateTime(dt));
+
+                case DateOnly dt:
+                    return new Value(dt);
+
+                case TimeOnly dt:
+                    return new Value(dt);
+
+                case null: // Handle the case where obj is null
+                    throw new ArgumentNullException(nameof(obj));
+
+                default: // Handle any other type
+                    if (!acceptObjects)
+                    {
+                        throw new NotSupportedException($"Type {obj.GetType().Name} is not supported.");
+                    }
+
+                    return new Value(obj, obj.ToString()!);
+
+            }
+
+        }
+
+
     }
 }
+

FAST.FBasic.LibraryToolkit/ToolKit/ToolKitHelper.cs

@@ -1,9 +1,20 @@
-namespace FAST.FBasicInterpreter
+using System.Data;
+
+namespace FAST.FBasicInterpreter
 {
     public static class FBasicArray_ToolKitExtensions
     {
-
-        public static Dictionary<T1, T2> ConvertToDictionary<T1,T2>(this FBasicArray array, int keyIndex=0, int valueIndex=1)
+        /// <summary>
+        /// Convert a FBasic Array to Dictionary 
+        /// </summary>
+        /// <typeparam name="T1">Key type (not nullable)</typeparam>
+        /// <typeparam name="T2">Value type</typeparam>
+        /// <param name="array">The array to convert</param>
+        /// <param name="keyIndex">The index in the array of the key value</param>
+        /// <param name="valueIndex">The index in the array for the value</param>
+        /// <returns>Dictionary</returns>
+        public static Dictionary<T1, T2> ConvertToDictionary<T1,T2>(this FBasicArray array, int keyIndex=0, int valueIndex=1) 
+            where T1:notnull
         {
             var dictionary = new Dictionary<T1, T2>();
 
@@ -27,5 +38,36 @@ public static Dictionary<T1, T2> ConvertToDictionary<T1,T2>(this FBasicArray arr
             return dictionary;
         }
 
+
+        /// <summary>
+        /// Set column names from an IDataRecord (DataReader is IDataRecord)
+        /// Existing column names will be cleared
+        /// </summary>
+        /// <param name="array">Array to set</param>
+        /// <param name="rec">The IDataRecord</param>
+        public static void SetColumnNamesFrom(this FBasicArray array, IDataRecord rec)
+        {
+            array.ResetColumnNames();
+            for (int inx = 0; inx < rec.FieldCount; inx++)
+            {
+                array.SetColumnName(1+inx,rec.GetName(inx)); // 1+ as the FBasic arrays are 1-based 
+            }
+        }
+
+        /// <summary>
+        /// Set column names from another FBasic Array
+        /// Existing column names will be cleared
+        /// </summary>
+        /// <param name="array">Array to set</param>
+        /// <param name="src">The source array</param>
+        public static void SetColumnNamesFrom(this FBasicArray array, FBasicArray src)
+        {
+            array.ResetColumnNames();
+            for (int inx = 0; inx < src.ColumnNamesCount; inx++)
+            {
+                array.SetColumnName(1 + inx, src.GetColumnName(1+inx)); // 1+ as the FBasic arrays are 1-based 
+            }
+        }
+
     }
 }

FAST.FBasic.LibraryToolkit/Types/FBasicArray_ToolKitExtensions.cs

@@ -81,6 +81,16 @@ public Value(double real) : this()
             this.Real = real;
         }
 
+        /// <summary>
+        /// Constructor with a decimal as initial value
+        /// </summary>
+        /// <param name="decimal">the decimal number</param>
+        public Value(decimal val) : this()
+        {
+            this.Type = ValueType.Real;
+            this.Real = decimal.ToDouble(val);
+        }
+
         /// <summary>
         /// Constructor with a value an integer casted to Real as initial value
         /// </summary>
@@ -91,6 +101,27 @@ public Value(int value)
             this.Real = value;
         }
 
+
+        /// <summary>
+        /// Constructor with a value an long casted to Real as initial value
+        /// </summary>
+        /// <param name="value">The long</param>
+        public Value(long value)
+        {
+            this.Type = ValueType.Real;
+            this.Real = value;
+        }
+
+        /// <summary>
+        /// Constructor with a value an ulong casted to Real as initial value
+        /// </summary>
+        /// <param name="value">The ulong</param>
+        public Value(ulong value)
+        {
+            this.Type = ValueType.Real;
+            this.Real = value;
+        }
+
         /// <summary>
         /// Constructor with a boolean as initial value that it is casted to the appropriate Real. 
         /// </summary>

FAST.FBasic.LibraryToolkit/Types/Value.cs

@@ -0,0 +1,11 @@
+
+namespace FAST.FBasicInterpreter.Types
+{
+    /// <summary>
+    /// Extensions for Value class
+    /// </summary>
+    public static class Value_Extensions
+    {
+        // Future code here
+    }
+}

FAST.FBasic.LibraryToolkit/Types/Value_Extensions.cs

@@ -207,7 +207,7 @@ public T GetDataAdapter<T>(string name) where T : IFBasicDataAdapter
         /// <param name="collection">The collection handler</param>
         public void AddCollection(string name, IBasicCollection collection)
         {
-            if (!dataAdapters.ContainsKey(name))
+            if (!collections.ContainsKey(name))
             {
                 collections.Add(name, collection);
             }
@@ -217,6 +217,20 @@ public void AddCollection(string name, IBasicCollection collection)
             }
         }
 
+        /// <summary>
+        /// Drop and forget a collection of the interpreter
+        /// </summary>
+        /// <param name="name">The collection name</param>
+        /// <param name="collection">The collection handler</param>
+        public void DropCollection(string name)
+        {
+            if (!collections.ContainsKey(name)) return;
+
+            collections[name].ClearCollection(); // prepare collection to remove it
+            collections[name].Reset();
+            collections.Remove(name);
+        }
+
         /// <summary>
         /// Request For Object
         /// </summary>

FAST.FBasicInterpreter/Core/Interpreter_Methods.cs

@@ -59,6 +59,10 @@ public bool MoveNext()
             return !this.endOfData;
         }
 
+        /// <summary>
+        /// Reset the Data Reader
+        /// Is the collection is Open, will close it.
+        /// </summary>
         public void Reset()
         {
             if (this.isOpen)
@@ -142,6 +146,11 @@ private static bool isNumericType(Type type)
             }
         }
 
+
+        /// <summary>
+        /// Clear Collection.
+        /// It is synonym to Reset()
+        /// </summary>
         public void ClearCollection()
         {
             Reset();