Package com.storedobject.ui

Class ObjectForestProvider<T extends StoredObject>

java.lang.Object

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

com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

com.storedobject.ui.AbstractTreeProvider<Object,T>

com.storedobject.ui.ObjectForestProvider<T>

All Implemented Interfaces:

ResourceOwner, FilterMethods<T>, ObjectLoader<T>, ObjectChangedListener<T>, ObjectLoader<T>, ViewFilterSupport<T>, com.vaadin.flow.data.provider.DataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>, com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>, Serializable, AutoCloseable

public class ObjectForestProvider<T extends StoredObject>
extends AbstractTreeProvider<Object,T>
implements ObjectLoader<T>, ObjectChangedListener<T>, AutoCloseable, ResourceOwner, FilterMethods<T>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	ObjectForestProvider.LoadCallBack

Constructor Summary

Constructors

Constructor	Description
ObjectForestProvider(ObjectForest<T> forest)

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.
boolean	contains(T item)
void	deleted(T object)	Fired when an object is deleted.
Stream<Object>	fetchChildren(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<Object,com.vaadin.flow.function.SerializablePredicate<Object>> query)
T	get(int index)
int	getCacheLevel()
int	getChildCount(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<Object,com.vaadin.flow.function.SerializablePredicate<Object>> query)
Filtered<T>	getData()
String	getEffectiveCondition(String condition)	Get the "effective" filter condition that must be applied for loading.
ObjectLoadFilter<T>	getFixedFilter()
ObjectForest<T>	getForest()
Object	getId(Object item)
ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
AutoCloseable	getResource()	Get the "resource" owned by this "resource owner".
List<T>	getRoots()
boolean	hasChildren(Object parent)
int	indexOf(T object)
void	inserted(T object)	Fired when a new object is inserted.
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	refreshAll()
void	refreshItem(Object item)
void	refreshItem(Object item, boolean refreshChildren)
void	setLoadFilter(Predicate<T> loadFilter)	Set the load filter.
int	size()	Get the instances count.
Stream<T>	streamAll()
Stream<T>	streamFiltered()
void	updated(T object)	Fired when an object is updated.
void	visitChildren(Object parent, Consumer<Object> consumer, boolean includeGrandChildren)	Visit the children of the parent item.

Methods inherited from class com.storedobject.ui.AbstractTreeProvider

addDataLoadedListener, close, filterView, getDataProvider, getItemLabelGenerator, getObjectClass, getObjectCount, getViewFilter, indexOf, isInMemory, setFilter, setItemLabelGenerator

Methods inherited from class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider

withConfigurableFilter, withConfigurableFilter, withConvertedFilter

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

addDataProviderListener, addListener, fireEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

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

addDataProviderListener

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.hierarchy.HierarchicalDataProvider

fetch, size

Methods inherited from interface com.storedobject.ui.ObjectChangedListener

saved, undeleted

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, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, clear, getDelegatedLoader, getObjectCount, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter

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

configure, configure, configure, configureMatch

Constructor Details

ObjectForestProvider

public ObjectForestProvider(ObjectForest<T> forest)

Method Details

getForest

public ObjectForest<T> getForest()

getRoots

public List<T> getRoots()

Specified by:

getRoots in class AbstractTreeProvider<Object,T extends StoredObject>

getData

public Filtered<T> getData()

Specified by:

getData in class AbstractTreeProvider<Object,T extends StoredObject>

getFixedFilter

public ObjectLoadFilter<T> getFixedFilter()

Specified by:

getFixedFilter in interface ObjectLoader<T extends StoredObject>

getId

public Object getId(Object item)

Specified by:

getId in interface com.vaadin.flow.data.provider.DataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

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.

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>

get

public T get(int index)

Specified by:

get in interface ObjectLoader<T extends StoredObject>

Overrides:

get in class AbstractTreeProvider<Object,T extends StoredObject>

indexOf

public int indexOf(T object)

Specified by:

indexOf in interface ObjectLoader<T extends StoredObject>

streamAll

public Stream<T> streamAll()

Specified by:

streamAll in interface ObjectLoader<T extends StoredObject>

Overrides:

streamAll in class AbstractTreeProvider<Object,T extends StoredObject>

streamFiltered

public Stream<T> streamFiltered()

Specified by:

streamFiltered in interface ObjectLoader<T extends StoredObject>

Overrides:

streamFiltered in class AbstractTreeProvider<Object,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 AbstractTreeProvider<Object,T extends StoredObject>

refreshAll

public void refreshAll()

Specified by:

refreshAll in interface com.vaadin.flow.data.provider.DataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

Overrides:

refreshAll in class AbstractTreeProvider<Object,T extends StoredObject>

refreshItem

public void refreshItem(Object item)

Specified by:

refreshItem in interface com.vaadin.flow.data.provider.DataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

Overrides:

refreshItem in class com.vaadin.flow.data.provider.AbstractDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

refreshItem

public void refreshItem(Object item,
 boolean refreshChildren)

Specified by:

refreshItem in interface com.vaadin.flow.data.provider.DataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

Overrides:

refreshItem in class com.vaadin.flow.data.provider.AbstractDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

inserted

public void inserted(T object)

Description copied from interface: ObjectChangedListener

Fired when a new object is inserted. The default implementation invokes ObjectChangedListener.saved(StoredObject).

Specified by:

inserted in interface ObjectChangedListener<T extends StoredObject>

Parameters:

object - Object.

updated

public void updated(T object)

Description copied from interface: ObjectChangedListener

Fired when an object is updated. The default implementation invokes ObjectChangedListener.saved(StoredObject).

Specified by:

updated in interface ObjectChangedListener<T extends StoredObject>

Parameters:

object - Object.

deleted

public void deleted(T object)

Description copied from interface: ObjectChangedListener

Fired when an object is deleted. The default implementation does nothing.

Specified by:

deleted in interface ObjectChangedListener<T extends StoredObject>

Parameters:

object - Object.

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.

visitChildren

public void visitChildren(Object parent,
 Consumer<Object> consumer,
 boolean includeGrandChildren)

Visit the children of the parent item.

Parameters:

parent - Parent item.

consumer - Consumer to consume the visit purpose.

includeGrandChildren - Whether recursively include grand-children or not.

getChildCount

public int getChildCount(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<Object,com.vaadin.flow.function.SerializablePredicate<Object>> query)

Specified by:

getChildCount in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

fetchChildren

public Stream<Object> fetchChildren(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<Object,com.vaadin.flow.function.SerializablePredicate<Object>> query)

Specified by:

fetchChildren in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

hasChildren

public boolean hasChildren(Object parent)

Specified by:

hasChildren in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<Object,com.vaadin.flow.function.SerializablePredicate<Object>>

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.

size

public int size()

Description copied from interface: ObjectLoader

Get the instances count.

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Returns:

Count.