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.data.provider.
Class ListDataProvider<T>
- java.lang.Object
-
- com.vaadin.data.provider.AbstractDataProvider<T,SerializablePredicate<T>>
-
- com.vaadin.data.provider.ListDataProvider<T>
-
Type Parameters:
T- data typeAll Implemented Interfaces:
ConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>,DataProvider<T,SerializablePredicate<T>>,InMemoryDataProvider<T>,Serializablepublic class ListDataProvider<T> extends AbstractDataProvider<T,SerializablePredicate<T>> implements InMemoryDataProvider<T>DataProviderwrapper forCollections.Since:
8.0
See Also:
-
-
Constructor Summary
Constructors Constructor Description ListDataProvider(Collection<T> items)Constructs a new ListDataProvider.
-
Method Summary
All Methods Modifier and Type Method Description Stream<T>fetch(Query<T,SerializablePredicate<T>> query)Fetches data from this DataProvider using given
query.SerializablePredicate<T>getFilter()Gets the current filter of this data provider.
Collection<T>getItems()Returns the underlying data items.
SerializableComparator<T>getSortComparator()Gets the current sort comparator of this data provider.
voidsetFilter(SerializablePredicate<T> filter)Sets a filter to be applied to all queries.
voidsetSortComparator(SerializableComparator<T> comparator)Sets the comparator to use as the default sorting for this data provider.
intsize(Query<T,SerializablePredicate<T>> query)Gets the amount of data in this DataProvider.
-
Methods inherited from class com.vaadin.data.provider.AbstractDataProvider
addDataProviderListener, addListener, fireEvent, refreshAll, 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.data.provider.DataProvider
addDataProviderListener, getId, refreshAll, refreshItem, withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
Methods inherited from interface com.vaadin.data.provider.InMemoryDataProvider
addFilter, addFilter, addFilterByValue, addSortComparator, addSortOrder, clearFilters, filteringBy, filteringBy, filteringByEquals, filteringByPrefix, filteringByPrefix, filteringBySubstring, filteringBySubstring, isInMemory, setFilter, setFilterByValue, setSortOrder
-
-
-
-
Constructor Detail
-
ListDataProvider
public ListDataProvider(Collection<T> items)Constructs a new ListDataProvider.
No protective copy is made of the list, and changes in the provided backing Collection will be visible via this data provider. The caller should copy the list if necessary.
Parameters:
items- the initial data, not null
-
-
Method Detail
-
getItems
public Collection<T> getItems()Returns the underlying data items.
Returns:
the underlying data items
-
fetch
public Stream<T> fetch(Query<T,SerializablePredicate<T>> query)Description copied from interface:
DataProviderFetches data from this DataProvider using given
query.Depending on the use case this operation might open I/O channels.
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 an I/O stream might lead to resource leaks.
It is strongly recommended to use a try-with-resources block to automatically close an I/O stream after its terminal operation has been executed. Below is an example of how to properly use and close the stream:
NOTE: This mainly concerns data providers wheretry (Stream<T> stream = fetch(query)) { stream.forEach(System.out::println); // Example terminal operation }DataProvider.isInMemory()returnsfalse. While it is technically possible to configure or extend an in-memory data provider in a way that compromises the in-memory nature, doing so is conceptually frowned upon. In applications that choose to do so regardless, the use of this pattern is strongly recommended even ifDataProvider.isInMemory()returnstrue.The try-with-resources pattern is safe to use with this method even if you are unsure whether or not it returns an I/O stream, but it's unnecessary to apply the pattern to all stream handling everywhere. For most streams the only consumed resource is memory, and Java's built-in cleanup is sufficient to free it.
With large data sets where memory consumption might become a problem it is recommended to use lazy data providers instead of in-memory ones. See e.g.
DataProvider.fromCallbacks(FetchCallback, CountCallback)orBackEndDataProviderfor more info.Specified by:
fetchin interfaceDataProvider<T,SerializablePredicate<T>>Parameters:
query- given query to request dataReturns:
the result of the query request: a stream of data objects, not
null
-
size
public int size(Query<T,SerializablePredicate<T>> query)Description copied from interface:
DataProviderGets the amount of data in this DataProvider.
Specified by:
sizein interfaceDataProvider<T,SerializablePredicate<T>>Parameters:
query- query with sorting and filteringReturns:
the size of the data provider
-
getSortComparator
public SerializableComparator<T> getSortComparator()Description copied from interface:
InMemoryDataProviderGets the current sort comparator of this data provider.
Specified by:
getSortComparatorin interfaceInMemoryDataProvider<T>Returns:
the sort comparator of this data provider
-
setSortComparator
public void setSortComparator(SerializableComparator<T> comparator)Description copied from interface:
InMemoryDataProviderSets the comparator 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:
setSortComparatorin interfaceInMemoryDataProvider<T>Parameters:
comparator- a comparator to use, ornullto clear any previously set sort orderSee Also:
InMemoryDataProvider.setSortOrder(ValueProvider, SortDirection),InMemoryDataProvider.addSortComparator(SerializableComparator)
-
getFilter
public SerializablePredicate<T> getFilter()Description copied from interface:
InMemoryDataProviderGets the current filter of this data provider.
Specified by:
getFilterin interfaceInMemoryDataProvider<T>Returns:
the filter of this data provider
-
setFilter
public void setFilter(SerializablePredicate<T> filter)Description copied from interface:
InMemoryDataProviderSets a filter to be applied to all queries. The filter replaces any filter that has been set or added previously.
Specified by:
setFilterin interfaceConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>Specified by:
setFilterin interfaceInMemoryDataProvider<T>Parameters:
filter- the filter to set, ornullto remove any set filtersSee Also:
InMemoryDataProvider.setFilter(ValueProvider, SerializablePredicate),InMemoryDataProvider.setFilterByValue(ValueProvider, Object),InMemoryDataProvider.addFilter(SerializablePredicate)
-
-