com.haulmont.cuba.gui.data.impl

Class CustomValueCollectionDatasource

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<io.jmix.core.entity.KeyValueEntity,java.lang.Object>

com.haulmont.cuba.gui.data.impl.ValueCollectionDatasourceImpl

com.haulmont.cuba.gui.data.impl.CustomValueCollectionDatasource

All Implemented Interfaces:

CollectionDatasource<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.Aggregatable<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.Indexed<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.Ordered<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.Sortable<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.SupportsApplyToSelected<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.SupportsPaging<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.SupportsRefreshMode<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.SupportsSortDelegate<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, CollectionDatasource.Suspendable<io.jmix.core.entity.KeyValueEntity,java.lang.Object>, Datasource<io.jmix.core.entity.KeyValueEntity>, DatasourceImplementation<io.jmix.core.entity.KeyValueEntity>, ValueDatasource

Deprecated.

@Deprecated
public abstract class CustomValueCollectionDatasource
extends ValueCollectionDatasourceImpl

Base class for custom implementations of ValueDatasource containing a plain collection.

• In a subclass, implement the getEntities(Map) method and return a collection of KeyValueEntity from it.
• Register your subclass in the datasourceClass attribute of the datasource XML element.

See Also:

CustomValueGroupDatasource, CustomValueHierarchicalDatasource

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.Sortable

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

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>

Field Summary

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

delegate

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
CustomValueCollectionDatasource() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Collection<io.jmix.core.entity.KeyValueEntity>	getEntities(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Callback method to be implemented in subclasses.
protected void	loadData(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Load data from middleware into CollectionDatasourceImpl.data field.

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

addItem, addProperty, addProperty, addProperty, includeItem, setIdName, setStoreName, setup

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

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, includeItemFirst, incrementQueryKey, indexOfId, initAggregatableDelegate, internalAddItem, internalIncludeItem, isFirstId, isLastId, isSuspended, lastItemId, 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, 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.impl.ValueDatasource

getMetaClass

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

addCollectionChangeListener, getItemNN, getLastRefreshParameters, getMaxResults, getQuery, getQueryFilter, getRefreshOnComponentValueChange, isCacheable, isSoftDeletion, mute, removeCollectionChangeListener, resumeListeners, setCacheable, setMaxResults, setQuery, setQuery, setQueryFilter, setRefreshOnComponentValueChange, setSoftDeletion, suspendListeners, unmute

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, removeItemChangeListener, removeItemPropertyChangeListener, removeStateChangeListener, setAllowCommit, setItem, setLoadDynamicAttributes

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

CustomValueCollectionDatasource

public CustomValueCollectionDatasource()

Deprecated.

Method Detail

getEntities

protected abstract java.util.Collection<io.jmix.core.entity.KeyValueEntity> getEntities(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated.

Callback method to be implemented in subclasses.

Parameters:

params - datasource parameters, as described in CollectionDatasource.refresh(Map)

Returns:

collection of entities to populate the datasource

loadData

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

Deprecated.

Description copied from class: CollectionDatasourceImpl

Load data from middleware into CollectionDatasourceImpl.data field.

In case of error sets AbstractCollectionDatasource.dataLoadError field to the exception object.

Overrides:

loadData in class ValueCollectionDatasourceImpl

Parameters:

params - datasource parameters, as described in CollectionDatasource.refresh(Map)