com.haulmont.cuba.gui.data.impl

Class GroupDatasourceImpl<T extends Entity<K>,K>

java.lang.Object

com.haulmont.cuba.gui.data.impl.AbstractDatasource<T>

com.haulmont.cuba.gui.data.impl.DatasourceImpl<T>

com.haulmont.cuba.gui.data.impl.AbstractCollectionDatasource<T,K>

com.haulmont.cuba.gui.data.impl.CollectionDatasourceImpl<T,K>

com.haulmont.cuba.gui.data.impl.GroupDatasourceImpl<T,K>

All Implemented Interfaces:

CollectionDatasource<T,K>, CollectionDatasource.Aggregatable<T,K>, CollectionDatasource.Indexed<T,K>, CollectionDatasource.Ordered<T,K>, CollectionDatasource.Sortable<T,K>, CollectionDatasource.SupportsApplyToSelected<T,K>, CollectionDatasource.SupportsPaging<T,K>, CollectionDatasource.SupportsRefreshMode<T,K>, CollectionDatasource.Suspendable<T,K>, Datasource<T>, GroupDatasource<T,K>, DatasourceImplementation<T>

Direct Known Subclasses:

CustomGroupDatasource, StatisticsDatasource, UiPermissionsDatasource, UserSessionsDatasource, ValueGroupDatasourceImpl

public class GroupDatasourceImpl<T extends Entity<K>,K>
extends CollectionDatasourceImpl<T,K>
implements GroupDatasource<T,K>

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>

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

CollectionDatasource.Sortable.Order, CollectionDatasource.Sortable.SortInfo<P>

Constructor Summary

Constructors

Constructor and Description
GroupDatasourceImpl()

Method Summary

Modifier and Type	Method and Description
boolean	containsGroup(GroupInfo groupId) Indicates that a group is contained in the groups tree
K	firstItemId()
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
K	lastItemId()
K	nextItemId(K itemId)
K	prevItemId(K itemId)
java.util.List<GroupInfo>	rootGroups()
void	setSuspended(boolean suspended)

Methods inherited from class com.haulmont.cuba.gui.data.impl.CollectionDatasourceImpl

addItem, addItemFirst, aggregate, clear, committed, containsItem, excludeItem, getCompiledLoadContext, getFirstResult, getIdByIndex, getItem, getItemIds, getItemIds, getItems, includeItem, includeItemFirst, indexOfId, isFirstId, isLastId, isSuspended, modifyItem, pinQuery, refresh, refresh, refreshIfNotSuspended, refreshIfNotSuspended, removeItem, resetSortOrder, revert, setFirstResult, size, sort, unpinAllQuery, unpinLastQuery, updateItem

Methods inherited from class com.haulmont.cuba.gui.data.impl.AbstractCollectionDatasource

addCollectionChangeListener, addListener, commit, getCount, getItemNN, getLastRefreshParameters, getMaxResults, getQuery, getQueryFilter, getRefreshMode, getRefreshOnComponentValueChange, isCacheable, isSoftDeletion, removeCollectionChangeListener, removeListener, resumeListeners, setCacheable, setItem, setMaxResults, setQuery, setQuery, setQueryFilter, setRefreshMode, setRefreshOnComponentValueChange, setSoftDeletion, suspendListeners

Methods inherited from class com.haulmont.cuba.gui.data.impl.DatasourceImpl

getDataSupplier, getDsContext, getItem, getItemIfValid, getMetaClass, getState, getView, initialized, invalidate, setDataSupplier, setDsContext, setMetaClass, setup, setView, setView, valid

Methods inherited from class com.haulmont.cuba.gui.data.impl.AbstractDatasource

addItemChangeListener, addItemPropertyChangeListener, addStateChangeListener, clearCommitLists, deleted, enableListeners, getCommitMode, getId, getItemsToCreate, getItemsToDelete, getItemsToUpdate, getLoadDynamicAttributes, getParent, isAllowCommit, isModified, modified, removeItemChangeListener, removeItemPropertyChangeListener, removeStateChangeListener, setAllowCommit, setCommitMode, setLoadDynamicAttributes, setModified, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

getCount

Methods inherited from interface com.haulmont.cuba.gui.data.impl.DatasourceImplementation

clearCommitLists, deleted, enableListeners, getItemsToCreate, getItemsToDelete, getItemsToUpdate, getParent, modified, setCommitMode, setModified, setParent

Constructor Detail

GroupDatasourceImpl

public GroupDatasourceImpl()

Method Detail

groupBy

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

Description copied from interface: GroupDatasource

Perform grouping by the list of properties

Specified by:

groupBy in interface GroupDatasource<T extends Entity<K>,K>

rootGroups

public java.util.List<GroupInfo> rootGroups()

Specified by:

rootGroups in interface GroupDatasource<T extends Entity<K>,K>

Returns:

the list of root groups

hasChildren

public boolean hasChildren(GroupInfo groupId)

Description copied from interface: GroupDatasource

Indicates that group has nested groups

Specified by:

hasChildren in interface GroupDatasource<T extends Entity<K>,K>

getChildren

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

Specified by:

getChildren in interface GroupDatasource<T extends Entity<K>,K>

Returns:

the list of nested groups

getOwnChildItems

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

Specified by:

getOwnChildItems in interface GroupDatasource<T extends Entity<K>,K>

Returns:

the list of nested items

getChildItems

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

Specified by:

getChildItems in interface GroupDatasource<T extends Entity<K>,K>

Returns:

the list of items from all nested group levels

getParentGroup

public GroupInfo getParentGroup(Entity entity)

Specified by:

getParentGroup in interface GroupDatasource<T extends Entity<K>,K>

Returns:

the parent group of passed item

getGroupPath

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

Specified by:

getGroupPath in interface GroupDatasource<T extends Entity<K>,K>

Returns:

the path through all parent groups

getGroupProperty

public java.lang.Object getGroupProperty(GroupInfo groupId)

Specified by:

getGroupProperty in interface GroupDatasource<T extends Entity<K>,K>

Returns:

a group property

getGroupPropertyValue

public java.lang.Object getGroupPropertyValue(GroupInfo groupId)

Specified by:

getGroupPropertyValue in interface GroupDatasource<T extends Entity<K>,K>

Returns:

a group property value

getGroupItemIds

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

Specified by:

getGroupItemIds in interface GroupDatasource<T extends Entity<K>,K>

Returns:

item ids that are contained in the selected group

getGroupItemsCount

public int getGroupItemsCount(GroupInfo groupId)

Specified by:

getGroupItemsCount in interface GroupDatasource<T extends Entity<K>,K>

Returns:

a count of items that are contained in the selected group

hasGroups

public boolean hasGroups()

Description copied from interface: GroupDatasource

Indicated that a datasource has groups

Specified by:

hasGroups in interface GroupDatasource<T extends Entity<K>,K>

getGroupProperties

public java.util.Collection<?> getGroupProperties()

Specified by:

getGroupProperties in interface GroupDatasource<T extends Entity<K>,K>

Returns:

group properties

containsGroup

public boolean containsGroup(GroupInfo groupId)

Description copied from interface: GroupDatasource

Indicates that a group is contained in the groups tree

Specified by:

containsGroup in interface GroupDatasource<T extends Entity<K>,K>

nextItemId

public K nextItemId(K itemId)

Specified by:

nextItemId in interface CollectionDatasource.Ordered<T extends Entity<K>,K>

Overrides:

nextItemId in class CollectionDatasourceImpl<T extends Entity<K>,K>

prevItemId

public K prevItemId(K itemId)

Specified by:

prevItemId in interface CollectionDatasource.Ordered<T extends Entity<K>,K>

Overrides:

prevItemId in class CollectionDatasourceImpl<T extends Entity<K>,K>

firstItemId

public K firstItemId()

Specified by:

firstItemId in interface CollectionDatasource.Ordered<T extends Entity<K>,K>

Overrides:

firstItemId in class CollectionDatasourceImpl<T extends Entity<K>,K>

lastItemId

public K lastItemId()

Specified by:

lastItemId in interface CollectionDatasource.Ordered<T extends Entity<K>,K>

Overrides:

lastItemId in class CollectionDatasourceImpl<T extends Entity<K>,K>

setSuspended

public void setSuspended(boolean suspended)

Specified by:

setSuspended in interface CollectionDatasource.Suspendable<T extends Entity<K>,K>

Overrides:

setSuspended in class CollectionDatasourceImpl<T extends Entity<K>,K>