com.haulmont.cuba.gui.data.impl

Class CollectionDatasourceImpl<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>

Type Parameters:

T - type of entity

K - type of entity ID

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

Direct Known Subclasses:

AbstractTreeDatasource, CustomCollectionDatasource, EntityParamsDatasource, EntityPermissionTargetsDatasource, GroupDatasourceImpl, HierarchicalDatasourceImpl, JmxInstancesDatasource, ManagedBeanAttributeDatasource, MultiplePermissionTargetsDatasource, RestorablePermissionDatasource, ScreenHistoryDatasource, ThreadsDatasource, ValueCollectionDatasourceImpl

public class CollectionDatasourceImpl<T extends Entity<K>,K>
extends AbstractCollectionDatasource<T,K>
implements CollectionDatasource.Indexed<T,K>, CollectionDatasource.Sortable<T,K>, CollectionDatasource.Aggregatable<T,K>, CollectionDatasource.Suspendable<T,K>, CollectionDatasource.SupportsPaging<T,K>, CollectionDatasource.SupportsApplyToSelected<T,K>

Most commonly used CollectionDatasource implementation. Contains collection of standalone (not property) entities, and can request data from database and commit changes.
Can be used as a base class for custom datasources that override e.g. loadData(java.util.Map) method.

Nested Class Summary

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

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

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>

Constructor Summary

Constructors

Constructor and Description
CollectionDatasourceImpl()

Method Summary

Modifier and Type	Method and Description
void	addItem(T item) Add an item to the collection.
void	addItemFirst(T item) Add an item to the collection to the first position.
java.util.Map<AggregationInfo,java.lang.String>	aggregate(AggregationInfo[] aggregationInfos, java.util.Collection itemIds) Perform aggregation
void	clear() Clear the underlying collection.
void	committed(java.util.Set<Entity> entities) Invoked after commit.
boolean	containsItem(K itemId)
void	excludeItem(T item) Exclude an item from the collection.
K	firstItemId()
LoadContext	getCompiledLoadContext()
int	getFirstResult()
K	getIdByIndex(int index)
T	getItem(K id)
java.util.Collection<K>	getItemIds()
java.util.List<K>	getItemIds(int startIndex, int numberOfItems)
java.util.Collection<T>	getItems() In standard implementations this is a wrapper method around CollectionDatasource.getItemIds() and CollectionDatasource.getItem(Object).
void	includeItem(T item) Include an item into the collection.
void	includeItemFirst(T item) Include an item into the collection to the first position.
int	indexOfId(K itemId)
boolean	isFirstId(K itemId)
boolean	isLastId(K itemId)
boolean	isSuspended()
K	lastItemId()
void	modifyItem(T item) Update an item in the collection if it is already there.
K	nextItemId(K itemId)
void	pinQuery()
K	prevItemId(K itemId)
void	refresh() Refreshes the datasource moving it to the Datasource.State.VALID state
void	refresh(java.util.Map<java.lang.String,java.lang.Object> parameters) Refresh datasource passing specified parameters to the query.
void	refreshIfNotSuspended()
void	refreshIfNotSuspended(java.util.Map<java.lang.String,java.lang.Object> parameters)
void	removeItem(T item) Remove an item from the collection.
void	resetSortOrder() Remove sort infos
void	revert() Revert the datasource to its initial state before data modification.
void	setFirstResult(int startPosition)
void	setSuspended(boolean suspended)
int	size()
void	sort(CollectionDatasource.Sortable.SortInfo[] sortInfos) Perform sorting
void	unpinAllQuery()
void	unpinLastQuery()
void	updateItem(T item) Update an item in the collection if it is already there.

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, getItemNN, getLastRefreshParameters, getMaxResults, getQuery, getQueryFilter, getRefreshOnComponentValueChange, isCacheable, isSoftDeletion, removeCollectionChangeListener, resumeListeners, setCacheable, setMaxResults, setQuery, setQuery, setQueryFilter, setRefreshOnComponentValueChange, setSoftDeletion, suspendListeners

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, 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

CollectionDatasourceImpl

public CollectionDatasourceImpl()

Method Detail

refreshIfNotSuspended

public void refreshIfNotSuspended()

Specified by:

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

refreshIfNotSuspended

public void refreshIfNotSuspended(java.util.Map<java.lang.String,java.lang.Object> parameters)

Specified by:

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

refresh

public void refresh()

Description copied from interface: Datasource

Refreshes the datasource moving it to the Datasource.State.VALID state

Specified by:

refresh in interface Datasource<T extends Entity<K>>

Overrides:

refresh in class DatasourceImpl<T extends Entity<K>>

refresh

public void refresh(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: CollectionDatasource

Refresh datasource passing specified parameters to the query.

These parameters may be referenced in the query text by "custom$" prefix.

Specified by:

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

Parameters:

parameters - parameters map

getItem

public T getItem(K id)

Specified by:

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

Returns:

item by ID, can be null

getItemIds

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

Specified by:

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

Returns:

all item IDs

getItems

public java.util.Collection<T> getItems()

Description copied from interface: CollectionDatasource

In standard implementations this is a wrapper method around CollectionDatasource.getItemIds() and CollectionDatasource.getItem(Object). Use it only if you really need the collection of items. Otherwise use CollectionDatasource.getItemIds() or CollectionDatasource.size() directly.

Specified by:

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

Returns:

collection of all items

size

public int size()

Specified by:

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

Returns:

size of the underlying collection.

sort

public void sort(CollectionDatasource.Sortable.SortInfo[] sortInfos)

Description copied from interface: CollectionDatasource.Sortable

Perform sorting

Specified by:

sort in interface CollectionDatasource.Sortable<T extends Entity<K>,K>

resetSortOrder

public void resetSortOrder()

Description copied from interface: CollectionDatasource.Sortable

Remove sort infos

Specified by:

resetSortOrder in interface CollectionDatasource.Sortable<T extends Entity<K>,K>

indexOfId

public int indexOfId(K itemId)

Specified by:

indexOfId in interface CollectionDatasource.Indexed<T extends Entity<K>,K>

getIdByIndex

public K getIdByIndex(int index)

Specified by:

getIdByIndex in interface CollectionDatasource.Indexed<T extends Entity<K>,K>

getItemIds

public java.util.List<K> getItemIds(int startIndex,
                                    int numberOfItems)

Specified by:

getItemIds in interface CollectionDatasource.Indexed<T extends Entity<K>,K>

firstItemId

public K firstItemId()

Specified by:

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

lastItemId

public K lastItemId()

Specified by:

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

nextItemId

public K nextItemId(K itemId)

Specified by:

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

prevItemId

public K prevItemId(K itemId)

Specified by:

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

isFirstId

public boolean isFirstId(K itemId)

Specified by:

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

isLastId

public boolean isLastId(K itemId)

Specified by:

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

addItem

public void addItem(T item)

Description copied from interface: CollectionDatasource

Add an item to the collection. The datasource becomes modified.

Specified by:

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

addItemFirst

public void addItemFirst(T item)

Description copied from interface: CollectionDatasource.Ordered

Add an item to the collection to the first position. The datasource becomes modified.

Specified by:

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

removeItem

public void removeItem(T item)

Description copied from interface: CollectionDatasource

Remove an item from the collection. The datasource becomes modified.

Specified by:

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

includeItem

public void includeItem(T item)

Description copied from interface: CollectionDatasource

Include an item into the collection. The datasource "modified" state doesn't change.

Specified by:

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

includeItemFirst

public void includeItemFirst(T item)

Description copied from interface: CollectionDatasource.Ordered

Include an item into the collection to the first position. The datasource "modified" state doesn't change.

Specified by:

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

excludeItem

public void excludeItem(T item)

Description copied from interface: CollectionDatasource

Exclude an item from the collection. The datasource "modified" state doesn't change.

Specified by:

excludeItem in interface CollectionDatasource<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>

revert

public void revert()

Description copied from interface: CollectionDatasource

Revert the datasource to its initial state before data modification.

Specified by:

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

modifyItem

public void modifyItem(T item)

Description copied from interface: CollectionDatasource

Update an item in the collection if it is already there. The datasource becomes modified.

Specified by:

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

updateItem

public void updateItem(T item)

Description copied from interface: CollectionDatasource

Update an item in the collection if it is already there. Does not affect the "modified" state.

Specified by:

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

containsItem

public boolean containsItem(K itemId)

Specified by:

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

Returns:

true if the underlying collection contains an item with the specified ID

committed

public void committed(java.util.Set<Entity> entities)

Description copied from interface: DatasourceImplementation

Invoked after commit.

Specified by:

committed in interface DatasourceImplementation<T extends Entity<K>>

Overrides:

committed in class DatasourceImpl<T extends Entity<K>>

Parameters:

entities - committed entities returned from middleware

getCompiledLoadContext

public LoadContext getCompiledLoadContext()

Specified by:

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

Overrides:

getCompiledLoadContext in class AbstractCollectionDatasource<T extends Entity<K>,K>

Returns:

load context that can be used to load the same data as contained in the datasource. Can be null.

aggregate

public java.util.Map<AggregationInfo,java.lang.String> aggregate(AggregationInfo[] aggregationInfos,
                                                                 java.util.Collection itemIds)

Description copied from interface: CollectionDatasource.Aggregatable

Perform aggregation

Specified by:

aggregate in interface CollectionDatasource.Aggregatable<T extends Entity<K>,K>

isSuspended

public boolean isSuspended()

Specified by:

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

setSuspended

public void setSuspended(boolean suspended)

Specified by:

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

getFirstResult

public int getFirstResult()

Specified by:

getFirstResult in interface CollectionDatasource.SupportsPaging<T extends Entity<K>,K>

setFirstResult

public void setFirstResult(int startPosition)

Specified by:

setFirstResult in interface CollectionDatasource.SupportsPaging<T extends Entity<K>,K>

pinQuery

public void pinQuery()

Specified by:

pinQuery in interface CollectionDatasource.SupportsApplyToSelected<T extends Entity<K>,K>

unpinLastQuery

public void unpinLastQuery()

Specified by:

unpinLastQuery in interface CollectionDatasource.SupportsApplyToSelected<T extends Entity<K>,K>

unpinAllQuery

public void unpinAllQuery()

Specified by:

unpinAllQuery in interface CollectionDatasource.SupportsApplyToSelected<T extends Entity<K>,K>