com.xdev.data.util.filter

Class CaptionStringFilter

java.lang.Object

com.xdev.data.util.filter.CaptionStringFilter

All Implemented Interfaces:

Container.Filter, Serializable

public class CaptionStringFilter
extends Object
implements Container.Filter

Author:

XDEV Software

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CaptionStringFilter(Object propertyId, String filterString, boolean ignoreCase, boolean onlyMatchPrefix, String itemCaptionValue)

Method Summary

Modifier and Type	Method and Description
boolean	appliesToProperty(Object propertyId)
boolean	equals(Object obj)
String	getFilterString() Returns the filter string.
Object	getPropertyId() Returns the property identifier to which this filter applies.
int	hashCode()
boolean	isIgnoreCase() Returns whether the filter is case-insensitive or case-sensitive.
boolean	isOnlyMatchPrefix() Returns true if the filter only applies to the beginning of the value string, false for any location in the value.
boolean	passesFilter(Object itemId, Item item)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CaptionStringFilter

public CaptionStringFilter(Object propertyId,
                           String filterString,
                           boolean ignoreCase,
                           boolean onlyMatchPrefix,
                           String itemCaptionValue)

Method Detail

passesFilter

public boolean passesFilter(Object itemId,
                            Item item)

Specified by:

passesFilter in interface Container.Filter

appliesToProperty

public boolean appliesToProperty(Object propertyId)

Specified by:

appliesToProperty in interface Container.Filter

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPropertyId

public Object getPropertyId()

Returns the property identifier to which this filter applies.

Returns:

property id

getFilterString

public String getFilterString()

Returns the filter string. Note: this method is intended only for implementations of lazy string filters and may change in the future.

Returns:

filter string given to the constructor

isIgnoreCase

public boolean isIgnoreCase()

Returns whether the filter is case-insensitive or case-sensitive. Note: this method is intended only for implementations of lazy string filters and may change in the future.

Returns:

true if performing case-insensitive filtering, false for case-sensitive

isOnlyMatchPrefix

public boolean isOnlyMatchPrefix()

Returns true if the filter only applies to the beginning of the value string, false for any location in the value. Note: this method is intended only for implementations of lazy string filters and may change in the future.

Returns:

true if checking for matches at the beginning of the value only, false if matching any part of value