com.haulmont.cuba.gui.data.impl

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

Type Parameters:

T - type of entity

K - type of entity ID

All Implemented Interfaces:

CollectionDatasource<T,K>, CollectionDatasource.SupportsRefreshMode<T,K>, Datasource<T>, DatasourceImplementation<T>

Direct Known Subclasses:

CollectionDatasourceImpl

public abstract class AbstractCollectionDatasource<T extends Entity<K>,K>
extends DatasourceImpl<T>
implements CollectionDatasource<T,K>, CollectionDatasource.SupportsRefreshMode<T,K>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	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 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.SortDelegate<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.SupportsSortDelegate<T extends Entity<K>,K>, CollectionDatasource.Suspendable<T extends Entity<K>,K>, CollectionDatasource.UnmuteEventsMode

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>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cacheable
protected AbstractCollectionDatasource.ComponentValueListener	componentValueListener
protected java.lang.Throwable	dataLoadError
protected QueryFilter	filter
protected boolean	listenersSuspended
protected int	maxResults
protected java.lang.String	query
protected ParameterInfo[]	queryParameters
protected CollectionDatasource.RefreshMode	refreshMode
protected boolean	refreshOnComponentValueChange
protected java.util.Map<java.lang.String,java.lang.Object>	savedParameters
protected boolean	softDeletion
protected CollectionDatasource.Sortable.SortInfo<MetaPropertyPath>[]	sortInfos
protected java.util.LinkedList<CollectionDatasource.CollectionChangeEvent<T,K>>	suspendedEvents
protected UserSession	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
AbstractCollectionDatasource()

Method Summary

Modifier and Type	Method and Description
void	addCollectionChangeListener(CollectionDatasource.CollectionChangeListener<? super T,K> listener)
protected void	checkDataLoadError()
void	commit() Performs commit
protected DataLoadContextQuery	createDataQuery(DataLoadContext context, java.util.Map<java.lang.String,java.lang.Object> params)
protected java.util.Comparator<T>	createEntityComparator()
protected void	fireCollectionChanged(CollectionDatasource.Operation operation, java.util.List<T> items)
LoadContext	getCompiledLoadContext()
int	getCount() Return number of rows for the current query set in the datasource.
T	getItemNN(K id)
protected java.lang.String	getJPQLQuery(java.util.Map<java.lang.String,java.lang.Object> parameterValues)
java.util.Map<java.lang.String,java.lang.Object>	getLastRefreshParameters() Returns the parameters last used in CollectionDatasource.refresh(Map) method or empty map if there was no refresh with parameters
protected java.lang.String	getLoggingTag(java.lang.String prefix)
int	getMaxResults()
java.lang.String	getQuery()
QueryFilter	getQueryFilter()
protected java.util.Map<java.lang.String,java.lang.Object>	getQueryParameters(java.util.Map<java.lang.String,java.lang.Object> params)
CollectionDatasource.RefreshMode	getRefreshMode()
boolean	getRefreshOnComponentValueChange() Whether to refresh datasource on changing value of a component which it depends on (through component$ parameter)
protected java.util.Map<java.lang.String,java.lang.Object>	getTemplateParams(java.util.Map<java.lang.String,java.lang.Object> customParams)
boolean	isCacheable()
boolean	isSoftDeletion()
protected java.lang.String	makeCaseInsensitive(java.lang.String value)
void	mute() Disables all event listeners on datasource data change.
protected void	prepareLoadContext(LoadContext<?> context)
void	removeCollectionChangeListener(CollectionDatasource.CollectionChangeListener<? super T,K> listener)
void	resumeListeners() Resume invocation of collectionChanged method of registered CollectionDatasource.CollectionChangeListeners after calling CollectionDatasource.suspendListeners().
void	setCacheable(boolean cacheable) Indicates that the datasource query results should be cached in the middleware query cache.
void	setItem(T item) Set current entity in the datasource.
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	setRefreshMode(CollectionDatasource.RefreshMode refreshMode)
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.
protected void	setSortDirection(LoadContext.Query q)
void	suspendListeners() Suspend invocation of collectionChanged method of registered CollectionDatasource.CollectionChangeListeners.
void	unmute(CollectionDatasource.UnmuteEventsMode mode) Enables all event listeners.

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

__setItem, committed, getDataSupplier, getDsContext, getItem, getItemIfValid, getMetaClass, getState, getView, initialized, invalidate, refresh, 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

addItem, clear, containsItem, excludeItem, getItem, getItemIds, getItems, includeItem, modifyItem, refresh, removeItem, revert, size, updateItem

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

addItemChangeListener, addItemPropertyChangeListener, addStateChangeListener, getCommitMode, getDataSupplier, getDsContext, getId, getItem, getItemIfValid, getLoadDynamicAttributes, getMetaClass, getState, getView, invalidate, isAllowCommit, isModified, refresh, removeItemChangeListener, removeItemPropertyChangeListener, removeStateChangeListener, setAllowCommit, setLoadDynamicAttributes, setup

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

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

Field Detail

query

protected java.lang.String query

filter

protected QueryFilter filter

maxResults

protected int maxResults

queryParameters

protected ParameterInfo[] queryParameters

softDeletion

protected boolean softDeletion

cacheable

protected boolean cacheable

componentValueListener

protected AbstractCollectionDatasource.ComponentValueListener componentValueListener

refreshOnComponentValueChange

protected boolean refreshOnComponentValueChange

sortInfos

protected CollectionDatasource.Sortable.SortInfo<MetaPropertyPath>[] sortInfos

savedParameters

protected java.util.Map<java.lang.String,java.lang.Object> savedParameters

dataLoadError

protected java.lang.Throwable dataLoadError

listenersSuspended

protected boolean listenersSuspended

suspendedEvents

protected final java.util.LinkedList<CollectionDatasource.CollectionChangeEvent<T extends Entity<K>,K>> suspendedEvents

refreshMode

protected CollectionDatasource.RefreshMode refreshMode

userSession

protected UserSession userSession

Constructor Detail

AbstractCollectionDatasource

public AbstractCollectionDatasource()

Method Detail

getItemNN

public T getItemNN(K id)

Specified by:

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

Returns:

item by ID. Throws exception if not found.

setItem

public void setItem(T item)

Description copied from interface: Datasource

Set current entity in the datasource.

Specified by:

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

Overrides:

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

Parameters:

item - entity instance

getQuery

public java.lang.String getQuery()

Specified by:

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

Returns:

Query string which is used to load data. Implementation-dependent (JPQL, Groovy, etc.). Can be null.

getCompiledLoadContext

public LoadContext getCompiledLoadContext()
                                   throws java.lang.UnsupportedOperationException

Specified by:

getCompiledLoadContext in interface CollectionDatasource<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.

Throws:

java.lang.UnsupportedOperationException

getQueryFilter

public QueryFilter getQueryFilter()

Specified by:

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

Returns:

Current query filter. Can be null.

setQuery

public void setQuery(java.lang.String query)

Description copied from interface: CollectionDatasource

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 CollectionDatasource.refresh(java.util.Map) method

Specified by:

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

setQueryFilter

public void setQueryFilter(QueryFilter filter)

Description copied from interface: CollectionDatasource

Set query filter which is used to load data. Query remains the same. Query is implementation-dependent (JPQL, Groovy, etc.).
See CollectionDatasource.setQuery(String) for the list of supported query parameters.

Specified by:

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

getMaxResults

public int getMaxResults()

Specified by:

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

Returns:

Max number of rows. 0 in case of no limits.

setMaxResults

public void setMaxResults(int maxResults)

Description copied from interface: CollectionDatasource

Set max number of rows. 0 in case of no limits.
Implementations may or may not take this parameter into account.

Specified by:

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

getLastRefreshParameters

public java.util.Map<java.lang.String,java.lang.Object> getLastRefreshParameters()

Description copied from interface: CollectionDatasource

Returns the parameters last used in CollectionDatasource.refresh(Map) method or empty map if there was no refresh with parameters

Specified by:

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

getRefreshOnComponentValueChange

public boolean getRefreshOnComponentValueChange()

Description copied from interface: CollectionDatasource

Whether to refresh datasource on changing value of a component which it depends on (through component$ parameter)

Specified by:

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

setRefreshOnComponentValueChange

public void setRefreshOnComponentValueChange(boolean refresh)

Description copied from interface: CollectionDatasource

Whether to refresh datasource on changing value of a component which it depends on (through component$ parameter)

Specified by:

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

setQuery

public void setQuery(java.lang.String query,
                     QueryFilter filter)

Description copied from interface: CollectionDatasource

Set query string and associated filter which is used to load data. Query is implementation-dependent (JPQL, Groovy, etc.).
See CollectionDatasource.setQuery(String) for the list of supported query parameters.

Specified by:

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

getQueryParameters

protected java.util.Map<java.lang.String,java.lang.Object> getQueryParameters(java.util.Map<java.lang.String,java.lang.Object> params)

makeCaseInsensitive

protected java.lang.String makeCaseInsensitive(java.lang.String value)

getJPQLQuery

protected java.lang.String getJPQLQuery(java.util.Map<java.lang.String,java.lang.Object> parameterValues)

fireCollectionChanged

protected void fireCollectionChanged(CollectionDatasource.Operation operation,
                                     java.util.List<T> items)

getTemplateParams

protected java.util.Map<java.lang.String,java.lang.Object> getTemplateParams(java.util.Map<java.lang.String,java.lang.Object> customParams)

suspendListeners

public void suspendListeners()

Description copied from interface: CollectionDatasource

Suspend invocation of collectionChanged method of registered CollectionDatasource.CollectionChangeListeners. It makes sense in case of massive updates of the datasource by CollectionDatasource.addItem(com.haulmont.cuba.core.entity.Entity) or similar methods. After that, collectionChanged will be invoked once on CollectionDatasource.resumeListeners() call.
Usage example:

 ds.suspendListeners();
 try {
 for (Object item : items) {
 ds.addItem(item);
 }
 } finally {
 ds.resumeListeners();
 }
 

Specified by:

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

resumeListeners

public void resumeListeners()

Description copied from interface: CollectionDatasource

Resume invocation of collectionChanged method of registered CollectionDatasource.CollectionChangeListeners after calling CollectionDatasource.suspendListeners(). It will call collectionChanged just once, doesn't matter how many updates were issued since the previous CollectionDatasource.suspendListeners() call.
This method should be called in finally section.

Specified by:

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

mute

public void mute()

Description copied from interface: CollectionDatasource

Disables all event listeners on datasource data change.
Can be used with CollectionDatasource.unmute(UnmuteEventsMode) for bulk data modification as a performance optimization.

Specified by:

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

unmute

public void unmute(CollectionDatasource.UnmuteEventsMode mode)

Description copied from interface: CollectionDatasource

Enables all event listeners. No events are fired on this call.

Specified by:

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

isSoftDeletion

public boolean isSoftDeletion()

Specified by:

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

Returns:

true if this datasource is in Soft Delete mode.

setSoftDeletion

public void setSoftDeletion(boolean softDeletion)

Description copied from interface: CollectionDatasource

Switch on/off Soft Deletion.

Specified by:

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

isCacheable

public boolean isCacheable()

Specified by:

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

Returns:

true if this datasource results is cacheable.

setCacheable

public void setCacheable(boolean cacheable)

Description copied from interface: CollectionDatasource

Indicates that the datasource query results should be cached in the middleware query cache.

Specified by:

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

commit

public void commit()

Description copied from interface: Datasource

Performs commit

Specified by:

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

Overrides:

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

createEntityComparator

protected java.util.Comparator<T> createEntityComparator()

createDataQuery

protected DataLoadContextQuery createDataQuery(DataLoadContext context,
                                               java.util.Map<java.lang.String,java.lang.Object> params)

getCount

public int getCount()

Return number of rows for the current query set in the datasource.

Returns:

number of rows. In case of error returns 0 and sets dataLoadError field to the exception object

getLoggingTag

protected java.lang.String getLoggingTag(java.lang.String prefix)

prepareLoadContext

protected void prepareLoadContext(LoadContext<?> context)

checkDataLoadError

protected void checkDataLoadError()

setSortDirection

protected void setSortDirection(LoadContext.Query q)

getRefreshMode

public CollectionDatasource.RefreshMode getRefreshMode()

Specified by:

getRefreshMode in interface CollectionDatasource.SupportsRefreshMode<T extends Entity<K>,K>

setRefreshMode

public void setRefreshMode(CollectionDatasource.RefreshMode refreshMode)

Specified by:

setRefreshMode in interface CollectionDatasource.SupportsRefreshMode<T extends Entity<K>,K>

addCollectionChangeListener

public void addCollectionChangeListener(CollectionDatasource.CollectionChangeListener<? super T,K> listener)

Specified by:

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

removeCollectionChangeListener

public void removeCollectionChangeListener(CollectionDatasource.CollectionChangeListener<? super T,K> listener)

Specified by:

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