We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.data.provider.
Package com.vaadin.flow.data.provider
Class DataViewUtils
java.lang.Object
com.vaadin.flow.data.provider.DataViewUtils
Internal utility class used by data view implementations and components to simplify the filtering and sorting handling, but not limited to it.
Since:
Author:
Vaadin Ltd
-
Method Summary
Modifier and TypeMethodDescriptionstatic <T> Optional<SerializablePredicate<T>>getComponentFilter(Component component) Gets the in-memory filter of a given component instance.
static <T> Optional<SerializableComparator<T>>getComponentSortComparator(Component component) Gets the in-memory sort comparator of a given component instance.
static QueryGenerates a data query with component's in-memory filter and sort comparator.
static QueryGenerates a data query with component's in-memory filter and sort comparator, which is optionally included if
withSortingis set totrue.static voidremoveComponentFilterAndSortComparator(Component component) Removes the in-memory filter and sort comparator from a given component instance.
static <T> voidsetComponentFilter(Component component, SerializablePredicate<T> filter) Sets the in-memory filter to a given component instance.
static <T> voidsetComponentSortComparator(Component component, SerializableComparator<T> sortComparator) Sets the in-memory sort comparator to a given component instance.
-
Method Details
-
getComponentFilter
Gets the in-memory filter of a given component instance.
Type Parameters:
T- item typeParameters:
component- component instance the filter is bound toReturns:
optional component's in-memory filter.
-
getComponentSortComparator
public static <T> Optional<SerializableComparator<T>> getComponentSortComparator(Component component) Gets the in-memory sort comparator of a given component instance.
Type Parameters:
T- item typeParameters:
component- component instance the sort comparator is bound toReturns:
optional component's in-memory sort comparator.
-
setComponentFilter
Sets the in-memory filter to a given component instance. The filter replaces any filter that has been set or added previously.
nullwill clear all filters.Type Parameters:
T- items typeParameters:
component- component instance the filter is bound tofilter- component's in-memory filter to be set, ornullto clear any previously set filters -
setComponentSortComparator
public static <T> void setComponentSortComparator(Component component, SerializableComparator<T> sortComparator) Sets the in-memory sort comparator to a given component instance. The sort comparator replaces any sort comparator that has been set or added previously.
nullwill clear all sort comparators.Type Parameters:
T- items typeParameters:
component- component instance the sort comparator is bound tosortComparator- component's in-memory sort comparator to be set, ornullto clear any previously set sort comparators -
removeComponentFilterAndSortComparator
Removes the in-memory filter and sort comparator from a given component instance.
Parameters:
component- component instance the filter and sort comparator are removed from -
getQuery
Generates a data query with component's in-memory filter and sort comparator.
Parameters:
component- component instance the filter and sort comparator are bound toReturns:
query instance
-
getQuery
Generates a data query with component's in-memory filter and sort comparator, which is optionally included if
withSortingis set totrue.Parameters:
component- component instance the filter and sort comparator are bound towithSorting- iftrue, the component's sort comparator will be included in the query.Returns:
query instance
-