Package com.storedobject.ui

Class ObjectListProvider<T extends StoredObject>

java.lang.Object

com.vaadin.flow.data.provider.AbstractDataProvider<T,com.vaadin.flow.function.SerializablePredicate<T>>

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

com.storedobject.ui.AbstractListProvider<T>

com.storedobject.ui.ObjectListProvider<T>

All Implemented Interfaces:

ResourceOwner, FilterMethods<T>, ObjectLoader<T>, ObjectLoader<T>, ViewFilterSupport<T>, com.vaadin.flow.data.provider.ConfigurableFilterDataProvider<T,com.vaadin.flow.function.SerializablePredicate<T>,com.vaadin.flow.function.SerializablePredicate<T>>, com.vaadin.flow.data.provider.DataProvider<T,com.vaadin.flow.function.SerializablePredicate<T>>, com.vaadin.flow.data.provider.InMemoryDataProvider<T>, Serializable, AutoCloseable

Direct Known Subclasses:

EditableObjectListProvider, ReferenceLinkListProvider

public class ObjectListProvider<T extends StoredObject>
extends AbstractListProvider<T>
implements ObjectLoader<T>, AutoCloseable, ResourceOwner

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	ObjectListProvider.LoadCallBack

Constructor Summary

Constructors

Constructor	Description
ObjectListProvider(ObjectList<T> cache)
ObjectListProvider(Class<T> objectClass, DataList<T> data)

Method Summary

Modifier and Type	Method	Description
void	applyFilterPredicate()	This method is called whenever a filter predicate is changed.
void	clear()	Clear - remove all entries.
final void	close()
boolean	contains(T item)
T	get(int index)
int	getCacheLevel()
ObjectList<T>	getData()
String	getEffectiveCondition(String condition)	Get the "effective" filter condition that must be applied for loading.
ObjectLoadFilter<T>	getFixedFilter()
Id	getId(T item)
ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
int	getObjectCount()
AutoCloseable	getResource()	Get the "resource" owned by this "resource owner".
int	indexOf(T object)
void	load(int linkType, StoredObject master, String condition, String orderBy, boolean any)	Load the links of the given "master" instance.
void	load(ObjectIterator<T> objects)	Load the given instances.
void	load(String condition, String orderBy, boolean any)	Load the instances.
void	reload()	Reload all entries.
void	setLoadFilter(Predicate<T> loadFilter)	Set the load filter.
Stream<T>	streamAll()
Stream<T>	streamFiltered()

Methods inherited from class com.storedobject.ui.AbstractListProvider

addDataLoadedListener, fetch, filterView, getDataProvider, getItems, getObjectClass, getViewFilter, refreshAll, setFilter, setSortComparator, size

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

getFilter, getSortComparator

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

addDataProviderListener, addListener, fireEvent, 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.DataProvider

addDataProviderListener, refreshItem, refreshItem, withConfigurableFilter, withConfigurableFilter, withConvertedFilter

Methods inherited from interface com.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface com.vaadin.flow.data.provider.InMemoryDataProvider

addFilter, addFilter, addFilterByValue, addSortComparator, addSortOrder, clearFilters, filteringBy, filteringBy, filteringByEquals, filteringByPrefix, filteringByPrefix, filteringBySubstring, filteringBySubstring, isInMemory, setFilter, setFilterByValue, setSortOrder

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, getAllowAny, getLinkType, getMaster, getObjectClass, getOrderBy, isAllowAny, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, clear, getDelegatedLoader, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, size

Methods inherited from interface com.storedobject.ui.util.ViewFilterSupport

configure, configure, configure, configureMatch

Constructor Details

ObjectListProvider

public ObjectListProvider(Class<T> objectClass,
 DataList<T> data)

ObjectListProvider

public ObjectListProvider(ObjectList<T> cache)

Method Details

getFixedFilter

public ObjectLoadFilter<T> getFixedFilter()

Specified by:

getFixedFilter in interface ObjectLoader<T extends StoredObject>

getData

public ObjectList<T> getData()

Overrides:

getData in class AbstractListProvider<T extends StoredObject>

getId

public Id getId(T item)

Specified by:

getId in interface com.vaadin.flow.data.provider.DataProvider<T extends StoredObject,com.vaadin.flow.function.SerializablePredicate<T extends StoredObject>>

contains

public boolean contains(T item)

getEffectiveCondition

public String getEffectiveCondition(String condition)

Description copied from interface: FilterMethods

Get the "effective" filter condition that must be applied for loading. The result from FilterMethods.getFilterCondition() will be passed as a parameter to this method to get a modified "condition" if required.

Specified by:

getEffectiveCondition in interface FilterMethods<T extends StoredObject>

Specified by:

getEffectiveCondition in interface ObjectLoader<T extends StoredObject>

Parameters:

condition - Condition obtained from FilterMethods.getFilterCondition().

Returns:

Modified condition or the same if no modification required.

load

public void load(String condition,
 String orderBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the instances. Current "load filter" if set will be applied. If "master" is already set, "links" of the "master" will be loaded.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

condition - Filtering condition to be applied.

orderBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(int linkType,
 StoredObject master,
 String condition,
 String orderBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the links of the given "master" instance. Current "load filter" if set will be applied.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

orderBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(ObjectIterator<T> objects)

Description copied from interface: ObjectLoader

Load the given instances. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

objects - Objects to be loaded.

reload

public void reload()

Description copied from interface: ObjectLoader

Reload all entries.

Specified by:

reload in interface ObjectLoader<T extends StoredObject>

applyFilterPredicate

public void applyFilterPredicate()

Description copied from interface: FilterMethods

This method is called whenever a filter predicate is changed. Methods with default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Note: This method is used to show the filtered result of the existing entries

Specified by:

applyFilterPredicate in interface FilterMethods<T extends StoredObject>

Specified by:

applyFilterPredicate in interface ObjectLoader<T extends StoredObject>

getObjectCount

public int getObjectCount()

Specified by:

getObjectCount in interface ObjectLoader<T extends StoredObject>

Overrides:

getObjectCount in class AbstractListProvider<T extends StoredObject>

get

public T get(int index)

Specified by:

get in interface ObjectLoader<T extends StoredObject>

Overrides:

get in class AbstractListProvider<T extends StoredObject>

indexOf

public int indexOf(T object)

Specified by:

indexOf in interface ObjectLoader<T extends StoredObject>

Overrides:

indexOf in class AbstractListProvider<T extends StoredObject>

streamAll

public Stream<T> streamAll()

Specified by:

streamAll in interface ObjectLoader<T extends StoredObject>

Overrides:

streamAll in class AbstractListProvider<T extends StoredObject>

streamFiltered

public Stream<T> streamFiltered()

Specified by:

streamFiltered in interface ObjectLoader<T extends StoredObject>

Overrides:

streamFiltered in class AbstractListProvider<T extends StoredObject>

getCacheLevel

public int getCacheLevel()

Specified by:

getCacheLevel in interface ObjectLoader<T extends StoredObject>

clear

public void clear()

Description copied from interface: ObjectLoader

Clear - remove all entries.

Specified by:

clear in interface ObjectLoader<T extends StoredObject>

Overrides:

clear in class AbstractListProvider<T extends StoredObject>

close

public final void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractListProvider<T extends StoredObject>

getResource

public AutoCloseable getResource()

Description copied from interface: ResourceOwner

Get the "resource" owned by this "resource owner".

Specified by:

getResource in interface ResourceOwner

Returns:

The "resource" owned by this "resource owner".

getLoadFilter

@Nonnull
public ObjectLoadFilter<T> getLoadFilter()

Description copied from interface: FilterMethods

Get the load filter.

Specified by:

getLoadFilter in interface FilterMethods<T extends StoredObject>

Specified by:

getLoadFilter in interface ObjectLoader<T extends StoredObject>

Returns:

Current load filter.

setLoadFilter

public void setLoadFilter(Predicate<T> loadFilter)

Description copied from interface: FilterMethods

Set the load filter. This will be applied whenever loading takes place.

Specified by:

setLoadFilter in interface FilterMethods<T extends StoredObject>

Parameters:

loadFilter - Load filter to be applied while loading.