Package io.jmix.groupgridflowui.data

Class ContainerGroupDataGridItems<T>

java.lang.Object

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

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

io.jmix.groupgridflowui.data.ContainerGroupDataGridItems<T>

All Implemented Interfaces:

com.vaadin.flow.data.provider.DataProvider<T,Void>, com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider<T,Void>, GroupDataGridItems<T>, ContainerDataUnit<T>, DataUnit, EntityDataUnit, DataGridItems<T>, DataGridItems.Sortable<T>, EntityDataGridItems<T>, HasType<T>, Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class ContainerGroupDataGridItems<T>
extends ContainerDataGridItems<T>
implements GroupDataGridItems<T>, org.springframework.context.ApplicationContextAware

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

Nested classes/interfaces inherited from interface io.jmix.flowui.component.groupgrid.data.GroupDataGridItems

GroupDataGridItems.GroupPropertyDescriptorsChangedEvent<T>

Nested classes/interfaces inherited from interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider

com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider.HierarchyFormat

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected com.google.common.collect.BiMap<T,GroupInfo>	childGroupRows
protected Map<GroupInfo,Set<GroupInfo>>	children
protected Map<GroupInfo,List<T>>	groupItems
protected List<GroupProperty>	groupProperties
protected Map<Object,GroupPropertyDescriptor<T>>	groupPropertyDescriptors
protected Map<T,GroupInfo>	itemGroups
protected Metadata	metadata
protected MetadataTools	metadataTools
protected Map<GroupInfo,GroupInfo>	parents
protected com.google.common.collect.BiMap<T,GroupInfo>	rootGroupRows
protected List<GroupInfo>	roots

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

container, PROPERTY_REPLACE_ITEM, suppressSorting

Constructor Summary

Constructors

Constructor	Description
ContainerGroupDataGridItems(CollectionContainer<T> container)

Method Summary

Modifier and Type	Method	Description
void	addGroupPropertyDescriptor(GroupPropertyDescriptor<T> groupPropertyDescriptor)	Adds a group property descriptor for a custom grouping property.
com.vaadin.flow.shared.Registration	addGroupPropertyDescriptorsChangedListener(Consumer<GroupDataGridItems.GroupPropertyDescriptorsChangedEvent<T>> listener)	Adds a listener to be notified when the group property descriptors are changed.
protected void	afterGroupBy()
protected void	checkForUnsupportedProperties(List<GroupProperty> properties)
protected void	collectGroupRowsRecursively(GroupInfo group, com.google.common.collect.BiMap<T,GroupInfo> childGroupRows)
protected Stream<T>	collectOwnChildren(@Nullable T parent)
protected void	containerCollectionChanged(CollectionContainer.CollectionChangeEvent<T> event)
protected void	containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<T> event)
boolean	containsGroup(GroupInfo group)	Indicates that a group is contained in the group tree
protected GroupInfo	createGroupInfo(@Nullable GroupInfo parent, org.apache.commons.collections4.map.LinkedMap<GroupProperty,Object> groupValues)
protected @Nullable T	createGroupItem()
protected void	doGroup()
Stream<T>	fetchChildren(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<T,Void> query)
int	getChildCount(com.vaadin.flow.data.provider.hierarchy.HierarchicalQuery<T,Void> query)
List<T>	getChildItems(GroupInfo group)
List<GroupInfo>	getChildren(GroupInfo group)
protected Set<GroupInfo>	getChildrenInternal(GroupInfo group)
@Nullable GroupInfo	getGroup(T item)
@Nullable GroupInfo	getGroupByItem(T groupItem)	Returns GroupInfo by a group item.
Collection<T>	getGroupItems(GroupInfo group)
int	getGroupItemsCount(GroupInfo group)
List<GroupInfo>	getGroupPath(T item)
Collection<GroupProperty>	getGroupProperties()
@Nullable GroupPropertyDescriptor<T>	getGroupPropertyDescriptor(GroupProperty property)
@Nullable T	getItemByGroup(GroupInfo group)	Returns a group item that corresponds to the provided GroupInfo.
List<T>	getOwnChildItems(GroupInfo group)
List<GroupInfo>	getRootGroups()
protected @Nullable Object	getValueByProperty(T item, GroupProperty property)
void	groupBy(List<GroupProperty> properties)	Perform grouping by the list of properties.
protected @Nullable GroupInfo	groupItems(int propertyIndex, @Nullable GroupInfo parent, Collection<GroupInfo> children, T item, org.apache.commons.collections4.map.LinkedMap<GroupProperty,Object> groupValues)
boolean	hasChildren(GroupInfo groupInfo)	Indicates that the group has nested groups
boolean	hasChildren(T item)
boolean	hasGroups()	Indicates that items have groups
protected boolean	isGroupingAffected(String changedProperty)
boolean	isGroupRow(T item)
protected void	refreshGroups()
void	removeAllGroupPropertyProviders()	Removes all group property descriptors previously added for grouping.
void	removeGroupPropertyDescriptor(GroupProperty property)	Removes a group property descriptor for a custom property that was previously added for grouping.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
protected void	updateGroupRows()

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

addItemSetChangeListener, addSelectedItemChangeListener, addStateChangeListener, addValueChangeListener, containerItemChanged, containsItem, createSort, createSort, enableSorting, fetch, getContainer, getEntityMetaClass, getEventBus, getItem, getItems, getItemValue, getSelectedItem, getState, getType, initContainer, isInMemory, isRefreshAllOnItemReplace, resetSortOrder, setPropertyComparators, setRefreshAllOnItemReplace, setSelectedItem, size, sort, sort, sortInternal, 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, getDepth, getHierarchyFormat, getItemIndex, getParent, size, withConfigurableFilter, withConfigurableFilter, withConvertedFilter

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

metadata

protected Metadata metadata

metadataTools

protected MetadataTools metadataTools

groupProperties

protected List<GroupProperty> groupProperties

parents

protected Map<GroupInfo,GroupInfo> parents

children

protected Map<GroupInfo,Set<GroupInfo>> children

groupPropertyDescriptors

protected Map<Object,GroupPropertyDescriptor<T>> groupPropertyDescriptors

childGroupRows

protected com.google.common.collect.BiMap<T,GroupInfo> childGroupRows

rootGroupRows

protected com.google.common.collect.BiMap<T,GroupInfo> rootGroupRows

roots

protected List<GroupInfo> roots

groupItems

protected Map<GroupInfo,List<T>> groupItems

itemGroups

protected Map<T,GroupInfo> itemGroups

Constructor Details

ContainerGroupDataGridItems

public ContainerGroupDataGridItems(CollectionContainer<T> container)

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

containerCollectionChanged

protected void containerCollectionChanged(CollectionContainer.CollectionChangeEvent<T> event)

Overrides:

containerCollectionChanged in class ContainerDataGridItems<T>

containerItemPropertyChanged

protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<T> event)

Overrides:

containerItemPropertyChanged in class ContainerDataGridItems<T>

groupBy

public void groupBy(List<GroupProperty> properties)

Description copied from interface: GroupDataGridItems

Perform grouping by the list of properties. The available values for properties are:

• MetaPropertyPath can be a property of current or a reference entity.
• Column key (String) of a generated value.

Specified by:

groupBy in interface GroupDataGridItems<T>

doGroup

protected void doGroup()

groupItems

protected @Nullable GroupInfo groupItems(int propertyIndex,
 @Nullable GroupInfo parent,
 Collection<GroupInfo> children,
 T item,
 org.apache.commons.collections4.map.LinkedMap<GroupProperty,Object> groupValues)

getValueByProperty

protected @Nullable Object getValueByProperty(T item,
 GroupProperty property)

getRootGroups

public List<GroupInfo> getRootGroups()

Specified by:

getRootGroups in interface GroupDataGridItems<T>

Returns:

the list of root groups

hasChildren

public boolean hasChildren(GroupInfo groupInfo)

Description copied from interface: GroupDataGridItems

Indicates that the group has nested groups

Specified by:

hasChildren in interface GroupDataGridItems<T>

Parameters:

groupInfo - group info

hasChildren

public boolean hasChildren(T item)

Specified by:

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

getChildren

public List<GroupInfo> getChildren(GroupInfo group)

Specified by:

getChildren in interface GroupDataGridItems<T>

Returns:

the list of own nested groups

getOwnChildItems

public List<T> getOwnChildItems(GroupInfo group)

Specified by:

getOwnChildItems in interface GroupDataGridItems<T>

Returns:

the list of nested items

getChildItems

public List<T> getChildItems(GroupInfo group)

Specified by:

getChildItems in interface GroupDataGridItems<T>

Returns:

the list of items from all nested group levels

getChildrenInternal

protected Set<GroupInfo> getChildrenInternal(GroupInfo group)

getGroup

public @Nullable GroupInfo getGroup(T item)

Specified by:

getGroup in interface GroupDataGridItems<T>

Returns:

a group that the passed item belongs to

getGroupPath

public List<GroupInfo> getGroupPath(T item)

Specified by:

getGroupPath in interface GroupDataGridItems<T>

Parameters:

item - item (leaf) to get all parent groups for

Returns:

the path through all parent groups

getGroupItems

public Collection<T> getGroupItems(GroupInfo group)

Specified by:

getGroupItems in interface GroupDataGridItems<T>

Returns:

items that are contained in the selected group

getGroupItemsCount

public int getGroupItemsCount(GroupInfo group)

Specified by:

getGroupItemsCount in interface GroupDataGridItems<T>

Returns:

a count of items that are contained in the selected group

hasGroups

public boolean hasGroups()

Description copied from interface: GroupDataGridItems

Indicates that items have groups

Specified by:

hasGroups in interface GroupDataGridItems<T>

getGroupProperties

public Collection<GroupProperty> getGroupProperties()

Specified by:

getGroupProperties in interface GroupDataGridItems<T>

Returns:

group properties

containsGroup

public boolean containsGroup(GroupInfo group)

Description copied from interface: GroupDataGridItems

Indicates that a group is contained in the group tree

Specified by:

containsGroup in interface GroupDataGridItems<T>

addGroupPropertyDescriptor

public void addGroupPropertyDescriptor(GroupPropertyDescriptor<T> groupPropertyDescriptor)

Description copied from interface: GroupDataGridItems

Adds a group property descriptor for a custom grouping property. This method enables defining custom logic for computing property values during data grouping.

For instance:

 customersDataGrid.getItems().addGroupPropertyDescriptor(
         new BaseGroupPropertyDescriptor<Customer>("fullName", context -> {
             Customer item = context.getItem();
             return item.getFirstName() + " " + item.getLastName();
         }).withSortProperties(List.of("firstName", "lastName")));
 

Specified by:

addGroupPropertyDescriptor in interface GroupDataGridItems<T>

Parameters:

groupPropertyDescriptor - implementation of GroupPropertyDescriptor

removeGroupPropertyDescriptor

public void removeGroupPropertyDescriptor(GroupProperty property)

Description copied from interface: GroupDataGridItems

Removes a group property descriptor for a custom property that was previously added for grouping.

Specified by:

removeGroupPropertyDescriptor in interface GroupDataGridItems<T>

Parameters:

property - the custom property

getGroupPropertyDescriptor

public @Nullable GroupPropertyDescriptor<T> getGroupPropertyDescriptor(GroupProperty property)

Specified by:

getGroupPropertyDescriptor in interface GroupDataGridItems<T>

Parameters:

property - the custom property

Returns:

a group property descriptor for a custom property

removeAllGroupPropertyProviders

public void removeAllGroupPropertyProviders()

Description copied from interface: GroupDataGridItems

Removes all group property descriptors previously added for grouping.

Specified by:

removeAllGroupPropertyProviders in interface GroupDataGridItems<T>

getGroupByItem

public @Nullable GroupInfo getGroupByItem(T groupItem)

Description copied from interface: GroupDataGridItems

Returns GroupInfo by a group item.

Group item is an empty entity object that represents a grouping row in a GroupListDataComponent. It does not exist in the data container.

Specified by:

getGroupByItem in interface GroupDataGridItems<T>

Parameters:

groupItem - a group item

Returns:

group info or null if there is no group info for the given item

getItemByGroup

public @Nullable T getItemByGroup(GroupInfo group)

Description copied from interface: GroupDataGridItems

Returns a group item that corresponds to the provided GroupInfo.

Group item is an empty entity object that represents a grouping row in a GroupListDataComponent. It does not exist in the data container.

Specified by:

getItemByGroup in interface GroupDataGridItems<T>

Parameters:

group - group info

Returns:

group item or null if there is no item for the given group info

getChildCount

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

Specified by:

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

fetchChildren

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

Specified by:

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

addGroupPropertyDescriptorsChangedListener

public com.vaadin.flow.shared.Registration addGroupPropertyDescriptorsChangedListener(Consumer<GroupDataGridItems.GroupPropertyDescriptorsChangedEvent<T>> listener)

Description copied from interface: GroupDataGridItems

Adds a listener to be notified when the group property descriptors are changed.

Specified by:

addGroupPropertyDescriptorsChangedListener in interface GroupDataGridItems<T>

Parameters:

listener - the listener to add

Returns:

a registration object for removing the listener

isGroupRow

public boolean isGroupRow(T item)

updateGroupRows

protected void updateGroupRows()

collectOwnChildren

protected Stream<T> collectOwnChildren(@Nullable T parent)

collectGroupRowsRecursively

protected void collectGroupRowsRecursively(GroupInfo group,
 com.google.common.collect.BiMap<T,GroupInfo> childGroupRows)

createGroupItem

protected @Nullable T createGroupItem()

refreshGroups

protected void refreshGroups()

isGroupingAffected

protected boolean isGroupingAffected(String changedProperty)

afterGroupBy

protected void afterGroupBy()

checkForUnsupportedProperties

protected void checkForUnsupportedProperties(List<GroupProperty> properties)

createGroupInfo

protected GroupInfo createGroupInfo(@Nullable GroupInfo parent,
 org.apache.commons.collections4.map.LinkedMap<GroupProperty,Object> groupValues)