Package com.vaadin.flow.data.provider
Class AbstractBackEndDataProvider<T,F>
java.lang.Object
com.vaadin.flow.data.provider.AbstractDataProvider<T,F>
com.vaadin.flow.data.provider.AbstractBackEndDataProvider<T,F>
- Type Parameters:
T
- data provider data typeF
- data provider filter type
- All Implemented Interfaces:
BackEndDataProvider<T,
,F> DataProvider<T,
,F> Serializable
- Direct Known Subclasses:
CallbackDataProvider
public abstract class AbstractBackEndDataProvider<T,F>
extends AbstractDataProvider<T,F>
implements BackEndDataProvider<T,F>
Abstract base class for implementing back end data providers.
- Since:
- 1.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionFetches data from this DataProvider using givenquery
.fetchFromBackEnd
(Query<T, F> query) Fetches data from the back end using the given query.void
setSortOrders
(List<QuerySortOrder> sortOrders) Sets a list of sort orders to use as the default sorting for this data provider.int
Gets the amount of data in this DataProvider.protected abstract int
sizeInBackEnd
(Query<T, F> query) Counts the number of items available in the back end.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
isInMemory, setSortOrder, setSortOrders
Methods inherited from interface com.vaadin.flow.data.provider.DataProvider
addDataProviderListener, getId, refreshAll, refreshItem, refreshItem, withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
Constructor Details
-
AbstractBackEndDataProvider
public AbstractBackEndDataProvider()
-
-
Method Details
-
fetch
Description copied from interface:DataProvider
Fetches data from this DataProvider using givenquery
.- Specified by:
fetch
in interfaceDataProvider<T,
F> - Parameters:
query
- given query to request data- Returns:
- the result of the query request: a stream of data objects, not
null
-
size
Description copied from interface:DataProvider
Gets the amount of data in this DataProvider.- Specified by:
size
in interfaceDataProvider<T,
F> - Parameters:
query
- query with sorting and filtering- Returns:
- the size of the data provider
-
fetchFromBackEnd
Fetches data from the back end using the given query.- Parameters:
query
- the query that defines sorting, filtering and paging for fetching the data- Returns:
- a stream of items matching the query
-
sizeInBackEnd
Counts the number of items available in the back end.- Parameters:
query
- the query that defines filtering to be used for counting the number of items- Returns:
- the number of available items
-
setSortOrders
Description copied from interface:BackEndDataProvider
Sets 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:
setSortOrders
in interfaceBackEndDataProvider<T,
F> - Parameters:
sortOrders
- a list of sort orders to set, notnull
- See Also:
-