Deprecated: Filter2 method

Author: ws-garcia

docs/api/methods/filter.md

@@ -60,6 +60,22 @@ The `Pattern` parameter is evaluated according to the number of records in the C
 * To reference a field value, the user must type something like `f#` where `f` is a required identifier and `#` is the numeric position of the desired field. For example, `f1>5` indicates the selection of records whose first field value is greater than `5`.
 * 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` 
+* The LIKE operator (`$`) comparison is influenced by the `Option Compare` statement (one of: `Option Compare Binary` or `Option Compare Text`). The binary compare is case sensitive, the text compare is not. The following table describes the special characters to be used when creating patterns; all other characters match themselves:
+	* 
+	|Character|Meaning|
+	|:------:|:-----|
+	|?|Any single character|
+	|\*|Zero or more characters|
+	|#|Any single digit (0-9)|
+	|\[list\]|Any single character in list|
+	|\[!list\]|Any single character not in list|
+	|\[\]|A zero-length string ("")|
+* 'list' matches a group of characters in `patterns` to a single character in the string and can contain almost all available characters, including digits.
+* Use a hyphen (-) in 'list' to create a range of characters that matches a character in the string: e.g. [A-D] matches A,B,C, or D at that character position in the string. Multiple ranges of characters can be included in 'list' without the use of a delimiter: e.g. \[A-DJ-L\].
+* Use the hyphen at the start or end of 'list' to match to itself. For example, \[-A-G\] matches a hyphen or any character from A to G.
+* The exclamation mark in the "pattern" match is similar to the negation operator. For example, [!A-G] matches all characters except characters A through G.
+* The exclamation mark outside the bracket  matches itself.
+* To use any special character as a matching character, enclose the special character in brackets. For example, to match a question mark, use \[?\].
 
 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.
 
@@ -76,8 +92,8 @@ Sub FilterCSV()
     CSVint.parseConfig.Headers = False                                      		'The file has no header record/row
     CSVint.parseConfig.path = path
     If path <> vbNullString Then
-        Set FilteredData = CSVint.Filter("f1='Asia' & f9>20 & f9<=50", path) 		'Select "Units sold" greater than 20 and less or 
-																											'equal to 50 from Asian customers
+        Set FilteredData = CSVint.Filter("f1='Asia' & f9>20 & f9<=50 & f8 $ '10/*/2014'", path) 		'Select "Units sold" greater than 20 and less or 
+																																		'equal to 50 from Asian customers in October 2014
         Set CSVint = Nothing
         Set FilteredData = Nothing
     End If

docs/api/methods/filter2.md

@@ -692,57 +692,8 @@ Public Function Filter(Pattern As String, Optional FilePath As String = vbNullSt
         End If
     End If
 End Function
-''' <summary>
-''' Filter imported data using VBA like patterns.
-''' </summary>
-''' <param name="fieldIndex">Field to apply the filter.</param>
-''' <param name="patterns">A valid list of VBA string patterns.</param>
-Public Function Filter2(fieldIndex As Long, ParamArray patterns() As Variant) As CSVArrayList
-    Dim UB As Long
-    Dim LB As Long
-    Dim cIndex As Long
-    Dim rCount As Long
-    Dim mettsPattern As Boolean
-    
-    On Error GoTo ErrHandler_Filter
-    If P_SUCCESSFUL_IMPORT Then
-        Select Case fieldIndex
-            Case 0 To P_VECTORS_REGULAR_BOUND
-                UB = UBound(patterns)
-                If UB >= 0 Then
-                    Set Filter2 = New CSVArrayList
-                    LB = LBound(patterns)
-                    For rCount = 0 To P_CSV_DATA.count - 1
-                        cIndex = LB
-                        Do
-                            mettsPattern = FilterAchievement(P_CSV_DATA(rCount)(fieldIndex), patterns(cIndex))
-                            cIndex = cIndex + 1
-                        Loop While Not mettsPattern And cIndex <= UB
-                        If mettsPattern Then
-                            Filter2.Add P_CSV_DATA(rCount)
-                        End If
-                    Next rCount
-                Else
-                    Set Filter2 = P_CSV_DATA
-                End If
-            Case Else
-                GoTo OutOfBounds_Filter
-        End Select
-    End If
-    Exit Function
-ErrHandler_Filter:
-    P_ERROR_DESC = "[CSV Field Insert]: " & err.Description
-    P_ERROR_NUMBER = err.Number
-    P_ERROR_SOURCE = "CSVinterface"
-    Exit Function
-OutOfBounds_Filter:
-    err.Raise Number:=vbObjectError + 9016, _
-                    Source:="CSVinterface Class", _
-                    Description:="The specified index is out of bounds. Please check and try again."
-    Resume ErrHandler_Filter
-End Function
-Private Function FilterAchievement(aValue As Variant, Pattern As Variant) As Boolean
-    FilterAchievement = aValue Like Pattern
+Private Function FilterAchievement(AValue As Variant, Pattern As Variant) As Boolean
+    FilterAchievement = AValue Like Pattern
 End Function
 Public Function GetDataFromCSV(csvPathAndFilename As String) As String