com.vaadin.data.provider.
Interface BackEndDataProvider<T,F>
-
Type Parameters:
T
- data provider data typeF
- data provider filter typeAll Superinterfaces:
DataProvider<T,F>
,Serializable
All Known Subinterfaces:
All Known Implementing Classes:
AbstractBackEndDataProvider
,AbstractBackEndHierarchicalDataProvider
,CallbackDataProvider
public interface BackEndDataProvider<T,F> extends DataProvider<T,F>
A data provider that lazy loads items from a back end.
Since:
8.0
-
-
Method Summary
All Methods Modifier and Type Method Description default boolean
isInMemory()
Gets whether the DataProvider content all available in memory or does it use some external backend.
default void
setSortOrder(QuerySortOrder sortOrder)
Sets a single sort order to use as the default sorting for this data provider.
default void
setSortOrders(QuerySortOrderBuilder builder)
Sets the sort order to use, given a
QuerySortOrderBuilder
.void
setSortOrders(List<QuerySortOrder> sortOrders)
Sets a list of sort orders to use as the default sorting for this data provider.
-
Methods inherited from interface com.vaadin.data.provider.DataProvider
addDataProviderListener, fetch, getId, refreshAll, refreshItem, size, withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
-
-
-
Method Detail
-
setSortOrders
void setSortOrders(List<QuerySortOrder> sortOrders)
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.
Parameters:
sortOrders
- a list of sort orders to set, notnull
See Also:
-
setSortOrders
default void setSortOrders(QuerySortOrderBuilder builder)
Sets the sort order to use, given a
QuerySortOrderBuilder
. Shorthand forsetSortOrders(builder.build())
.Parameters:
builder
- the sort builder to retrieve the sort order fromThrows:
NullPointerException
- if builder is nullSee Also:
-
setSortOrder
default void setSortOrder(QuerySortOrder sortOrder)
Sets a single sort order 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.
Parameters:
sortOrder
- a sort order to set, ornull
to clear any previously set sort ordersSee Also:
-
isInMemory
default boolean isInMemory()
Description copied from interface:
DataProvider
Gets whether the DataProvider content all available in memory or does it use some external backend.
Specified by:
isInMemory
in interfaceDataProvider<T,F>
Returns:
true
if all data is in memory;false
if not
-
-