ca.odell.glazedlists.filter

Class TextMatcher<E>

java.lang.Object

ca.odell.glazedlists.filter.TextMatcher<E>

All Implemented Interfaces:

Matcher<E>, java.util.function.Predicate<E>

public class TextMatcher<E>
extends java.lang.Object
implements Matcher<E>

Matcher for matching text.

Author:

James Lemieux, Jesse Wilson

Constructor Summary

Constructors

Constructor and Description
TextMatcher(SearchTerm[] searchTerms, TextFilterator<? super E> filterator, int mode, java.lang.Object strategy)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) TextMatcher objects are considered equal if they agree on the mode, strategy, and set of SearchTerms.
int	getMode() Returns the behaviour mode which indicates where to locate the search terms for a successful match.
SearchTerm[]	getSearchTerms() Returns the searchTerms strings matched by this TextMatcher.
java.lang.String[]	getSearchTermStrings() Returns the search term strings matched by this TextMatcher.
java.lang.Object	getStrategy() Returns the strategy which indicates what kind of algorithm to use when determining a match.
int	hashCode()
boolean	matches(E element) Return true if an item matches a filter.
TextMatcher<E>	newFilterator(TextFilterator<? super E> filterator) Return a new TextMatcher identical to this TextMatcher save for the given filterator.
TextMatcher<E>	newMode(int mode) Return a new TextMatcher identical to this TextMatcher save for the given mode.
TextMatcher<E>	newStrategy(java.lang.Object strategy) Return a new TextMatcher identical to this TextMatcher save for the given strategy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.odell.glazedlists.matchers.Matcher

test

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

TextMatcher

public TextMatcher(SearchTerm[] searchTerms,
                   TextFilterator<? super E> filterator,
                   int mode,
                   java.lang.Object strategy)

Parameters:

searchTerms - an array of search terms to be matched

filterator - the object that will extract filter Strings from each object to be matched; null indicates the objects implement TextFilterable

mode - one of TextMatcherEditor.CONTAINS, TextMatcherEditor.STARTS_WITH or TextMatcherEditor.REGULAR_EXPRESSION which indicates where to locate the search terms for a successful match

strategy - one of TextMatcherEditor.IDENTICAL_STRATEGY, TextMatcherEditor.NORMALIZED_STRATEGY or GlazedListsICU4J.UNICODE_TEXT_SEARCH_STRATEGY which indicates what kind of algorithm to use when determining a match

Method Detail

getMode

public int getMode()

Returns the behaviour mode which indicates where to locate the search terms for a successful match.

Returns:

one of TextMatcherEditor.CONTAINS, TextMatcherEditor.STARTS_WITH or TextMatcherEditor.REGULAR_EXPRESSION

getStrategy

public java.lang.Object getStrategy()

Returns the strategy which indicates what kind of algorithm to use when determining a match.

Returns:

one of TextMatcherEditor.IDENTICAL_STRATEGY, TextMatcherEditor.NORMALIZED_STRATEGY or GlazedListsICU4J.UNICODE_TEXT_SEARCH_STRATEGY

getSearchTerms

public SearchTerm[] getSearchTerms()

Returns the searchTerms strings matched by this TextMatcher.

getSearchTermStrings

public java.lang.String[] getSearchTermStrings()

Returns the search term strings matched by this TextMatcher.

matches

public boolean matches(E element)

Return true if an item matches a filter.

Specified by:

matches in interface Matcher<E>

Parameters:

element - The item possibly being filtered.

newMode

public TextMatcher<E> newMode(int mode)

Return a new TextMatcher identical to this TextMatcher save for the given mode.

newFilterator

public TextMatcher<E> newFilterator(TextFilterator<? super E> filterator)

Return a new TextMatcher identical to this TextMatcher save for the given filterator.

newStrategy

public TextMatcher<E> newStrategy(java.lang.Object strategy)

Return a new TextMatcher identical to this TextMatcher save for the given strategy.

equals

public boolean equals(java.lang.Object o)

TextMatcher objects are considered equal if they agree on the mode, strategy, and set of SearchTerms.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object