full_text_search library

Classes

Boost
A single boost - can either be an amount, or a percent
BoostTokenScoring
Boosts certain tokens, like firstName or lastName. This assumes your tokenizer routine also provided named tokens.
ContainsMatch
EqualsMatch
FullTextSearch<T>
Matches items in an array with user-provided search string. The input is split into multiple terms, and there is an option to ensure that each term is matched within the tokens. term The search term. Will be tokenized internally items The list of items to search against isMatchAll Whether or not we should enforce that all terms in term are matched. eg. term="Eric Martineau" should match on "Eric" AND "Martineau" isStartsWith Whether the search will require the search term to match the beginning of the value token or not ignoreCase Whether to ignore case when searching limit The number of results to return tokenize Determines how each item in items should produce searchable tokens
MatchAllTermsScoring
Scoring that applies a boost if all search terms are a match
MatchedTermsScoring
Applies a linear boost based on the number of search terms that were matched. See MatchAllTermsScoring
MatchedTokensScoring
Applies a boost for matched tokens, but adjusts the boost based on whether the term is an exact match, a prefix match, or a contains match
Score
Represents an accumulating score for a search term.
SearchScoring
A scoring algorithm for search results.
StartsWithMatch
TermMatch
The result of a TermMatcher operation; essentially represents a positive match of a search term against a token.
TermMatcher
This file contains term matchers - A matcher examines a search term and available tokens and determines if there are any matches. This can include partial matches, contains, startsWith, etc. Each of these types of matches is represented by a single TermMatcher to make it easy to add/remove them when you're searching. For example, you might want to restrict the search to not include "contains" matches.

Mixins

TermMatcherMixin
Provides the Comparable implementation for subclasses

Constants

defaultMatcherPriority → const int

Properties

searchTermTokenizer → RegExp
final

Typedefs

Tokenizer<T> = List Function(T input)