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.hierarchy.
Class TreeDataProvider<T>
- java.lang.Object
-
- com.vaadin.flow.data.provider.AbstractDataProvider<T,F>
-
- com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider<T,SerializablePredicate<T>>
-
- com.vaadin.flow.data.provider.hierarchy.TreeDataProvider<T>
-
Type Parameters:
T- data typeAll Implemented Interfaces:
ConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>, DataProvider<T,SerializablePredicate<T>>, HierarchicalDataProvider<T,SerializablePredicate<T>>, InMemoryDataProvider<T>, Serializable
public class TreeDataProvider<T> extends AbstractHierarchicalDataProvider<T,SerializablePredicate<T>> implements InMemoryDataProvider<T>An in-memory data provider for listing components that display hierarchical data. Uses an instance of
TreeDataas its source of data.Since:
1.2
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Constructor and Description TreeDataProvider(TreeData<T> treeData)Constructs a new TreeDataProvider.
-
Method Summary
All Methods Modifier and Type Method and Description Stream<T>fetchChildren(HierarchicalQuery<T,SerializablePredicate<T>> query)Fetches data from this HierarchicalDataProvider using given
query.intgetChildCount(HierarchicalQuery<T,SerializablePredicate<T>> query)Get the number of immediate child data items for the parent item returned by a given query.
SerializablePredicate<T>getFilter()Gets the current filter of this data provider.
SerializableComparator<T>getSortComparator()Gets the current sort comparator of this data provider.
TreeData<T>getTreeData()Return the underlying hierarchical data of this provider.
booleanhasChildren(T item)Check whether a given item has any children associated with it.
voidsetFilter(SerializablePredicate<T> filter)Sets a filter to be applied to all queries.
voidsetSortComparator(SerializableComparator<T> comparator)Sets the comparator to use as the default sorting for this data provider.
-
Methods inherited from class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider
withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
Methods inherited from class com.vaadin.flow.data.provider.AbstractDataProvider
addDataProviderListener, addListener, fireEvent, refreshAll, refreshItem, refreshItem
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.data.provider.InMemoryDataProvider
addFilter, addFilter, addFilterByValue, addSortComparator, addSortOrder, clearFilters, filteringBy, filteringBy, filteringByEquals, filteringByPrefix, filteringByPrefix, filteringBySubstring, filteringBySubstring, isInMemory, setFilter, setFilterByValue, setSortOrder
-
Methods inherited from interface com.vaadin.flow.data.provider.DataProvider
addDataProviderListener, fetch, fromCallbacks, fromFilteringCallbacks, fromStream, getId, ofCollection, ofItems, refreshAll, refreshItem, refreshItem, size, withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
fetch, size
-
-
-
-
Method Detail
-
getTreeData
public TreeData<T> getTreeData()Return the underlying hierarchical data of this provider.
Returns:
the underlying data of this provider
-
hasChildren
public boolean hasChildren(T item)Description copied from interface:
HierarchicalDataProviderCheck whether a given item has any children associated with it.
Specified by:
hasChildrenin interfaceHierarchicalDataProvider<T,SerializablePredicate<T>>Parameters:
item- the item to check for childrenReturns:
whether the given item has children
-
getChildCount
public int getChildCount(HierarchicalQuery<T,SerializablePredicate<T>> query)Description copied from interface:
HierarchicalDataProviderGet the number of immediate child data items for the parent item returned by a given query.
Specified by:
getChildCountin interfaceHierarchicalDataProvider<T,SerializablePredicate<T>>Parameters:
query- given query to request the count forReturns:
the count of child data items for the data item
HierarchicalQuery.getParent()
-
fetchChildren
public Stream<T> fetchChildren(HierarchicalQuery<T,SerializablePredicate<T>> query)Description copied from interface:
HierarchicalDataProviderFetches data from this HierarchicalDataProvider using given
query. Only the immediate children ofHierarchicalQuery.getParent()will be returned.Specified by:
fetchChildrenin interfaceHierarchicalDataProvider<T,SerializablePredicate<T>>Parameters:
query- given query to request data withReturns:
a stream of data objects resulting from the query
-
getFilter
public SerializablePredicate<T> getFilter()Description copied from interface:
InMemoryDataProviderGets the current filter of this data provider.
Specified by:
getFilterin interfaceInMemoryDataProvider<T>Returns:
the filter of this data provider
-
setFilter
public void setFilter(SerializablePredicate<T> filter)Description copied from interface:
InMemoryDataProviderSets a filter to be applied to all queries. The filter replaces any filter that has been set or added previously.
Specified by:
setFilterin interfaceConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>Specified by:
setFilterin interfaceInMemoryDataProvider<T>Parameters:
filter- the filter to set, ornullto remove any set filtersSee Also:
InMemoryDataProvider.setFilter(ValueProvider, SerializablePredicate),InMemoryDataProvider.setFilterByValue(ValueProvider, Object),InMemoryDataProvider.addFilter(SerializablePredicate)
-
getSortComparator
public SerializableComparator<T> getSortComparator()Description copied from interface:
InMemoryDataProviderGets the current sort comparator of this data provider.
Specified by:
getSortComparatorin interfaceInMemoryDataProvider<T>Returns:
the sort comparator of this data provider
-
setSortComparator
public void setSortComparator(SerializableComparator<T> comparator)Description copied from interface:
InMemoryDataProviderSets the comparator to use as the default sorting for this data provider. This overrides the sorting set by any other method that manipulates the default sorting of this data provider.
The default sorting is used if the query defines no sorting. The default sorting is also used to determine the ordering of items that are considered equal by the sorting defined in the query.
Specified by:
setSortComparatorin interfaceInMemoryDataProvider<T>Parameters:
comparator- a comparator to use, ornullto clear any previously set sort orderSee Also:
InMemoryDataProvider.setSortOrder(ValueProvider, SortDirection),InMemoryDataProvider.addSortComparator(SerializableComparator)
-
-