Improvements: integration with VBAexpressions core modules.

Author: ws-garcia

docs/api/csvarraylist.md

@@ -52,6 +52,11 @@ Class module developed to emulate some functionalities from the `ArrayList` pres
 <td style="text-align: left;">Concatenates the values from the current instance with the specified values and returns a <code>CSVArraylist</code> object as result. The <code>AValues</code> parameter is a <code>Variant</code> data type containing the array, <code>CSVArraylist</code> or value to concatenate.</td>
 </tr>
 <tr>
+<td style="text-align: left; color:blue;"><em>Concat2</em></td>
+<td style="text-align: left;">Method</td>
+<td style="text-align: left;">Concatenates the values from the current instance with the specified values and returns a <code>CSVArraylist</code> object as result. The <code>AValues</code> parameter is a <code>CSVArraylist</code> with the values to concatenate.</td>
+</tr>
+<tr>
 <td style="text-align: left; color:blue;"><em>Copy</em></td>
 <td style="text-align: left;">Method</td>
 <td style="text-align: left;">Returns a <code>CSVArraylist</code> object with a copy of the current instance from and to a given index. The <code>StartIndex</code> parameter indicates where the copy will start and the <code>EndIndex</code> determines where the operation will end. If the <code>EndIndex</code> parameter is set to <code>-1</code>, the operation will end at the maximum index available for the current instance.</td>
@@ -72,6 +77,11 @@ Class module developed to emulate some functionalities from the `ArrayList` pres
 <td style="text-align: left;">Creates an empty jagged array. The operation will turns the array <code>ArrVar</code> into an jagged array with <code>ArraySize + 1</code> rows and each row with <code>VectorSize</code> columns. To access to an individual element user must use something like <code>expression(i)(j)</code>, where <code>i</code> denotes an index in the main array and <code>j</code> denotes an index in the child array.</td>
 </tr>
 <tr>
+<td style="text-align: left; color:blue;"><em>Filter</em></td>
+<td style="text-align: left;">Method</td>
+<td style="text-align: left;">Returns a filtered array list using the <code>CSVexpressions</code> class module.</td>
+</tr>
+<tr>
 <td style="text-align: left; color:blue;"><em>Insert</em></td>
 <td style="text-align: left;">Method</td>
 <td style="text-align: left;">Inserts an Item, at the given Index, in the current instance of the class.</td>

docs/api/methods/filter.md

@@ -11,14 +11,14 @@ nav_order: 10
 New
 {: .label .label-purple }
 
-Returns a list of records as a result of applying filters on the target CSV file using expression evaluation.
+Returns a list of records as a result of applying filters on the target CSV file or imported CSV data using expression evaluation.
 {: .fs-4 .fw-300 }
 
 ---
 
 ## Syntax
 
-*expression*.`Filter`*(FilePath, Pattern, ExcludeFirstRecord)*
+*expression*.`Filter`*(Pattern, [FilePath], [ExcludeFirstRecord])*
 
 ### Parameters
 
@@ -31,14 +31,14 @@ Returns a list of records as a result of applying filters on the target CSV file
 </thead>
 <tbody>
 <tr>
-<td style="text-align: left;"><em>FilePath</em></td>
-<td style="text-align: left;">Required. Identifier specifying a <code>String</code> Type variable. Represents the full file path, including file extension, of the CSV file used for data filtering.</td>
-</tr>
-<tr>
 <td style="text-align: left;"><em>Pattern</em></td>
 <td style="text-align: left;">Required. Identifier specifying a <code>String</code> Type variable. Represents a valid string expression to evaluate when filtering records</td>
 </tr>
 <tr>
+<td style="text-align: left;"><em>FilePath</em></td>
+<td style="text-align: left;">Optional. Identifier specifying a <code>String</code> Type variable. Represents the full file path, including file extension, of the CSV file used for data filtering.</td>
+</tr>
+<tr>
 <td style="text-align: left;"><em>ExcludeFirstRecord</em></td>
 <td style="text-align: left;">Optional. Identifier specifying a <code>Boolean</code> Type variable. When <code>True</code>, the file headers will be excluded.</td>
 </tr>
@@ -61,6 +61,8 @@ The `Pattern` parameter is evaluated according to the number of records in the C
 * If the user needs to compare literal strings, the values must be enclosed in apostrophes. Example, `Region = 'Central America'` is a valid string assigned to the variable `Region`.
 * User can use functions in the `Pattern` definition, including custom UDFs (refer to [VBAexpressions documentation](https://github.com/ws-garcia/VBA-Expressions)). I.e.: `min(f5;f2)>=100` 
 
+When the `FilePath` argument is omitted, the method will proceed to filter the data stored in the current instance, otherwise it will filter the content of the CSV file specified with the referred argument.
+
 ### ☕Example
 
 ```vb

src/CSVinterface.cls

@@ -655,32 +655,42 @@ End Function
 ''' <summary>
 ''' Filter the target CSV file using expression evaluation.
 ''' </summary>
-''' <param name="FilePath">Full file path, including file extension.</param>
 ''' <param name="Pattern">A valid string expression to evaluate when filtering records.</param>
+''' <param name="FilePath">Full file path, including file extension.</param>
 ''' <param name="ExcludeFirstRecord">Used if the user wants to exclude the headers.</param>
-Public Function Filter(FilePath As String, Pattern As String, _
+Public Function Filter(Pattern As String, Optional FilePath As String = vbNullString, _
                             Optional ExcludeFirstRecord As Boolean = True) As CSVArrayList
+    
     Dim CSVparser As CSVinterface
-    Dim StreamReader As CSVTextStream
-    Dim streamsCounter As Long
 
-    Set CSVparser = New CSVinterface
-    Set StreamReader = New CSVTextStream
     Set Filter = New CSVArrayList
+    If FilePath <> vbnullestring Then 'Filter CSV file
+        Dim StreamReader As CSVTextStream
+        Dim streamsCounter As Long
+        
+        Set CSVparser = New CSVinterface
+        Set StreamReader = New CSVTextStream
 
-    With CSVparser.parseConfig
-        .delimitersGuessing = True
-    End With
-    With StreamReader
-        .endStreamOnLineBreak = True
-        .OpenStream FilePath
-        Do While Not .atEndOfStream
-            .ReadText
-            streamsCounter = streamsCounter + 1
-            CSVparser.ImportFromCSVString .bufferString, CSVparser.parseConfig
-            Filter.Concat2 CSVparser.items.Filter(Pattern, 1 + Abs(ExcludeFirstRecord And streamsCounter = 1))
-        Loop
-    End With
+        With CSVparser.parseConfig
+            .delimitersGuessing = True
+        End With
+        With StreamReader
+            .endStreamOnLineBreak = True
+            .OpenStream FilePath
+            Do While Not .atEndOfStream
+                .ReadText
+                streamsCounter = streamsCounter + 1
+                CSVparser.ImportFromCSVString .bufferString, CSVparser.parseConfig
+                Filter.Concat2 CSVparser.items.Filter(Pattern, 1 + Abs(ExcludeFirstRecord And streamsCounter = 1))
+            Loop
+        End With
+    Else
+        Set CSVparser = Me
+        If CSVparser.importSuccess Then
+            ExcludeFirstRecord = (CSVparser.parseConfig.Headers = True)
+            Filter.Concat2 CSVparser.items.Filter(Pattern, 1 + Abs(ExcludeFirstRecord))
+        End If
+    End If
 End Function
 ''' <summary>
 ''' Filter imported data using VBA like patterns.