com.fathzer.soft.ajlib.utilities

Class TextMatcher

java.lang.Object

com.fathzer.soft.ajlib.utilities.TextMatcher

public class TextMatcher
extends Object

A text matcher.
A text matcher allows you to test whether a string matches a filter accordingly to some options as:

• What condition means "matches":
  • String matches is equals to the filter.
  • String contains the filter.
  • String matches the filter (interpreted as a regular expression).
• Case could be ignored ... or not.
• Diacritical marks could be ignored ... or not.

Author:

Jean-Marc Astesana
License: LGPL v3

See Also:

TextMatcher.Kind.REGULAR, TextMatcher.Kind.EQUALS, TextMatcher.Kind.CONTAINS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextMatcher.Kind A kind of comparison a TextMatcher can perform.

Constructor Summary

Constructors

Constructor and Description
TextMatcher(TextMatcher.Kind kind, String filter, boolean caseSensitive, boolean diacriticalSensitive) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Tests whether the argument object is equals to this.
String	getFilter() Gets the filter string.
TextMatcher.Kind	getKind() Gets the kind of comparison.
int	hashCode()
boolean	isCaseSensitive() Tests whether this matcher is case sensitive.
boolean	isDiacriticalSensitive() Tests whether this matcher is diacritical sensitive.
boolean	matches(String text) Tests whether a string matches this matcher.
static String	removeDiacriticals(String string) Removes the diacritical marks from a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextMatcher

public TextMatcher(TextMatcher.Kind kind,
                   String filter,
                   boolean caseSensitive,
                   boolean diacriticalSensitive)

Constructor.

Parameters:

kind - The kind of matcher.

filter - The filter string

caseSensitive - sets the case sensitivity of the comparison (true if the comparison is case sensitive)

diacriticalSensitive - sets the diacritical sensitivity of the comparison (false to ignore diacritical marks).

See Also:

TextMatcher.Kind.REGULAR, TextMatcher.Kind.EQUALS, TextMatcher.Kind.CONTAINS

Method Detail

removeDiacriticals

public static String removeDiacriticals(String string)

Removes the diacritical marks from a string.

Parameters:

string - The string to process

Returns:

a new String with no diacritical marks

getKind

public TextMatcher.Kind getKind()

Gets the kind of comparison.

Returns:

a Kind of comparison.

See Also:

TextMatcher.Kind.REGULAR, TextMatcher.Kind.EQUALS, TextMatcher.Kind.CONTAINS

getFilter

public String getFilter()

Gets the filter string.

Returns:

a String

isCaseSensitive

public boolean isCaseSensitive()

Tests whether this matcher is case sensitive.

Returns:

true if the matcher is case sensitive.

isDiacriticalSensitive

public boolean isDiacriticalSensitive()

Tests whether this matcher is diacritical sensitive.

Returns:

true if the matcher is diacritical sensitive.

matches

public boolean matches(String text)

Tests whether a string matches this matcher.

Parameters:

text - the string to test

Returns:

true if the string matches. If the string is null, this method always returns false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Tests whether the argument object is equals to this.
Two TextMatcher are equals if their kind, filter, caseSensitive and diacriticalSensitive attributes are equals.
Note that two equivalent TextMatchers can not be equals; For instance one with "FILTER" as filter, the other with "filter" and the caseSensitive attribute set to false.

Overrides:

equals in class Object

Parameters:

obj - a textMatcher to test.

See Also:

TextMatcher(Kind, String, boolean, boolean)