ca.odell.glazedlists.filter

Class TextMatchers

java.lang.Object

ca.odell.glazedlists.filter.TextMatchers

public final class TextMatchers
extends java.lang.Object

Common services required when implementing a Matcher that performs text matching.

Author:

James Lemieux

Constructor Summary

Constructors

Constructor and Description
TextMatchers()

Method Summary

Modifier and Type	Method and Description
static boolean	isMatcherConstrained(TextMatcher oldMatcher, TextMatcher newMatcher) A method to determine if newMatcher is an absolute constrainment of oldMatcher, meaning it is guaranteed to match fewer items than the oldMatcher.
static boolean	isMatcherRelaxed(TextMatcher oldMatcher, TextMatcher newMatcher) A method to determine if newMatcher is an absolute relaxation of oldMatcher, meaning it is guaranteed to match more items than the oldMatcher.
static <E> boolean	matches(java.util.List<java.lang.String> filterStrings, TextFilterator<? super E> filterator, SearchTerm<E>[] searchTerms, TextSearchStrategy[] filterStrategies, E element) Execute the logic that determines whether the given element is matched by all of the given filterStrategies.
static SearchTerm[]	normalizeSearchTerms(SearchTerm[] filters, TextSearchStrategy.Factory strategy) This convenience function maps each of the filters by running each of their characters through the characterMap.
static <E> SearchTerm<E>[]	parse(java.lang.String text) Parse the given text and produce an array of SearchTerm objects that describe text to match as well as metadata about the way it should be used.
static <E> SearchTerm<E>[]	parse(java.lang.String text, java.util.Set<SearchEngineTextMatcherEditor.Field<E>> fields) Parse the given text and produce an array of SearchTerm objects that describe text to match as well as metadata about the way it should be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextMatchers

public TextMatchers()

Method Detail

matches

public static <E> boolean matches(java.util.List<java.lang.String> filterStrings,
                                  TextFilterator<? super E> filterator,
                                  SearchTerm<E>[] searchTerms,
                                  TextSearchStrategy[] filterStrategies,
                                  E element)

Execute the logic that determines whether the given element is matched by all of the given filterStrategies. An optional filterator can be supplied which is responsible for extracting all of the filter strings from the given element. The given filterStrings is passed into this method simply to avoid reallocating a new List object each time this method is called. The caller may and should recycle the filterStrings List.

Parameters:

filterStrings - a recyclable List into which the filter Strings can stored

filterator - the logic capable of extracting filtering Strings from the element

searchTerms - SearchTerm objects defining each piece of search text as well as metadata about the text

filterStrategies - the optimized logic for locating given search text within the filterStrings

element - the list element on which we are text filtering

Returns:

true if all filterStrategies located matching text within the filterStrings extracted from the given element

normalizeSearchTerms

public static SearchTerm[] normalizeSearchTerms(SearchTerm[] filters,
                                                TextSearchStrategy.Factory strategy)

This convenience function maps each of the filters by running each of their characters through the characterMap. It also removes unnecessary SearchTerms which are not marked as required.

Parameters:

filters - the filter Strings to be normalized

strategy - the strategy for mapping a character

Returns:

mapped versions of the filter Strings

parse

public static <E> SearchTerm<E>[] parse(java.lang.String text)

Parse the given text and produce an array of SearchTerm objects that describe text to match as well as metadata about the way it should be used.

Parameters:

text - the raw text entered by a user

Returns:

SearchTerm an object encapsulating a single raw search term as well as metadata related to the use of the SearchTerm

parse

public static <E> SearchTerm<E>[] parse(java.lang.String text,
                                        java.util.Set<SearchEngineTextMatcherEditor.Field<E>> fields)

Parse the given text and produce an array of SearchTerm objects that describe text to match as well as metadata about the way it should be used. When parsing the text, the given Set of SearchEngineTextMatcherEditor.Field objects should be considered to detect when the user has entered a field-specific SearchTerm.

Parameters:

text - the raw text entered by a user

fields - a Set of objects describing each field that can be independently matched

Returns:

SearchTerm an object encapsulating a single raw search term as well as metadata related to the use of the SearchTerm

isMatcherConstrained

public static boolean isMatcherConstrained(TextMatcher oldMatcher,
                                           TextMatcher newMatcher)

A method to determine if newMatcher is an absolute constrainment of oldMatcher, meaning it is guaranteed to match fewer items than the oldMatcher.

Parameters:

oldMatcher - the old TextMatcher being replaced

newMatcher - the new TextMatcher to be used

Returns:

true iff the newMatcher is guaranteed to match the same or fewer items than oldMatcher

isMatcherRelaxed

public static boolean isMatcherRelaxed(TextMatcher oldMatcher,
                                       TextMatcher newMatcher)

A method to determine if newMatcher is an absolute relaxation of oldMatcher, meaning it is guaranteed to match more items than the oldMatcher.

Parameters:

oldMatcher - the old TextMatcher being replaced

newMatcher - the new TextMatcher to be used

Returns:

true iff the newMatcher is guaranteed to match the same or more items than oldMatcher