eu.vaadinonkotlin

Interface FilterFactory<F>

Type Parameters:

F - the type of the filter objects. Every database access type or DataProvider implementation may have different filters; for example VoK-ORM defines its own hierarchy of filters.

public FilterFactory<F>

Used by filter components (such as NumberInterval) to create actual filter objects. The filters are expected to have properly implemented Any.equals, Any.hashCode and Any.toString, to allow for filter expression simplification (e.g. to remove non-unique filters from AND or OR expressions).

The filter objects produced by this factory will be passed into Vaadin's DataProvider in the Query object.

See Also:

Any.equals, Any.hashCode, Any.toString

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FilterFactory.DefaultImpls Used by filter components (such as NumberInterval) to create actual filter objects. The filters are expected to have properly implemented Any.equals, Any.hashCode and Any.toString, to allow for filter expression simplification (e.g. to remove non-unique filters from AND or OR expressions).

Method Summary

Modifier and Type	Method and Description
F	and(java.util.Set<? extends F> filters) ANDs given set of filters and returns a new filter.
F	between(java.lang.String propertyName, java.lang.Object min, java.lang.Object max) Creates a filter which accepts only such values of given propertyName which are greater than or equal to given min and less than or equal to given max.
F	eq(java.lang.String propertyName, java.lang.Object value) Creates a filter which matches the value of given propertyName to given value.
F	ge(java.lang.String propertyName, java.lang.Object value) Creates a filter which accepts only such values of given propertyName which are greater than or equal to given value.
F	ilike(java.lang.String propertyName, java.lang.String value) Creates a filter which performs a case-insensitive substring matching of given propertyName to given value.
F	le(java.lang.String propertyName, java.lang.Object value) Creates a filter which accepts only such values of given propertyName which are less than or equal to given value.
F	or(java.util.Set<? extends F> filters) ORs given set of filters and returns a new filter.

Method Detail

and

F and(java.util.Set<? extends F> filters)

ANDs given set of filters and returns a new filter.

Parameters:

filters - set of filters, may be empty.

Returns:

a filter which ANDs given filter set; returns null when the filter set is empty.

or

F or(java.util.Set<? extends F> filters)

ORs given set of filters and returns a new filter.

Parameters:

filters - set of filters, may be empty.

Returns:

a filter which ORs given filter set; returns null when the filter set is empty.

eq

F eq(java.lang.String propertyName,
     java.lang.Object value)

Creates a filter which matches the value of given propertyName to given value.

le

F le(java.lang.String propertyName,
     java.lang.Object value)

Creates a filter which accepts only such values of given propertyName which are less than or equal to given value.

ge

F ge(java.lang.String propertyName,
     java.lang.Object value)

Creates a filter which accepts only such values of given propertyName which are greater than or equal to given value.

ilike

F ilike(java.lang.String propertyName,
        java.lang.String value)

Creates a filter which performs a case-insensitive substring matching of given propertyName to given value.

Parameters:

value - not empty; matching rows must contain this string. To emit SQL LIKE statement you need to prepend and append '%' to this string.

between

F between(java.lang.String propertyName,
          java.lang.Object min,
          java.lang.Object max)

Creates a filter which accepts only such values of given propertyName which are greater than or equal to given min and less than or equal to given max.