com.haulmont.cuba.gui.data.impl

Class ValueCollectionDatasourceImpl

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

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

Direct Known Subclasses:

CustomValueCollectionDatasource

public class ValueCollectionDatasourceImpl
extends CollectionDatasourceImpl<io.jmix.core.entity.KeyValueEntity,java.lang.Object>
implements ValueDatasource

CollectionDatasource that supports KeyValueEntity.

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

Modifier and Type	Field and Description
protected ValueDatasourceDelegate	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
ValueCollectionDatasourceImpl()

Method Summary

Modifier and Type	Method and Description
void	addItem(io.jmix.core.entity.KeyValueEntity item) Add an item to the collection.
ValueCollectionDatasourceImpl	addProperty(java.lang.String name) Adds a string property to the meta-class of this datasource.
ValueCollectionDatasourceImpl	addProperty(java.lang.String name, java.lang.Class aClass) Adds a property of the given Java class to the meta-class of this datasource.
ValueCollectionDatasourceImpl	addProperty(java.lang.String name, io.jmix.core.metamodel.datatype.Datatype datatype) Adds a property of the given datatype to the meta-class of this datasource.
void	includeItem(io.jmix.core.entity.KeyValueEntity item) Include an item into the collection.
protected void	loadData(java.util.Map<java.lang.String,java.lang.Object> params) Load data from middleware into CollectionDatasourceImpl.data field.
ValueCollectionDatasourceImpl	setIdName(java.lang.String name) Sets the name of a property that represents the entity id.
void	setStoreName(java.lang.String storeName)
void	setup(DsContext dsContext, DataSupplier dataSupplier, java.lang.String id, io.jmix.core.metamodel.model.MetaClass metaClass, io.jmix.core.FetchPlan view) Setup the datasource right after creation.

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

Field Detail

delegate

protected final ValueDatasourceDelegate delegate

Constructor Detail

ValueCollectionDatasourceImpl

public ValueCollectionDatasourceImpl()

Method Detail

setup

public void setup(DsContext dsContext,
                  DataSupplier dataSupplier,
                  java.lang.String id,
                  io.jmix.core.metamodel.model.MetaClass metaClass,
                  @Nullable
                  io.jmix.core.FetchPlan view)

Description copied from interface: Datasource

Setup the datasource right after creation. This method should be called only once.

Specified by:

setup in interface Datasource<io.jmix.core.entity.KeyValueEntity>

Overrides:

setup in class DatasourceImpl<io.jmix.core.entity.KeyValueEntity>

Parameters:

dsContext - DsContext instance

dataSupplier - DataSupplier instance

id - datasource ID

metaClass - MetaClass of an entity that will be stored in this datasource

view - a view that will be used to load entities form DB, can be null

setIdName

public ValueCollectionDatasourceImpl setIdName(java.lang.String name)

Description copied from interface: ValueDatasource

Sets the name of a property that represents the entity id.

Specified by:

setIdName in interface ValueDatasource

addProperty

public ValueCollectionDatasourceImpl addProperty(java.lang.String name)

Description copied from interface: ValueDatasource

Adds a string property to the meta-class of this datasource.

Specified by:

addProperty in interface ValueDatasource

Returns:

this instance for chaining

addProperty

public ValueCollectionDatasourceImpl addProperty(java.lang.String name,
                                                 java.lang.Class aClass)

Description copied from interface: ValueDatasource

Adds a property of the given Java class to the meta-class of this datasource. The Java class can be an entity or a datatype.

Specified by:

addProperty in interface ValueDatasource

Returns:

this instance for chaining

addProperty

public ValueCollectionDatasourceImpl addProperty(java.lang.String name,
                                                 io.jmix.core.metamodel.datatype.Datatype datatype)

Description copied from interface: ValueDatasource

Adds a property of the given datatype to the meta-class of this datasource.

Specified by:

addProperty in interface ValueDatasource

Returns:

this instance for chaining

loadData

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

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

Parameters:

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

includeItem

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

Overrides:

includeItem in class CollectionDatasourceImpl<io.jmix.core.entity.KeyValueEntity,java.lang.Object>

addItem

public void addItem(io.jmix.core.entity.KeyValueEntity item)

Description copied from interface: CollectionDatasource

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

Specified by:

addItem in interface CollectionDatasource<io.jmix.core.entity.KeyValueEntity,java.lang.Object>

Overrides:

addItem in class CollectionDatasourceImpl<io.jmix.core.entity.KeyValueEntity,java.lang.Object>

setStoreName

public void setStoreName(java.lang.String storeName)