Package io.jmix.flowui.model.impl

Class CollectionContainerImpl<E>

java.lang.Object

io.jmix.flowui.model.impl.InstanceContainerImpl<E>

io.jmix.flowui.model.impl.CollectionContainerImpl<E>

Type Parameters:

E - the type of entity held in the container

All Implemented Interfaces:

CollectionContainer<E>, HasLoader, ItemPropertyChangeNotifier, InstanceContainer<E>

Direct Known Subclasses:

CollectionPropertyContainerImpl, KeyValueCollectionContainerImpl

public class CollectionContainerImpl<E>
extends InstanceContainerImpl<E>
implements CollectionContainer<E>

Implementation of the CollectionContainer interface, which manages a collection of entities and provides functionality for modifying and interacting with the collection.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.model.CollectionContainer

CollectionContainer.CollectionChangeEvent<T>, CollectionContainer.UnmuteEventsMode

Nested classes/interfaces inherited from interface io.jmix.flowui.model.InstanceContainer

InstanceContainer.ItemChangeEvent<T>, InstanceContainer.ItemPropertyChangeEvent<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<E>	collection
protected Map<IndexKey,Integer>	idMap
protected MetadataTools	metadataTools
protected Sorter	sorter

Fields inherited from class io.jmix.flowui.model.impl.InstanceContainerImpl

entityMetaClass, events, fetchPlan, item, listener, listenersEnabled, loader, metadata

Constructor Summary

Constructors

Constructor	Description
CollectionContainerImpl(MetaClass metaClass)

Method Summary

Modifier and Type	Method	Description
Subscription	addCollectionChangeListener(Consumer<CollectionContainer.CollectionChangeEvent<E>> listener)	Adds listener to CollectionContainer.CollectionChangeEvent.
protected void	addToCollection(E entity)
protected void	attachListener(Collection<E> entities)
protected void	buildIdMap()
protected void	clearItemIfNotExists()
boolean	containsItem(Object entityOrId)	Returns true if the given entity exists in the container.
protected void	detachListener(Collection<E> entities)
protected void	fireCollectionChanged(CollectionChangeType type, Collection<? extends E> changes)
E	getItem(Object entityId)	Returns entity by its id.
int	getItemIndex(Object entityOrId)	Returns the index in the items list of the given entity or -1 if there is no such entity.
E	getItemOrNull(Object entityId)	Returns entity by its id or null if the container doesn't have an entity with the given id.
List<E>	getItems()	Returns immutable list of contained entities.
List<E>	getMutableItems()	Returns mutable list of contained entities.
Sorter	getSorter()	Returns sorter object currently set for the container.
void	itemPropertyChanged(EntityPropertyChangeEvent e)	Handles changes to a specific property of an item.
protected void	replaceInCollection(int idx, E entity)
void	replaceItem(E entity)	If the item with the same id exists in the container, it is replaced with the given instance.
void	setItem(E item)	Sets the given entity instance to the container.
void	setItems(Collection<E> entities)	Sets a collection of entities to the container.
void	setSorter(Sorter sorter)	Sets sorter object.
String	toString()
void	unmute(CollectionContainer.UnmuteEventsMode mode)	Enables all event listeners.

Methods inherited from class io.jmix.flowui.model.impl.InstanceContainerImpl

addItemChangeListener, addItemPropertyChangeListener, attachListener, detachListener, fireItemChanged, getEntityMetaClass, getFetchPlan, getItem, getItemOrNull, getLoader, mute, setFetchPlan, setLoader, setMetadata, unmute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jmix.flowui.model.InstanceContainer

addItemChangeListener, addItemPropertyChangeListener, getEntityMetaClass, getFetchPlan, getItem, getItemOrNull, mute, setFetchPlan, unmute

Field Details

metadataTools

@Autowired
protected MetadataTools metadataTools

collection

protected List<E> collection

idMap

protected Map<IndexKey,Integer> idMap

sorter

protected Sorter sorter

Constructor Details

CollectionContainerImpl

public CollectionContainerImpl(MetaClass metaClass)

Method Details

setItem

public void setItem(@Nullable
 E item)

Description copied from interface: InstanceContainer

Sets the given entity instance to the container.

Specified by:

setItem in interface InstanceContainer<E>

Overrides:

setItem in class InstanceContainerImpl<E>

getItems

public List<E> getItems()

Description copied from interface: CollectionContainer

Returns immutable list of contained entities.

Specified by:

getItems in interface CollectionContainer<E>

getMutableItems

public List<E> getMutableItems()

Description copied from interface: CollectionContainer

Returns mutable list of contained entities. Changes in the list produce CollectionContainer.CollectionChangeEvent.

Specified by:

getMutableItems in interface CollectionContainer<E>

setItems

public void setItems(@Nullable
 Collection<E> entities)

Description copied from interface: CollectionContainer

Sets a collection of entities to the container.

Specified by:

setItems in interface CollectionContainer<E>

getItem

public E getItem(Object entityId)

Description copied from interface: CollectionContainer

Returns entity by its id.

Specified by:

getItem in interface CollectionContainer<E>

getItemOrNull

@Nullable
public E getItemOrNull(Object entityId)

Description copied from interface: CollectionContainer

Returns entity by its id or null if the container doesn't have an entity with the given id.

Specified by:

getItemOrNull in interface CollectionContainer<E>

getItemIndex

public int getItemIndex(Object entityOrId)

Description copied from interface: CollectionContainer

Returns the index in the items list of the given entity or -1 if there is no such entity.

Specified by:

getItemIndex in interface CollectionContainer<E>

Parameters:

entityOrId - entity instance or its id

containsItem

public boolean containsItem(Object entityOrId)

Description copied from interface: CollectionContainer

Returns true if the given entity exists in the container.

Specified by:

containsItem in interface CollectionContainer<E>

Parameters:

entityOrId - entity instance or its id

replaceItem

public void replaceItem(E entity)

Description copied from interface: CollectionContainer

If the item with the same id exists in the container, it is replaced with the given instance. If not, the given instance is added to the items list.

Sends CollectionContainer.CollectionChangeEvent of the SET_ITEM or ADD_ITEMS type.

Specified by:

replaceItem in interface CollectionContainer<E>

replaceInCollection

protected void replaceInCollection(int idx,
 E entity)

addToCollection

protected void addToCollection(E entity)

addCollectionChangeListener

public Subscription addCollectionChangeListener(Consumer<CollectionContainer.CollectionChangeEvent<E>> listener)

Description copied from interface: CollectionContainer

Adds listener to CollectionContainer.CollectionChangeEvent.

Specified by:

addCollectionChangeListener in interface CollectionContainer<E>

getSorter

@Nullable
public Sorter getSorter()

Description copied from interface: CollectionContainer

Returns sorter object currently set for the container.

Specified by:

getSorter in interface CollectionContainer<E>

setSorter

public void setSorter(Sorter sorter)

Description copied from interface: CollectionContainer

Sets sorter object.

Specified by:

setSorter in interface CollectionContainer<E>

unmute

public void unmute(CollectionContainer.UnmuteEventsMode mode)

Description copied from interface: CollectionContainer

Enables all event listeners. Events fired on this call depend on the passed mode.

Specified by:

unmute in interface CollectionContainer<E>

Parameters:

mode - mode

itemPropertyChanged

public void itemPropertyChanged(EntityPropertyChangeEvent e)

Description copied from interface: ItemPropertyChangeNotifier

Handles changes to a specific property of an item. This method is called whenever a property of an item changes, providing details about the item, the property, and its old and new values.

Specified by:

itemPropertyChanged in interface ItemPropertyChangeNotifier

Overrides:

itemPropertyChanged in class InstanceContainerImpl<E>

Parameters:

e - an EntityPropertyChangeEvent object containing information about the changed property

fireCollectionChanged

protected void fireCollectionChanged(CollectionChangeType type,
 Collection<? extends E> changes)

attachListener

protected void attachListener(Collection<E> entities)

detachListener

protected void detachListener(Collection<E> entities)

buildIdMap

protected void buildIdMap()

clearItemIfNotExists

protected void clearItemIfNotExists()

toString

public String toString()

Overrides:

toString in class InstanceContainerImpl<E>