com.haulmont.cuba.gui.data

Interface GroupDatasource<T extends Entity<K>,K>

Type Parameters:

T - type of entity

K - type of entity ID

All Superinterfaces:

CollectionDatasource<T,K>, Datasource<T>

All Known Implementing Classes:

CustomGroupDatasource, CustomValueGroupDatasource, GroupDatasourceImpl, GroupPropertyDatasourceImpl, StatisticsDatasource, UiPermissionsDatasource, UserSessionsDatasource, ValueGroupDatasourceImpl

public interface GroupDatasource<T extends Entity<K>,K>
extends CollectionDatasource<T,K>

CollectionDatasource which supports a grouping of items by the list of properties

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.data.CollectionDatasource

CollectionDatasource.Aggregatable<T extends Entity<K>,K>, CollectionDatasource.CollectionChangeEvent<T extends Entity<K>,K>, CollectionDatasource.CollectionChangeListener<T extends Entity<K>,K>, CollectionDatasource.Indexed<T extends Entity<K>,K>, CollectionDatasource.Lazy<T extends Entity<K>,K>, CollectionDatasource.Operation, CollectionDatasource.Ordered<T extends Entity<K>,K>, CollectionDatasource.RefreshMode, CollectionDatasource.Sortable<T extends Entity<K>,K>, CollectionDatasource.SupportsApplyToSelected<T extends Entity<K>,K>, CollectionDatasource.SupportsPaging<T extends Entity<K>,K>, CollectionDatasource.SupportsRefreshMode<T extends Entity<K>,K>, CollectionDatasource.Suspendable<T extends Entity<K>,K>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.data.Datasource

Datasource.CommitMode, Datasource.ItemChangeEvent<T extends Entity>, Datasource.ItemChangeListener<T extends Entity>, Datasource.ItemPropertyChangeEvent<T extends Entity>, Datasource.ItemPropertyChangeListener<T extends Entity>, Datasource.State, Datasource.StateChangeEvent<T extends Entity>, Datasource.StateChangeListener<T extends Entity>

Method Summary

Modifier and Type	Method and Description
boolean	containsGroup(GroupInfo groupId) Indicates that a group is contained in the groups tree
java.util.List<Entity>	getChildItems(GroupInfo groupId)
java.util.List<GroupInfo>	getChildren(GroupInfo groupId)
java.util.Collection<K>	getGroupItemIds(GroupInfo groupId)
int	getGroupItemsCount(GroupInfo groupId)
java.util.List<GroupInfo>	getGroupPath(Entity entity)
java.util.Collection<?>	getGroupProperties()
java.lang.Object	getGroupProperty(GroupInfo groupId)
java.lang.Object	getGroupPropertyValue(GroupInfo groupId)
java.util.List<Entity>	getOwnChildItems(GroupInfo groupId)
GroupInfo	getParentGroup(Entity entity)
void	groupBy(java.lang.Object[] properties) Perform grouping by the list of properties
boolean	hasChildren(GroupInfo groupId) Indicates that group has nested groups
boolean	hasGroups() Indicated that a datasource has groups
java.util.List<GroupInfo>	rootGroups()

Methods inherited from interface com.haulmont.cuba.gui.data.CollectionDatasource

addCollectionChangeListener, addItem, clear, containsItem, excludeItem, getCompiledLoadContext, getItem, getItemIds, getItemNN, getItems, getLastRefreshParameters, getMaxResults, getQuery, getQueryFilter, getRefreshOnComponentValueChange, includeItem, isCacheable, isSoftDeletion, modifyItem, refresh, removeCollectionChangeListener, removeItem, resumeListeners, revert, setCacheable, setMaxResults, setQuery, setQuery, setQueryFilter, setRefreshOnComponentValueChange, setSoftDeletion, size, suspendListeners, updateItem

Methods inherited from interface com.haulmont.cuba.gui.data.Datasource

addItemChangeListener, addItemPropertyChangeListener, addListener, addStateChangeListener, commit, getCommitMode, getDataSupplier, getDsContext, getId, getItem, getItemIfValid, getLoadDynamicAttributes, getMetaClass, getState, getView, invalidate, isAllowCommit, isModified, refresh, removeItemChangeListener, removeItemPropertyChangeListener, removeListener, removeStateChangeListener, setAllowCommit, setItem, setLoadDynamicAttributes, setup

Method Detail

groupBy

void groupBy(java.lang.Object[] properties)

Perform grouping by the list of properties

rootGroups

java.util.List<GroupInfo> rootGroups()

Returns:

the list of root groups

hasChildren

boolean hasChildren(GroupInfo groupId)

Indicates that group has nested groups

getChildren

java.util.List<GroupInfo> getChildren(GroupInfo groupId)

Returns:

the list of nested groups

getOwnChildItems

java.util.List<Entity> getOwnChildItems(GroupInfo groupId)

Returns:

the list of nested items

getChildItems

java.util.List<Entity> getChildItems(GroupInfo groupId)

Returns:

the list of items from all nested group levels

getParentGroup

@Nullable
GroupInfo getParentGroup(Entity entity)

Returns:

the parent group of passed item

getGroupPath

java.util.List<GroupInfo> getGroupPath(Entity entity)

Returns:

the path through all parent groups

getGroupProperty

java.lang.Object getGroupProperty(GroupInfo groupId)

Returns:

a group property

getGroupPropertyValue

java.lang.Object getGroupPropertyValue(GroupInfo groupId)

Returns:

a group property value

getGroupItemIds

java.util.Collection<K> getGroupItemIds(GroupInfo groupId)

Returns:

item ids that are contained in the selected group

getGroupItemsCount

int getGroupItemsCount(GroupInfo groupId)

Returns:

a count of items that are contained in the selected group

hasGroups

boolean hasGroups()

Indicated that a datasource has groups

getGroupProperties

java.util.Collection<?> getGroupProperties()

Returns:

group properties

containsGroup

boolean containsGroup(GroupInfo groupId)

Indicates that a group is contained in the groups tree