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 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 type
F - data provider filter type
All Implemented Interfaces:
BackEndDataProvider<T,, DataProvider<T,, Serializable
Direct Known Subclasses:
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionFetches data from this DataProvider using given
query.fetchFromBackEnd(Query<T, F> query) Fetches data from the back end using the given query.
voidsetSortOrders(List<QuerySortOrder> sortOrders) Sets a list of sort orders to use as the default sorting for this data provider.
intGets the amount of data in this DataProvider.
protected abstract intsizeInBackEnd(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, refreshItemMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.data.provider.BackEndDataProvider
isInMemory, setSortOrder, setSortOrdersMethods 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:
DataProviderFetches data from this DataProvider using given
query.Specified by:
fetchin interfaceDataProvider<T,F> Parameters:
query- given query to request dataReturns:
the result of the query request: a stream of data objects, not
null -
size
Description copied from interface:
DataProviderGets the amount of data in this DataProvider.
Specified by:
sizein interfaceDataProvider<T,F> Parameters:
query- query with sorting and filteringReturns:
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 dataReturns:
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 itemsReturns:
the number of available items
-
setSortOrders
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:
-