CollectionDatasource (CUBA 6.8 API)

Type Parameters:

T - type of entity

K - type of entity ID

All Superinterfaces:

Datasource<T>

All Known Subinterfaces:

CollectionDatasource.Aggregatable<T,K>, CollectionDatasource.Indexed<T,K>, CollectionDatasource.Lazy<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>, GroupDatasource<T,K>, HierarchicalDatasource<T,K>, TreeTableDatasource<T,K>

All Known Implementing Classes:

AbstractCollectionDatasource, AbstractTreeDatasource, AbstractTreeTableDatasource, AppPropertiesDatasource, BasicPermissionTreeDatasource, CollectionDatasourceImpl, CollectionPropertyDatasourceImpl, ConditionDescriptorsDs, ConditionsDs, CustomCollectionDatasource, CustomGroupDatasource, CustomHierarchicalDatasource, CustomValueCollectionDatasource, CustomValueGroupDatasource, CustomValueHierarchicalDatasource, DiffTreeDatasource, EntityParamsDatasource, EntityPermissionTargetsDatasource, EntitySnapshotsDatasource, GroupDatasourceImpl, GroupPropertyDatasourceImpl, HierarchicalDatasourceImpl, HierarchicalPropertyDatasourceImpl, JmxInstancesDatasource, ManagedBeanAttributeDatasource, ManagedBeanInfoDatasource, MultiplePermissionTargetsDatasource, RestorablePermissionDatasource, ScreenHistoryDatasource, ScreenPermissionTreeDatasource, ScreenProfilerDatasourse, SpecificPermissionTreeDatasource, StatisticsDatasource, ThreadsDatasource, UiPermissionsDatasource, UserSessionsDatasource, ValueCollectionDatasourceImpl, ValueGroupDatasourceImpl, ValueHierarchicalDatasourceImpl
```
public interface CollectionDatasource<T extends Entity<K>,K>
extends Datasource<T>
```
Datasource containing a collection of entity instances.

See Also:

setQuery(String)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CollectionDatasource.Aggregatable<T extends Entity<K>,K>` CollectionDatasource which supports data aggregation.
`static class`	`CollectionDatasource.CollectionChangeEvent<T extends Entity<K>,K>`
`static interface`	`CollectionDatasource.CollectionChangeListener<T extends Entity<K>,K>`
`static interface`	`CollectionDatasource.Indexed<T extends Entity<K>,K>`
`static interface`	`CollectionDatasource.Lazy<T extends Entity<K>,K>` CollectionDatasource with lazy loading.
`static class`	`CollectionDatasource.Operation` Operation which caused the datasource change.
`static interface`	`CollectionDatasource.Ordered<T extends Entity<K>,K>` CollectionDatasource which underlying collection is ordered.
`static class`	`CollectionDatasource.RefreshMode` Mode of loading data from database: `CollectionDatasource.RefreshMode.ALWAYS`, `CollectionDatasource.RefreshMode.NEVER`
`static interface`	`CollectionDatasource.Sortable<T extends Entity<K>,K>` Ordered CollectionDatasource supporting order change.
`static interface`	`CollectionDatasource.SupportsApplyToSelected<T extends Entity<K>,K>` CollectionDatasource that supports applying filter to previously selected data.
`static interface`	`CollectionDatasource.SupportsPaging<T extends Entity<K>,K>` CollectionDatasource that supports counting records in database and loading by pages.
`static interface`	`CollectionDatasource.SupportsRefreshMode<T extends Entity<K>,K>`
`static interface`	`CollectionDatasource.Suspendable<T extends Entity<K>,K>` CollectionDatasource that supports deferred refresh.

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCollectionChangeListener(CollectionDatasource.CollectionChangeListener<T,K> listener)`
`void`	`addItem(T item)` Add an item to the collection.
`void`	`clear()` Clear the underlying collection.
`boolean`	`containsItem(K itemId)`
`void`	`excludeItem(T item)` Exclude an item from the collection.
`LoadContext`	`getCompiledLoadContext()`
`T`	`getItem(K id)`
`java.util.Collection<K>`	`getItemIds()`
`T`	`getItemNN(K id)`
`java.util.Collection<T>`	`getItems()` In standard implementations this is a wrapper method around `getItemIds()` and `getItem(Object)`.
`java.util.Map<java.lang.String,java.lang.Object>`	`getLastRefreshParameters()` Returns the parameters last used in `refresh(Map)` method or empty map if there was no refresh with parameters
`int`	`getMaxResults()`
`java.lang.String`	`getQuery()`
`QueryFilter`	`getQueryFilter()`
`boolean`	`getRefreshOnComponentValueChange()` Whether to refresh datasource on changing value of a component which it depends on (through `component$` parameter)
`void`	`includeItem(T item)` Include an item into the collection.
`boolean`	`isCacheable()`
`boolean`	`isSoftDeletion()`
`void`	`modifyItem(T item)` Update an item in the collection if it is already there.
`void`	`refresh(java.util.Map<java.lang.String,java.lang.Object> parameters)` Refresh datasource passing specified parameters to the query.
`void`	`removeCollectionChangeListener(CollectionDatasource.CollectionChangeListener<T,K> listener)`
`void`	`removeItem(T item)` Remove an item from the collection.
`void`	`resumeListeners()` Resume invocation of `collectionChanged` method of registered `CollectionDatasource.CollectionChangeListener`s after calling `suspendListeners()`.
`void`	`revert()` Revert the datasource to its initial state before data modification.
`void`	`setCacheable(boolean cacheable)` Indicates that the datasource query results should be cached in the middleware query cache.
`void`	`setMaxResults(int maxResults)` Set max number of rows.
`void`	`setQuery(java.lang.String query)` Set query string which is used to load data.
`void`	`setQuery(java.lang.String query, QueryFilter filter)` Set query string and associated filter which is used to load data.
`void`	`setQueryFilter(QueryFilter filter)` Set query filter which is used to load data.
`void`	`setRefreshOnComponentValueChange(boolean refresh)` Whether to refresh datasource on changing value of a component which it depends on (through `component$` parameter)
`void`	`setSoftDeletion(boolean softDeletion)` Switch on/off Soft Deletion.
`int`	`size()`
`void`	`suspendListeners()` Suspend invocation of `collectionChanged` method of registered `CollectionDatasource.CollectionChangeListener`s.
`void`	`updateItem(T item)` Update an item in the collection if it is already there.

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
  - getItem
```
@Nullable
T getItem(K id)
```
    Returns:
    
    item by ID, can be null
  - getItemNN
```
T getItemNN(K id)
```
    Returns:
    
    item by ID. Throws exception if not found.
  - getItemIds
```
java.util.Collection<K> getItemIds()
```
    Returns:
    
    all item IDs
  - getItems
```
java.util.Collection<T> getItems()
```
    In standard implementations this is a wrapper method around getItemIds() and getItem(Object). Use it only if you really need the collection of items. Otherwise use getItemIds() or size() directly.
    
    Returns:
    
    collection of all items
  - size
```
int size()
```
    Returns:
    
    size of the underlying collection.
  - addItem
```
void addItem(T item)
```
    Add an item to the collection. The datasource becomes modified.
  - removeItem
```
void removeItem(T item)
```
    Remove an item from the collection. The datasource becomes modified.
  - excludeItem
```
void excludeItem(T item)
```
    Exclude an item from the collection. The datasource "modified" state doesn't change.
  - includeItem
```
void includeItem(T item)
```
    Include an item into the collection. The datasource "modified" state doesn't change.
  - clear
```
void clear()
```
    Clear the underlying collection. The datasource "modified" state doesn't change.
  - revert
```
void revert()
```
    Revert the datasource to its initial state before data modification.
  - modifyItem
```
void modifyItem(T item)
```
    Update an item in the collection if it is already there. The datasource becomes modified.
  - updateItem
```
void updateItem(T item)
```
    Update an item in the collection if it is already there. Does not affect the "modified" state.
  - suspendListeners
```
void suspendListeners()
```
    Suspend invocation of collectionChanged method of registered CollectionDatasource.CollectionChangeListeners. It makes sense in case of massive updates of the datasource by addItem(com.haulmont.cuba.core.entity.Entity) or similar methods. After that, collectionChanged will be invoked once on resumeListeners() call.
    Usage example:
```
 ds.suspendListeners();
       try {
           for (Object item : items) {
               ds.addItem(item);
           }
       } finally {
           ds.resumeListeners();
       }
 
```
  - resumeListeners
```
void resumeListeners()
```
    Resume invocation of collectionChanged method of registered CollectionDatasource.CollectionChangeListeners after calling suspendListeners(). It will call collectionChanged just once, doesn't matter how many updates were issued since the previous suspendListeners() call.
    This method should be called in finally section.
  - isSoftDeletion
```
boolean isSoftDeletion()
```
    Returns:
    
    true if this datasource is in Soft Delete mode.
  - setSoftDeletion
```
void setSoftDeletion(boolean softDeletion)
```
    Switch on/off Soft Deletion.
  - isCacheable
```
boolean isCacheable()
```
    Returns:
    
    true if this datasource results is cacheable.
  - setCacheable
```
void setCacheable(boolean cacheable)
```
    Indicates that the datasource query results should be cached in the middleware query cache.
  - containsItem
```
boolean containsItem(K itemId)
```
    Returns:
    
    true if the underlying collection contains an item with the specified ID
  - getQuery
```
java.lang.String getQuery()
```
    Returns:
    
    Query string which is used to load data. Implementation-dependent (JPQL, Groovy, etc.). Can be null.
  - getCompiledLoadContext
```
LoadContext getCompiledLoadContext()
```
    Returns:
    
    load context that can be used to load the same data as contained in the datasource. Can be null.
  - getQueryFilter
```
QueryFilter getQueryFilter()
```
    Returns:
    
    Current query filter. Can be null.
  - setQuery
```
void setQuery(java.lang.String query)
```
    Set query string which is used to load data. Implementation-dependent (JPQL, Groovy, etc.).
    The query may use the following parameters, distinguished by prefix:
    - ds$ - current item in the specified datasource
    - component$ - value of the specified UI component
    - param$ - value of parameter passed to the window when opening it
    - session$ - userId represents current or substituted user ID, userLogin represents current or substituted user login in lower case, any other string represents a user session attribute with this name
    - custom$ - value of parameter passed to the refresh(java.util.Map) method
  - setQuery
```
void setQuery(java.lang.String query,
              QueryFilter filter)
```
    Set query string and associated filter which is used to load data. Query is implementation-dependent (JPQL, Groovy, etc.).
    See setQuery(String) for the list of supported query parameters.
  - setQueryFilter
```
void setQueryFilter(QueryFilter filter)
```
    Set query filter which is used to load data. Query remains the same. Query is implementation-dependent (JPQL, Groovy, etc.).
    See setQuery(String) for the list of supported query parameters.
  - getMaxResults
```
int getMaxResults()
```
    Returns:
    
    Max number of rows. 0 in case of no limits.
  - setMaxResults
```
void setMaxResults(int maxResults)
```
    Set max number of rows. 0 in case of no limits.
    Implementations may or may not take this parameter into account.
  - refresh
```
void refresh(java.util.Map<java.lang.String,java.lang.Object> parameters)
```
    Refresh datasource passing specified parameters to the query.
    These parameters may be referenced in the query text by "custom$" prefix.
    
    Parameters:
    
    parameters - parameters map
  - getLastRefreshParameters
```
java.util.Map<java.lang.String,java.lang.Object> getLastRefreshParameters()
```
    Returns the parameters last used in refresh(Map) method or empty map if there was no refresh with parameters
  - getRefreshOnComponentValueChange
```
boolean getRefreshOnComponentValueChange()
```
    Whether to refresh datasource on changing value of a component which it depends on (through component$ parameter)
  - setRefreshOnComponentValueChange
```
void setRefreshOnComponentValueChange(boolean refresh)
```
    Whether to refresh datasource on changing value of a component which it depends on (through component$ parameter)
  - addCollectionChangeListener
```
void addCollectionChangeListener(CollectionDatasource.CollectionChangeListener<T,K> listener)
```
  - removeCollectionChangeListener
```
void removeCollectionChangeListener(CollectionDatasource.CollectionChangeListener<T,K> listener)
```

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

Nested Class Summary

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

Method Summary

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

Method Detail

getItem

getItemNN

getItemIds

getItems

size

addItem

removeItem

excludeItem

includeItem

clear

revert

modifyItem

updateItem

suspendListeners

resumeListeners

isSoftDeletion

setSoftDeletion

isCacheable

setCacheable

containsItem

getQuery

getCompiledLoadContext

getQueryFilter

setQuery

setQuery

setQueryFilter

getMaxResults

setMaxResults

refresh

getLastRefreshParameters

getRefreshOnComponentValueChange

setRefreshOnComponentValueChange

addCollectionChangeListener

removeCollectionChangeListener