org.pfsw.tools.cda.base.model.util

Class StringFilter

java.lang.Object

org.pfsw.text.AStringFilter

org.pfsw.text.StringPattern

org.pfsw.tools.cda.base.model.util.StringFilter

All Implemented Interfaces:

java.io.Serializable, java.util.function.Predicate<java.lang.String>, org.pfsw.bif.filter.IObjectFilter<java.lang.String>, org.pfsw.bif.text.IJSONConvertible, org.pfsw.bif.text.IStringFilter, IStringChecker

public class StringFilter
extends org.pfsw.text.StringPattern
implements IStringChecker

This filter extends StringPattern with the possibility to activate/deactivate it. That is, a deactivated filter never matches anything.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static char	DIGIT_WILDCARD_CHAR
protected static java.lang.String	EXCLUDE_OFF
protected static java.lang.String	EXCLUDE_ON
protected static boolean	SUPPORT_EMPTY_STRING_MATCH

Fields inherited from class org.pfsw.text.StringPattern

DEFAULT_MULTICHAR_WILDCARD, DEFAULT_SINGLECHAR_WILDCARD, SWITCH_OFF, SWITCH_ON

Fields inherited from interface org.pfsw.tools.cda.base.model.util.IStringChecker

ALL_MATCHING, NONE_MATCHING

Fields inherited from interface org.pfsw.bif.text.IStringFilter

ALL, NONE

Fields inherited from interface org.pfsw.bif.text.IJSONConvertible

JSON_ARRAY_END, JSON_ARRAY_START, JSON_ELEMENT_SEPARATOR, JSON_LITERAL_FALSE, JSON_LITERAL_NULL, JSON_LITERAL_TRUE, JSON_OBJECT_END, JSON_OBJECT_START, JSON_PAIR_SEPARATOR, JSON_STRING_DELIMITER, JSON_STRING_ESCAPE

Constructor Summary

Constructors

Constructor and Description
StringFilter(java.lang.String pattern) Initializes the new instance with the string pattern.
StringFilter(java.lang.String pattern, boolean ignoreCase) Initializes the new instance with the string pattern and the selecteion, if case should be ignored when comparing characters.
StringFilter(java.lang.String pattern, boolean ignoreCase, boolean active) Initializes the new instance with the string pattern and the selection, if case should be ignored when comparing characters.
StringFilter(java.lang.String pattern, boolean ignoreCase, char digitWildcard) Initializes the new instance with the string pattern and the selecteion, if case should be ignored when comparing characters plus a wildcard character for digits.
StringFilter(java.lang.String pattern, char digitWildcard) Initializes the new instance with the string pattern and a digit wildcard character.

Method Summary

Modifier and Type	Method and Description
void	appendToBuffer(java.lang.StringBuffer buffer) Append this filter's string representation to the given buffer.
StringFilter	copy() Returns a new object that is an exact copy of this string filter.
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isActive() Returns whether or not this filter is currently active
protected java.lang.String	isActiveAsString()
boolean	isExclude() Returns true if this filter is an exclude filter.
protected java.lang.String	isExcludeAsString()
boolean	matches(java.lang.String probe) Tests if the given string matches the pattern.
void	setActive(boolean active) Sets whether or not this filter is currently active.
void	setExclude(boolean isExclude) Sets whether or not this filter matching must be treated as exclude filter.
java.lang.String	toString()

Methods inherited from class org.pfsw.text.StringPattern

appendAsJSONString, charsAreEqual, containsWildcard, create, create, create, create, digitWildcard, digitWildcard, digitWildcardChar, endNotReached, endReached, eventuallyMatched, getDefaultMultiCharWildcard, getDefaultSingleCharWildcard, getIgnoreCase, getMultiCharWildcard, getPattern, getPatternChar, getSingleCharWildcard, hasDigitWildcard, hasWildcard, ignoreCaseAsString, inspectString, match, matchIgnoreCase, matchReverse, multiCharWildcardMatchesEmptyString, multiCharWildcardMatchesEmptyString, newExaminer, reject, select, selectOrReject, setDigitWildcardChar, setIgnoreCase, setMultiCharWildcard, setPattern, setSingleCharWildcard, skipAfter, skipWildcards, strUtil, toJSON, upToEnd

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pfsw.tools.cda.base.model.util.IStringChecker

test

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Field Detail

SUPPORT_EMPTY_STRING_MATCH

protected static final boolean SUPPORT_EMPTY_STRING_MATCH

See Also:

Constant Field Values

DIGIT_WILDCARD_CHAR

protected static final char DIGIT_WILDCARD_CHAR

See Also:

Constant Field Values

EXCLUDE_ON

protected static final java.lang.String EXCLUDE_ON

See Also:

Constant Field Values

EXCLUDE_OFF

protected static final java.lang.String EXCLUDE_OFF

See Also:

Constant Field Values

Constructor Detail

StringFilter

public StringFilter(java.lang.String pattern,
                    boolean ignoreCase,
                    boolean active)

Initializes the new instance with the string pattern and the selection, if case should be ignored when comparing characters.

Parameters:

pattern - The pattern to check against ( May contain '*' and '?' wildcards )

ignoreCase - Definition, if case sensitive character comparison or not.

active - Defines whether or not the filter is initially active.

StringFilter

public StringFilter(java.lang.String pattern,
                    boolean ignoreCase)

Initializes the new instance with the string pattern and the selecteion, if case should be ignored when comparing characters.

Parameters:

pattern - The pattern to check against ( May contain '*' and '?' wildcards )

ignoreCase - Definition, if case sensitive character comparison or not.

StringFilter

public StringFilter(java.lang.String pattern)

Initializes the new instance with the string pattern. The default is case sensitive checking.

Parameters:

pattern - The pattern to check against ( May contain '*' and '?' wildcards )

StringFilter

public StringFilter(java.lang.String pattern,
                    char digitWildcard)

Initializes the new instance with the string pattern and a digit wildcard character. The default is case sensitive checking.

Parameters:

pattern - The pattern to check against ( May contain '*', '?' wildcards and the digit wildcard )

digitWildcard - A wildcard character that stands as placeholder for digits

StringFilter

public StringFilter(java.lang.String pattern,
                    boolean ignoreCase,
                    char digitWildcard)

Initializes the new instance with the string pattern and the selecteion, if case should be ignored when comparing characters plus a wildcard character for digits.

Parameters:

pattern - The pattern to check against ( May contain '*' and '?' wildcards )

ignoreCase - Definition, if case sensitive character comparison or not.

digitWildcard - A wildcard character that stands as placeholder for digits

Method Detail

isActive

public boolean isActive()

Returns whether or not this filter is currently active

isExclude

public boolean isExclude()

Returns true if this filter is an exclude filter.

setActive

public void setActive(boolean active)

Sets whether or not this filter is currently active.

setExclude

public void setExclude(boolean isExclude)

Sets whether or not this filter matching must be treated as exclude filter.

matches

public boolean matches(java.lang.String probe)

Tests if the given string matches the pattern. If this filter is deactivated this method returns false.

Specified by:

matches in interface org.pfsw.bif.filter.IObjectFilter<java.lang.String>

Specified by:

matches in interface org.pfsw.bif.text.IStringFilter

Overrides:

matches in class org.pfsw.text.StringPattern

Parameters:

probe - The string to compare to the pattern

Returns:

true if and only if the probe matches the pattern, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class org.pfsw.text.StringPattern

hashCode

public int hashCode()

Overrides:

hashCode in class org.pfsw.text.StringPattern

toString

public java.lang.String toString()

Overrides:

toString in class org.pfsw.text.StringPattern

appendToBuffer

public void appendToBuffer(java.lang.StringBuffer buffer)

Append this filter's string representation to the given buffer.

copy

public StringFilter copy()

Returns a new object that is an exact copy of this string filter.

Overrides:

copy in class org.pfsw.text.StringPattern

isActiveAsString

protected java.lang.String isActiveAsString()

isExcludeAsString

protected java.lang.String isExcludeAsString()