Package io.jmix.flowui.data.grid

Class ContainerTreeDataGridItems<E>

java.lang.Object

com.vaadin.flow.data.provider.AbstractDataProvider<T,Void>

io.jmix.flowui.data.grid.ContainerDataGridItems<E>

io.jmix.flowui.data.grid.ContainerTreeDataGridItems<E>

Type Parameters:

E - the type of entity contained in the associated CollectionContainer

All Implemented Interfaces:

com.vaadin.flow.data.provider.DataProvider<E,Void>, com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<E,Void>, ContainerDataUnit<E>, DataUnit, EntityDataUnit, DataGridItems<E>, DataGridItems.Sortable<E>, EntityDataGridItems<E>, TreeDataGridItems<E>, HasType<E>, Serializable

public class ContainerTreeDataGridItems<E>
extends ContainerDataGridItems<E>
implements TreeDataGridItems<E>, com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<E,Void>

A specialized implementation of ContainerDataGridItems designed to handle hierarchical data structures.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.data.grid.DataGridItems

DataGridItems.ItemSetChangeEvent<T>, DataGridItems.SelectedItemChangeEvent<T>, DataGridItems.Sortable<T>, DataGridItems.ValueChangeEvent<T>

Nested classes/interfaces inherited from interface io.jmix.flowui.data.DataUnit

DataUnit.StateChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	hierarchyProperty
protected final boolean	showOrphans

Fields inherited from class io.jmix.flowui.data.grid.ContainerDataGridItems

container, suppressSorting

Constructor Summary

Constructors

Constructor	Description
ContainerTreeDataGridItems(CollectionContainer<E> container, String hierarchyProperty)
ContainerTreeDataGridItems(CollectionContainer<E> container, String hierarchyProperty, boolean showOrphans)

Method Summary

Modifier and Type	Method	Description
Stream<E>	fetchChildren(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<E,Void> query)
int	getChildCount(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<E,Void> query)
Stream<E>	getChildren(E item)	Retrieves the children of the specified item in a hierarchical structure.
int	getLevel(E item)	Determines the hierarchical level of the given item within a tree structure.
protected E	getParent(E item)
boolean	hasChildren(E item)

Methods inherited from class io.jmix.flowui.data.grid.ContainerDataGridItems

addItemSetChangeListener, addSelectedItemChangeListener, addStateChangeListener, addValueChangeListener, containerCollectionChanged, containerItemChanged, containerItemPropertyChanged, containsItem, createSort, enableSorting, fetch, getContainer, getEntityMetaClass, getEventBus, getItem, getItems, getItemValue, getSelectedItem, getState, getType, initContainer, isInMemory, resetSortOrder, setSelectedItem, size, sort, suppressSorting

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

addDataProviderListener, addListener, fireEvent, refreshAll, refreshItem, refreshItem

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.data.grid.DataGridItems

addItemSetChangeListener, addSelectedItemChangeListener, addValueChangeListener, containsItem, getItem, getItems, getItemValue, getSelectedItem, setSelectedItem

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

addDataProviderListener, getId, isInMemory, refreshAll, refreshItem, refreshItem

Methods inherited from interface io.jmix.flowui.data.DataUnit

addStateChangeListener, getState

Methods inherited from interface io.jmix.flowui.data.HasType

getType

Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider

fetch, size, withConfigurableFilter, withConfigurableFilter, withConvertedFilter

Field Details

hierarchyProperty

protected final String hierarchyProperty

showOrphans

protected final boolean showOrphans

Constructor Details

ContainerTreeDataGridItems

public ContainerTreeDataGridItems(CollectionContainer<E> container,
 String hierarchyProperty)

ContainerTreeDataGridItems

public ContainerTreeDataGridItems(CollectionContainer<E> container,
 String hierarchyProperty,
 boolean showOrphans)

Method Details

getChildCount

public int getChildCount(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<E,Void> query)

Specified by:

getChildCount in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<E,Void>

fetchChildren

public Stream<E> fetchChildren(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<E,Void> query)

Specified by:

fetchChildren in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<E,Void>

getChildren

public Stream<E> getChildren(@Nullable
 E item)

Retrieves the children of the specified item in a hierarchical structure. If the provided item is null, it retrieves the root-level items. If the provided item is not null, it retrieves the direct children of the specified item.

Parameters:

item - the item whose children are to be retrieved, or null to retrieve root-level items

Returns:

a stream of child items associated with the specified parent item or root items if null

hasChildren

public boolean hasChildren(E item)

Specified by:

hasChildren in interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<E,Void>

getLevel

public int getLevel(E item)

Determines the hierarchical level of the given item within a tree structure. The root level is represented as 0, with each subsequent level increasing by 1.

Parameters:

item - the item whose hierarchical level is to be determined

Returns:

the level of the specified item, where 0 represents the root level

Throws:

IllegalArgumentException - if the specified item is not contained within the data provider

getParent

@Nullable
protected E getParent(E item)