Package com.vaadin.flow.data.provider

Class AbstractListDataView<T>

java.lang.Object

com.vaadin.flow.data.provider.AbstractDataView<T>

com.vaadin.flow.data.provider.AbstractListDataView<T>

Type Parameters:

T - data type

All Implemented Interfaces:

DataView<T>, ListDataView<T,AbstractListDataView<T>>, Serializable

Direct Known Subclasses:

CheckboxGroupListDataView, ComboBoxListDataView, GridListDataView, ListBoxListDataView, RadioButtonGroupListDataView, SelectListDataView

public abstract class AbstractListDataView<T>
extends AbstractDataView<T>
implements ListDataView<T,AbstractListDataView<T>>

Abstract list data view implementation which provides common methods for fetching, filtering and sorting in-memory data to all ListDataView subclasses.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.vaadin.flow.data.provider.AbstractDataView

component, dataProviderSupplier, NULL_IDENTIFIER_ERROR_MESSAGE, NULL_ITEM_ERROR_MESSAGE

Constructor Summary

Constructors

Constructor	Description
AbstractListDataView(SerializableSupplier<? extends DataProvider<T,?>> dataProviderSupplier, Component component, SerializableBiConsumer<SerializablePredicate<T>,SerializableComparator<T>> filterOrSortingChangedCallback)	Creates a new instance of AbstractListDataView subclass and verifies the passed data provider is compatible with this data view implementation.

Method Summary

Modifier and Type	Method	Description
AbstractListDataView<T>	addFilter(SerializablePredicate<T> filter)	Adds a filter to be applied to all queries.
AbstractListDataView<T>	addItem(T item)	Adds an item to the data list if it is not already present.
AbstractListDataView<T>	addItemAfter(T item, T after)	Adds an item after the given target item.
AbstractListDataView<T>	addItemBefore(T item, T before)	Adds an item before the given target item.
AbstractListDataView<T>	addItems(Collection<T> items)	Adds multiple items to the data list.
AbstractListDataView<T>	addItemsAfter(Collection<T> items, T after)	Adds multiple items after the given target item.
AbstractListDataView<T>	addItemsBefore(Collection<T> items, T before)	Adds multiple items before the given target item.
AbstractListDataView<T>	addSortComparator(SerializableComparator<T> sortComparator)	Adds a comparator to the data default sorting.
<V1 extends Comparable<? super V1>> AbstractListDataView<T>	addSortOrder(ValueProvider<T,V1> valueProvider, SortDirection sortDirection)	Adds a property and direction to the default sorting.
boolean	contains(T item)	Check if item is present in the currently filtered data set.
protected ListDataProvider<T>	getDataProvider()
T	getItem(int index)	Gets the item at the given index from the data available to the component.
int	getItemCount()	Get the full item count with filters if any set.
Stream<T>	getItems()	Get the full data available to the component.
Optional<T>	getNextItem(T item)	Gets the item after given item from the filtered and sorted data.
Optional<T>	getPreviousItem(T item)	Gets the item before given item from the filtered and sorted data.
protected Class<?>	getSupportedDataProviderType()	Returns supported DataProvider type for this DataView.
AbstractListDataView<T>	removeFilters()	Removes all in-memory filters set or added.
AbstractListDataView<T>	removeItem(T item)	Remove an item from the data list.
AbstractListDataView<T>	removeItems(Collection<T> items)	Remove multiple items from the data list.
AbstractListDataView<T>	removeSorting()	Removes any default sorting that has been set or added previously.
AbstractListDataView<T>	setFilter(SerializablePredicate<T> filter)	Sets a filter to be applied to the data.
AbstractListDataView<T>	setItems(Collection<T> items)	Remove all the items in the list and adds given items to the data list.
AbstractListDataView<T>	setSortComparator(SerializableComparator<T> sortComparator)	Sets the comparator to use as the default sorting.
<V1 extends Comparable<? super V1>> AbstractListDataView<T>	setSortOrder(ValueProvider<T,V1> valueProvider, SortDirection sortDirection)	Sets the property and direction to use as the default sorting.
protected void	validateItemIndex(int itemIndex)	Validate that index is inside bounds of the data available.

Methods inherited from class com.vaadin.flow.data.provider.AbstractDataView

addIdentifierProviderChangeListener, addItemCountChangeListener, equals, getIdentifierProvider, getItemIndex, getItemIndex, refreshAll, refreshItem, setIdentifierProvider, verifyDataProviderType, verifyDataProviderType

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.DataView

addItemCountChangeListener, getItemIndex, refreshAll, refreshItem, setIdentifierProvider

Constructor Details

AbstractListDataView

public AbstractListDataView(SerializableSupplier<? extends DataProvider<T,?>> dataProviderSupplier,
 Component component,
 SerializableBiConsumer<SerializablePredicate<T>,SerializableComparator<T>> filterOrSortingChangedCallback)

Creates a new instance of AbstractListDataView subclass and verifies the passed data provider is compatible with this data view implementation.

Parameters:

dataProviderSupplier - supplier from which the DataProvider can be gotten

component - the component that the dataView is bound to

filterOrSortingChangedCallback - callback, which is being invoked when the component filtering or sorting changes, not null

Method Details

getItemCount

public int getItemCount()

Description copied from interface: ListDataView

Get the full item count with filters if any set. As the item count might change at any point, it is recommended to add a listener with the DataView.addItemCountChangeListener(ComponentEventListener) method instead to get notified when the item count has changed.

Specified by:

getItemCount in interface ListDataView<T,AbstractListDataView<T>>

Returns:

filtered item count

See Also:

• DataView.addItemCountChangeListener(ComponentEventListener)

getItem

public T getItem(int index)

Description copied from interface: DataView

Gets the item at the given index from the data available to the component. Data is filtered and sorted the same way as in the component.

Specified by:

getItem in interface DataView<T>

Parameters:

index - item index number

Returns:

item on index

getItems

public Stream<T> getItems()

Description copied from interface: DataView

Get the full data available to the component. Data is filtered and sorted the same way as in the component.

Consumers of the returned stream are responsible for closing it when all the stream operations are done to ensure that any resources feeding the stream are properly released. Failure to close the stream might lead to resource leaks.

It is strongly recommended to use a try-with-resources block to automatically close the stream after its terminal operation has been executed. Below is an example of how to properly use and close the stream:

 try (Stream<T> stream = dataView.getItems()) {
     stream.forEach(System.out::println); // Example terminal operation
 }
 

Specified by:

getItems in interface DataView<T>

Overrides:

getItems in class AbstractDataView<T>

Returns:

filtered and sorted data set

getNextItem

public Optional<T> getNextItem(T item)

Description copied from interface: ListDataView

Gets the item after given item from the filtered and sorted data.

Note! Item might be present in the data set, but be filtered out or be the last item so that the next item won't be available.

Specified by:

getNextItem in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to get next for

Returns:

next item if available, else empty optional if item doesn't exist or not in current filtered items

See Also:

• ListDataView.getPreviousItem(Object)

getPreviousItem

public Optional<T> getPreviousItem(T item)

Description copied from interface: ListDataView

Gets the item before given item from the filtered and sorted data.

Note! Item might be present in the data set, but be filtered out or be the first item so that the previous item won't be available.

Specified by:

getPreviousItem in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to get previous for

Returns:

previous item if available, else empty optional if item doesn't exist or not in current filtered items

See Also:

• ListDataView.getNextItem(Object)

addFilter

public AbstractListDataView<T> addFilter(SerializablePredicate<T> filter)

Description copied from interface: ListDataView

Adds a filter to be applied to all queries. The filter will be used in addition to any filter that has been set or added previously.

This filter is bound to the component. Thus, any other component using the same DataProvider object would not be affected by setting a filter through data view of another component. A filter set by this method won't be retained when a new DataProvider is set to the component.

Refreshes all items of the component after adding the filter, i.e. runs DataView.refreshAll().

Specified by:

addFilter in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

filter - the filter to add, not null

Returns:

ListDataView instance

See Also:

• ListDataView.setFilter(SerializablePredicate)
• ListDataView.removeFilters()

removeFilters

public AbstractListDataView<T> removeFilters()

Description copied from interface: ListDataView

Removes all in-memory filters set or added.

Refreshes all items of the component after removing the filter, i.e. runs DataView.refreshAll().

Specified by:

removeFilters in interface ListDataView<T,AbstractListDataView<T>>

Returns:

ListDataView instance

See Also:

• ListDataView.addFilter(SerializablePredicate)
• ListDataView.setFilter(SerializablePredicate)

setFilter

public AbstractListDataView<T> setFilter(SerializablePredicate<T> filter)

Description copied from interface: ListDataView

Sets a filter to be applied to the data. The filter replaces any filter that has been set or added previously. null will clear all filters.

This filter is bound to the component. Thus, any other component using the same DataProvider object would not be affected by setting a filter through data view of another component. A filter set by this method won't be retained when a new DataProvider is set to the component.

Refreshes all items of the component after setting the filter, i.e. runs DataView.refreshAll().

Specified by:

setFilter in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

filter - filter to be set, or null to clear any previously set filters

Returns:

ListDataView instance

See Also:

• ListDataView.addFilter(SerializablePredicate)
• ListDataView.removeFilters()

setSortComparator

public AbstractListDataView<T> setSortComparator(SerializableComparator<T> sortComparator)

Description copied from interface: ListDataView

Sets the comparator to use as the default sorting. This overrides the sorting set by any other method that manipulates the default sorting.

This comparator is bound to the component. Thus, any other component using the same DataProvider object would not be affected by setting a sort comparator through data view of another component. A sorting set by this method won't be retained when a new DataProvider is set to the component.

Refreshes all items of the component after setting the sorting, i.e. runs DataView.refreshAll().

Specified by:

setSortComparator in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

sortComparator - a comparator to use, or null to clear any previously set sort order

Returns:

ListDataView instance

See Also:

• ListDataView.addSortComparator(SerializableComparator)

addSortComparator

public AbstractListDataView<T> addSortComparator(SerializableComparator<T> sortComparator)

Description copied from interface: ListDataView

Adds a comparator to the data default sorting. If no default sorting has been defined, then the provided comparator will be used as the default sorting. If a default sorting has been defined, then the provided comparator will be used to determine the ordering of items that are considered equal by the previously defined default sorting.

This comparator is bound to the component. Thus, any other component using the same DataProvider object would not be affected by setting a sort comparator through data view of another component. A sorting set by this method won't be retained when a new DataProvider is set to the component.

Refreshes all items of the component after adding the sorting, i.e. runs DataView.refreshAll().

Specified by:

addSortComparator in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

sortComparator - a comparator to add, not null

Returns:

ListDataView instance

See Also:

• ListDataView.setSortComparator(SerializableComparator)

removeSorting

public AbstractListDataView<T> removeSorting()

Description copied from interface: ListDataView

Removes any default sorting that has been set or added previously.

Any other component using the same DataProvider object would not be affected by removing default sorting through data view of another component.

Refreshes all items of the component after removing the sorting, i.e. runs DataView.refreshAll().

Specified by:

removeSorting in interface ListDataView<T,AbstractListDataView<T>>

Returns:

ListDataView instance

See Also:

• ListDataView.setSortComparator(SerializableComparator)
• ListDataView.addSortComparator(SerializableComparator)

setSortOrder

public <V1 extends Comparable<? super V1>>
AbstractListDataView<T> setSortOrder(ValueProvider<T,V1> valueProvider,
 SortDirection sortDirection)

Description copied from interface: ListDataView

Sets the property and direction to use as the default sorting. This overrides the sorting set by any other method that manipulates the default sorting of this DataProvider.

This sort order is bound to the component. Thus, any other component using the same DataProvider object would not be affected by setting a sort order through data view of another component. A sort order set by this method won't be retained when a new DataProvider is set to the component.

Refreshes all items of the component after setting the sorting, i.e. runs DataView.refreshAll().

Specified by:

setSortOrder in interface ListDataView<T,AbstractListDataView<T>>

Type Parameters:

V1 - the provided value type

Parameters:

valueProvider - the value provider that defines the property do sort by, not null

sortDirection - the sort direction to use, not null

Returns:

ListDataView instance

See Also:

• ListDataView.addSortOrder(ValueProvider, SortDirection)

addSortOrder

public <V1 extends Comparable<? super V1>>
AbstractListDataView<T> addSortOrder(ValueProvider<T,V1> valueProvider,
 SortDirection sortDirection)

Description copied from interface: ListDataView

Adds a property and direction to the default sorting. If no default sorting has been defined, then the provided sort order will be used as the default sorting. If a default sorting has been defined, then the provided sort order will be used to determine the ordering of items that are considered equal by the previously defined default sorting.

This sort order is bound to the component. Thus, any other component using the same DataProvider object would not be affected by setting a sort sort through data view of another component. A sorting set by this method won't be retained when a new DataProvider is set to the component.

Refreshes all items of the component after adding the sorting, i.e. runs DataView.refreshAll().

Specified by:

addSortOrder in interface ListDataView<T,AbstractListDataView<T>>

Type Parameters:

V1 - the provided value type

Parameters:

valueProvider - the value provider that defines the property do sort by, not null

sortDirection - the sort direction to use, not null

Returns:

ListDataView instance

See Also:

• ListDataView.setSortOrder(ValueProvider, SortDirection)

contains

public boolean contains(T item)

Description copied from interface: ListDataView

Check if item is present in the currently filtered data set.

By default, equals method implementation of the item is used for identity check. If a custom data provider is used, then the DataProvider.getId(Object) method is used instead. Item's custom identity can be set up with a DataView.setIdentifierProvider(IdentifierProvider).

Specified by:

contains in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to search for

Returns:

true if item is found in filtered data set

See Also:

• DataView.setIdentifierProvider(IdentifierProvider)

getSupportedDataProviderType

protected Class<?> getSupportedDataProviderType()

Description copied from class: AbstractDataView

Returns supported DataProvider type for this DataView.

Specified by:

getSupportedDataProviderType in class AbstractDataView<T>

Returns:

supported data provider type

getDataProvider

protected ListDataProvider<T> getDataProvider()

addItem

public AbstractListDataView<T> addItem(T item)

Description copied from interface: ListDataView

Adds an item to the data list if it is not already present.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

Refreshes all items of the component after adding the item, i.e. runs DataView.refreshAll().

Specified by:

addItem in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to add

Returns:

this ListDataView instance

See Also:

• ListDataView.addItemBefore(Object, Object)
• ListDataView.addItemAfter(Object, Object)
• ListDataView.removeItem(Object)

addItems

public AbstractListDataView<T> addItems(Collection<T> items)

Description copied from interface: ListDataView

Adds multiple items to the data list.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

Any items that already present in the data provider are moved to the end.

Refreshes all items of the component after adding the items, i.e. runs DataView.refreshAll().

Specified by:

addItems in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

items - collection of item to add

Returns:

this ListDataView instance

See Also:

• ListDataView.removeItems(Collection)
• ListDataView.addItemsBefore(Collection, Object)
• ListDataView.addItemsAfter(Collection, Object)

addItemAfter

public AbstractListDataView<T> addItemAfter(T item,
 T after)

Description copied from interface: ListDataView

Adds an item after the given target item.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

If the item is already present in the data provider, then it is moved.

Refreshes all items of the component after adding the item, i.e. runs DataView.refreshAll().

Note! Item is added to the unfiltered and unsorted List.

Specified by:

addItemAfter in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to add

after - item after which to add the item at

Returns:

this ListDataView instance

See Also:

• ListDataView.addItem(Object)
• ListDataView.addItemBefore(Object, Object)

addItemBefore

public AbstractListDataView<T> addItemBefore(T item,
 T before)

Description copied from interface: ListDataView

Adds an item before the given target item.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

If the item is already present in the data provider, then it is moved.

Refreshes all items of the component after adding the item, i.e. runs DataView.refreshAll().

Note! Item is added to the unfiltered and unsorted List.

Specified by:

addItemBefore in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to add

before - item before which to add the item at

Returns:

this ListDataView instance

See Also:

• ListDataView.addItem(Object)
• ListDataView.addItemAfter(Object, Object)

addItemsAfter

public AbstractListDataView<T> addItemsAfter(Collection<T> items,
 T after)

Description copied from interface: ListDataView

Adds multiple items after the given target item. The full collection is added in order after the target.

The backing List must be mutable to use this method. Immutable data structure will throw an exception. Any items that already present in the data provider are moved.

Refreshes all items of the component after adding the item, i.e. runs DataView.refreshAll().

Note! Item is added to the unfiltered and unsorted List.

Specified by:

addItemsAfter in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

items - collection of items to add

after - item after which to add the item at

Returns:

this ListDataView instance

See Also:

• ListDataView.addItems(Collection)
• ListDataView.addItemsBefore(Collection, Object)

addItemsBefore

public AbstractListDataView<T> addItemsBefore(Collection<T> items,
 T before)

Description copied from interface: ListDataView

Adds multiple items before the given target item. The full collection is added in order before the target.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

Any items that already present in the data provider are moved.

Refreshes all items of the component after adding the item, i.e. runs DataView.refreshAll().

Note! Item is added to the unfiltered and unsorted List.

Specified by:

addItemsBefore in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

items - collection of items to add

before - item before which to add the item at

Returns:

this ListDataView instance

See Also:

• ListDataView.addItems(Collection)
• ListDataView.addItemsAfter(Collection, Object)

removeItem

public AbstractListDataView<T> removeItem(T item)

Description copied from interface: ListDataView

Remove an item from the data list.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

Refreshes all items of the component after removing the item, i.e. runs DataView.refreshAll().

Specified by:

removeItem in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

item - item to remove

Returns:

this ListDataView instance

See Also:

• ListDataView.addItem(Object)
• ListDataView.removeItems(Collection)

removeItems

public AbstractListDataView<T> removeItems(Collection<T> items)

Description copied from interface: ListDataView

Remove multiple items from the data list.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

Specified by:

removeItems in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

items - collection of items to remove

Returns:

this ListDataView instance

See Also:

• ListDataView.removeItem(Object)
• ListDataView.removeItems(Collection)

setItems

public AbstractListDataView<T> setItems(Collection<T> items)

Description copied from interface: ListDataView

Remove all the items in the list and adds given items to the data list.

The backing List must be mutable to use this method. Immutable data structure will throw an exception.

Refreshes all items of the component after adding the items, i.e. runs DataView.refreshAll().

Specified by:

setItems in interface ListDataView<T,AbstractListDataView<T>>

Parameters:

items - collection of items to set

Returns:

this ListDataView instance

See Also:

• ListDataView.addItems(Collection)
• ListDataView.addItemsBefore(Collection, Object)
• ListDataView.addItemsAfter(Collection, Object)

validateItemIndex

protected void validateItemIndex(int itemIndex)

Validate that index is inside bounds of the data available.

Parameters:

itemIndex - item index to validate