Package com.vaadin.data.util.filter

Class Compare

java.lang.Object

com.vaadin.data.util.filter.Compare

All Implemented Interfaces:

Container.Filter, Serializable

Direct Known Subclasses:

Compare.Equal, Compare.Greater, Compare.GreaterOrEqual, Compare.Less, Compare.LessOrEqual

public abstract class Compare
extends Object
implements Container.Filter

Simple container filter comparing an item property value against a given constant value. Use the nested classes Compare.Equal, Compare.Greater, Compare.Less, Compare.GreaterOrEqual and Compare.LessOrEqual instead of this class directly. This filter also directly supports in-memory filtering. The reference and actual values must implement Comparable and the class of the actual property value must be assignable from the class of the reference value.

Since:

6.6

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Compare.Equal	A Compare filter that accepts items for which the identified property value is equal to value.
static class	Compare.Greater	A Compare filter that accepts items for which the identified property value is greater than value.
static class	Compare.GreaterOrEqual	A Compare filter that accepts items for which the identified property value is greater than or equal to value.
static class	Compare.Less	A Compare filter that accepts items for which the identified property value is less than value.
static class	Compare.LessOrEqual	A Compare filter that accepts items for which the identified property value is less than or equal to value.
static class	Compare.Operation

Method Summary

Modifier and Type	Method	Description
boolean	appliesToProperty(Object propertyId)	Check if a change in the value of a property can affect the filtering result.
protected int	compareValue(Object value1)
boolean	equals(Object obj)
Compare.Operation	getOperation()	Returns the comparison operation.
Object	getPropertyId()	Returns the property id of the property to compare against the fixed value.
Object	getValue()	Returns the value to compare the property against.
int	hashCode()
boolean	passesFilter(Object itemId, Item item)	Check if an item passes the filter (in-memory filtering).

Methods inherited from class java.lang.Object

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

Method Detail

passesFilter

public boolean passesFilter(Object itemId,
                            Item item)

Description copied from interface: Container.Filter

Check if an item passes the filter (in-memory filtering).

Specified by:

passesFilter in interface Container.Filter

Parameters:

itemId - identifier of the item being filtered; may be null when the item is being added to the container

item - the item being filtered

Returns:

true if the item is accepted by this filter

compareValue

protected int compareValue(Object value1)

appliesToProperty

public boolean appliesToProperty(Object propertyId)

Description copied from interface: Container.Filter

Check if a change in the value of a property can affect the filtering result. May always return true, at the cost of performance. If the filter cannot determine whether it may depend on the property or not, should return true.

Specified by:

appliesToProperty in interface Container.Filter

Returns:

true if the filtering result may/does change based on changes to the property identified by propertyId

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 id of the property to compare against the fixed value.

Returns:

property id (not null)

getOperation

public Compare.Operation getOperation()

Returns the comparison operation.

Returns:

Compare.Operation

getValue

public Object getValue()

Returns the value to compare the property against.

Returns:

comparison reference value