com.haulmont.cuba.gui.data.impl

Class AbstractTreeDatasource<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.AbstractTreeDatasource<T,K>

Type Parameters:

T - Entity

K - Key

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>, HierarchicalDatasource<T,K>, DatasourceImplementation<T>

Direct Known Subclasses:

AbstractTreeTableDatasource, BasicPermissionTreeDatasource, ConditionDescriptorsDs, ConditionsDs, DiffTreeDatasource, ManagedBeanInfoDatasource

public abstract class AbstractTreeDatasource<T extends Entity<K>,K>
extends CollectionDatasourceImpl<T,K>
implements HierarchicalDatasource<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
AbstractTreeDatasource()

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the underlying collection.
java.util.Collection<K>	getChildren(K itemId) Get children IDs for item with the given ID
java.lang.String	getHierarchyPropertyName() Property of entity which forms the hierarchy
K	getParent(K itemId) Get parent ID for item with the given ID
java.util.Collection<K>	getRootItemIds() Identifiers of all root items
boolean	hasChildren(K itemId) True if item with the given ID has children
boolean	isRoot(K itemId) True if item with the given ID is a root item
void	setHierarchyPropertyName(java.lang.String parentPropertyName) Set property of entity which forms the hierarchy

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

addItem, addItemFirst, aggregate, committed, containsItem, excludeItem, firstItemId, getCompiledLoadContext, getFirstResult, getIdByIndex, getItem, getItemIds, getItemIds, getItems, includeItem, includeItemFirst, indexOfId, isFirstId, isLastId, isSuspended, lastItemId, modifyItem, nextItemId, pinQuery, prevItemId, refresh, refresh, refreshIfNotSuspended, refreshIfNotSuspended, removeItem, resetSortOrder, revert, setFirstResult, setSuspended, 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, 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

AbstractTreeDatasource

public AbstractTreeDatasource()

Method Detail

getHierarchyPropertyName

public java.lang.String getHierarchyPropertyName()

Description copied from interface: HierarchicalDatasource

Property of entity which forms the hierarchy

Specified by:

getHierarchyPropertyName in interface HierarchicalDatasource<T extends Entity<K>,K>

setHierarchyPropertyName

public void setHierarchyPropertyName(java.lang.String parentPropertyName)

Description copied from interface: HierarchicalDatasource

Set property of entity which forms the hierarchy

Specified by:

setHierarchyPropertyName in interface HierarchicalDatasource<T extends Entity<K>,K>

getRootItemIds

public java.util.Collection<K> getRootItemIds()

Description copied from interface: HierarchicalDatasource

Identifiers of all root items

Specified by:

getRootItemIds in interface HierarchicalDatasource<T extends Entity<K>,K>

getParent

public K getParent(K itemId)

Description copied from interface: HierarchicalDatasource

Get parent ID for item with the given ID

Specified by:

getParent in interface HierarchicalDatasource<T extends Entity<K>,K>

getChildren

public java.util.Collection<K> getChildren(K itemId)

Description copied from interface: HierarchicalDatasource

Get children IDs for item with the given ID

Specified by:

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

isRoot

public boolean isRoot(K itemId)

Description copied from interface: HierarchicalDatasource

True if item with the given ID is a root item

Specified by:

isRoot in interface HierarchicalDatasource<T extends Entity<K>,K>

clear

public void clear()

Description copied from interface: CollectionDatasource

Clear the underlying collection. The datasource "modified" state doesn't change.

Specified by:

clear in interface CollectionDatasource<T extends Entity<K>,K>

Overrides:

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

hasChildren

public boolean hasChildren(K itemId)

Description copied from interface: HierarchicalDatasource

True if item with the given ID has children

Specified by:

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