FilterFunctions class abstract interface

A mixin that provides various filter functions for searching and filtering data.

This mixin contains static methods that can be used to transform strings, count search results, perform Levenshtein distance calculations, and apply filters based on search terms.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

countJaro({required dynamic searchTerms, required Iterable searchOn, bool ignoreCase = true, bool ignoreDiacritics = true, bool ignoreWordSplitters = true, bool splitCamelCase = true}) → double
Calculates the Jaro similarity score between an item and a list of search terms.
countLevenshtein({required dynamic searchTerms, required Iterable searchOnItems, required int levenshteinDistance, bool ignoreCase = true, bool ignoreDiacritics = true, bool ignoreWordSplitters = true, bool splitCamelCase = true}) → int
Calculates the Levenshtein distance between an searchOnItems items and a list of search terms.
countSearch({required dynamic searchTerms, required Iterable searchOnItems, bool ignoreCase = true, bool ignoreDiacritics = true, bool ignoreWordSplitters = true, bool splitCamelCase = true, bool useWildcards = false}) → int
Counts the number of occurrences of search terms in a given item.
fullFilterFunction({required dynamic searchTerms, required Iterable searchOnItems, int levenshteinDistance = 0, bool ignoreCase = true, bool ignoreDiacritics = true, bool ignoreWordSplitters = true, bool splitCamelCase = true, bool useWildcards = false}) → bool
A function that performs a full filter on an item based on search terms.
keySearch<T>({required KeyCharSearches<T> keyCharSearches, required Iterable<T> items, required dynamic searchTerms, int maxResults = 0}) → Iterable<T>
Searches for items in the provided items iterable based on the given searchTerms.
levenshteinFunction({required dynamic searchTerms, required Iterable searchOnItems, required int levenshteinDistance, bool ignoreCase = true}) → bool
Calculates the Levenshtein distance between an item and a collection of search terms.
Searches the iterable for items that match the specified search criteria.
searchFunction({required dynamic searchTerms, required Iterable searchOnItems, int levenshteinDistance = 0, bool ignoreCase = true, bool ignoreDiacritics = true, bool ignoreWordSplitters = true, bool splitCamelCase = true, bool useWildcards = false}) → bool
Searches for a specific item in an iterable based on given search terms and criteria.
searchMap<K, V>({required Iterable<Map<K, V>> items, required dynamic searchTerms, Iterable<K> keys = const [], int levenshteinDistance = 0, bool allIfEmpty = true, bool ignoreCase = true, bool ignoreDiacritics = true, bool ignoreWordSplitters = true, bool splitCamelCase = true, bool useWildcards = false, int maxResults = 0, int minChars = 0}) → Iterable<Map<K, V>>
Searches for JsonRow objects in the iterable based on a search term and specified keys.