com.haulmont.cuba.gui.data.impl

Class HierarchicalDatasourceImpl<T extends io.jmix.core.Entity,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.HierarchicalDatasourceImpl<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.SupportsSortDelegate<T,K>, CollectionDatasource.Suspendable<T,K>, Datasource<T>, HierarchicalDatasource<T,K>, DatasourceImplementation<T>

Direct Known Subclasses:

CustomHierarchicalDatasource, ValueHierarchicalDatasourceImpl

public class HierarchicalDatasourceImpl<T extends io.jmix.core.Entity,K>
extends CollectionDatasourceImpl<T,K>
implements HierarchicalDatasource<T,K>

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.data.impl.AbstractCollectionDatasource

AbstractCollectionDatasource.ComponentValueListener

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.data.impl.AbstractDatasource

AbstractDatasource.ItemListener

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

CollectionDatasource.Aggregatable<T extends io.jmix.core.Entity,K>, CollectionDatasource.CollectionChangeEvent<T extends io.jmix.core.Entity,K>, CollectionDatasource.CollectionChangeListener<T extends io.jmix.core.Entity,K>, CollectionDatasource.Indexed<T extends io.jmix.core.Entity,K>, CollectionDatasource.Lazy<T extends io.jmix.core.Entity,K>, CollectionDatasource.Operation, CollectionDatasource.Ordered<T extends io.jmix.core.Entity,K>, CollectionDatasource.RefreshMode, CollectionDatasource.Sortable<T extends io.jmix.core.Entity,K>, CollectionDatasource.SortDelegate<T extends io.jmix.core.Entity,K>, CollectionDatasource.SupportsApplyToSelected<T extends io.jmix.core.Entity,K>, CollectionDatasource.SupportsPaging<T extends io.jmix.core.Entity,K>, CollectionDatasource.SupportsRefreshMode<T extends io.jmix.core.Entity,K>, CollectionDatasource.SupportsSortDelegate<T extends io.jmix.core.Entity,K>, CollectionDatasource.Suspendable<T extends io.jmix.core.Entity,K>, CollectionDatasource.UnmuteEventsMode

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

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	hierarchyPropertyName

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

aggregatableDelegate, data, firstResult, inRefresh, lastQuery, prevQueries, queryKey, refreshOnResumeRequired, sortDelegate, sortOnDb, suspended

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

cacheable, componentValueListener, dataLoadError, filter, listenersSuspended, maxResults, query, queryParameters, refreshMode, refreshOnComponentValueChange, savedParameters, softDeletion, sortInfos, suspendedEvents, userSession

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

dataSupplier, dsContext, item, metaClass, state, view

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

allowCommit, backgroundWorker, commitMode, id, itemsToCreate, itemsToDelete, itemsToUpdate, listener, listenersEnabled, loadDynamicAttributes, metadata, modified, parentDs

Constructor Summary

Constructors

Constructor and Description
HierarchicalDatasourceImpl()

Method Summary

Modifier and Type	Method and Description
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 hierarchyPropertyName) Set property of entity which forms the hierarchy

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

addItem, addItemFirst, afterLoadData, afterRefresh, aggregate, aggregateValues, beforeLoadData, beforeRefresh, checkState, checkStateBeforeAdd, clear, committed, containsAllDataFromDb, containsItem, detachListener, doSort, excludeItem, firstItemId, getCompiledLoadContext, getFirstResult, getIdByIndex, getItem, getItemIds, getItemIds, getItems, getItemValue, includeItem, includeItemFirst, incrementQueryKey, indexOfId, initAggregatableDelegate, internalAddItem, internalIncludeItem, isFirstId, isLastId, isSuspended, lastItemId, loadData, modifyItem, needLoading, nextItemId, pinQuery, prepareLoadContext, prevItemId, refresh, refresh, refreshIfNotSuspended, refreshIfNotSuspended, removeItem, resetSortOrder, revert, setFirstResult, setSortDelegate, setSuspended, size, sort, unpinAllQuery, unpinLastQuery, updateItem

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

addCollectionChangeListener, checkDataLoadError, commit, createDataQuery, createEntityComparator, fireCollectionChanged, getCount, getItemNN, getJPQLQuery, getLastRefreshParameters, getLoggingTag, getMaxResults, getQuery, getQueryFilter, getQueryParameters, getRefreshMode, getRefreshOnComponentValueChange, getTemplateParams, isCacheable, isSoftDeletion, makeCaseInsensitive, mute, removeCollectionChangeListener, resumeListeners, setCacheable, setItem, setMaxResults, setQuery, setQuery, setQueryFilter, setRefreshMode, setRefreshOnComponentValueChange, setSoftDeletion, setSortDirection, suspendListeners, unmute

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

__setItem, 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, addParentsToNested, addStateChangeListener, attachListener, clearCommitLists, deleted, detachListener, enableListeners, fireItemChanged, fireStateChanged, getCommitMode, getEventRouter, 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

clone, equals, finalize, 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, mute, refresh, removeCollectionChangeListener, removeItem, resumeListeners, revert, setCacheable, setMaxResults, setQuery, setQuery, setQueryFilter, setRefreshOnComponentValueChange, setSoftDeletion, size, suspendListeners, unmute, updateItem

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

addItemChangeListener, addItemPropertyChangeListener, addStateChangeListener, commit, getCommitMode, getDataSupplier, getDsContext, getId, getItem, getItemIfValid, getLoadDynamicAttributes, getMetaClass, getState, getView, invalidate, isAllowCommit, isModified, refresh, removeItemChangeListener, removeItemPropertyChangeListener, 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

Field Detail

hierarchyPropertyName

protected java.lang.String hierarchyPropertyName

Constructor Detail

HierarchicalDatasourceImpl

public HierarchicalDatasourceImpl()

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 io.jmix.core.Entity,K>

setHierarchyPropertyName

public void setHierarchyPropertyName(java.lang.String hierarchyPropertyName)

Description copied from interface: HierarchicalDatasource

Set property of entity which forms the hierarchy

Specified by:

setHierarchyPropertyName in interface HierarchicalDatasource<T extends io.jmix.core.Entity,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 io.jmix.core.Entity,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 io.jmix.core.Entity,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 io.jmix.core.Entity,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 io.jmix.core.Entity,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 io.jmix.core.Entity,K>