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 AbstractBackEndHierarchicalDataProvider<T,F>
- java.lang.Object
-
- com.vaadin.flow.data.provider.AbstractDataProvider<T,F>
-
- com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider<T,F>
-
- com.vaadin.flow.data.provider.hierarchy.AbstractBackEndHierarchicalDataProvider<T,F>
-
Type Parameters:
T- data typeF- filter typeAll Implemented Interfaces:
BackEndDataProvider<T,F>,DataProvider<T,F>,BackEndHierarchicalDataProvider<T,F>,HierarchicalDataProvider<T,F>,Serializablepublic abstract class AbstractBackEndHierarchicalDataProvider<T,F> extends AbstractHierarchicalDataProvider<T,F> implements BackEndHierarchicalDataProvider<T,F>Abstract base class for implementing
BackEndHierarchicalDataProviders.Since:
1.2
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Constructor Description AbstractBackEndHierarchicalDataProvider()
-
Method Summary
All Methods Modifier and Type Method Description Stream<T>fetchChildren(HierarchicalQuery<T,F> query)Fetches data from this HierarchicalDataProvider using given
query.protected abstract Stream<T>fetchChildrenFromBackEnd(HierarchicalQuery<T,F> query)Fetches data from the back end using the given query.
booleanisInMemory()Gets whether the DataProvider content all available in memory or does it use some external backend.
voidsetSortOrders(List<QuerySortOrder> sortOrders)Sets a list of sort orders 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.BackEndDataProvider
setSortOrder, setSortOrders
-
Methods inherited from interface com.vaadin.flow.data.provider.DataProvider
addDataProviderListener, getId, refreshAll, refreshItem, refreshItem
-
Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider
fetch, getChildCount, hasChildren, size, withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
-
-
-
Method Detail
-
fetchChildren
public Stream<T> fetchChildren(HierarchicalQuery<T,F> 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,F>Parameters:
query- given query to request data withReturns:
a stream of data objects resulting from the query
-
isInMemory
public boolean isInMemory()Description copied from interface:
DataProviderGets whether the DataProvider content all available in memory or does it use some external backend.
Specified by:
isInMemoryin interfaceBackEndDataProvider<T,F>Specified by:
isInMemoryin interfaceDataProvider<T,F>Returns:
trueif all data is in memory;falseif not
-
setSortOrders
public void setSortOrders(List<QuerySortOrder> sortOrders)Description copied from interface:
BackEndDataProviderSets a list of sort orders 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:
setSortOrdersin interfaceBackEndDataProvider<T,F>Parameters:
sortOrders- a list of sort orders to set, notnullSee Also:
-
fetchChildrenFromBackEnd
protected abstract Stream<T> fetchChildrenFromBackEnd(HierarchicalQuery<T,F> query)Fetches data from the back end using the given query.
Parameters:
query- the query that defines sorting, filtering, paging and the parent item to fetch children fromReturns:
a stream of items matching the query
See Also:
-
-