Package io.jmix.flowui.model.impl

Class InstanceContainerImpl<E>

java.lang.Object

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

Type Parameters:

E - the type of the entity contained in the instance container

All Implemented Interfaces:

HasLoader, ItemPropertyChangeNotifier, InstanceContainer<E>

Direct Known Subclasses:

CollectionContainerImpl, InstancePropertyContainerImpl, KeyValueContainerImpl

public class InstanceContainerImpl<E>
extends Object
implements InstanceContainer<E>, HasLoader, ItemPropertyChangeNotifier

Implementation of the InstanceContainer interface. This class represents a container for a single instance of an entity and provides methods to manage its state, fetch plans, and property change events.

Nested Class Summary

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 MetaClass	entityMetaClass
protected EventHub	events
protected FetchPlan	fetchPlan
protected E	item
protected EntityPropertyChangeListener	listener
protected boolean	listenersEnabled
protected DataLoader	loader
protected Metadata	metadata

Constructor Summary

Constructors

Constructor	Description
InstanceContainerImpl(MetaClass entityMetaClass)

Method Summary

Modifier and Type	Method	Description
Subscription	addItemChangeListener(Consumer<InstanceContainer.ItemChangeEvent<E>> listener)	Adds listener to InstanceContainer.ItemChangeEvents.
Subscription	addItemPropertyChangeListener(Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)	Adds listener to InstanceContainer.ItemPropertyChangeEvents.
protected void	attachListener(Object entity)
protected void	detachListener(Object entity)
protected void	fireItemChanged(E prevItem)
MetaClass	getEntityMetaClass()	Returns the meta-class of entities that can be stored in the container.
FetchPlan	getFetchPlan()	Returns the view which was set by previous call to InstanceContainer.setFetchPlan(FetchPlan).
E	getItem()	Returns the contained entity instance.
E	getItemOrNull()	Returns the contained entity instance or null if there is no entity in the container.
DataLoader	getLoader()	Returns the loader of this container.
void	itemPropertyChanged(EntityPropertyChangeEvent e)	Handles changes to a specific property of an item.
void	mute()	Disables all event listeners on container data change.
void	setFetchPlan(FetchPlan fetchPlan)	Sets the FetchPlan for the instance container.
void	setItem(E item)	Sets the given entity instance to the container.
void	setLoader(DataLoader loader)	Sets the loader for this container.
void	setMetadata(Metadata metadata)
String	toString()
void	unmute()	Enables all event listeners.

Methods inherited from class java.lang.Object

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

Field Details

metadata

protected Metadata metadata

item

protected E item

entityMetaClass

protected MetaClass entityMetaClass

fetchPlan

protected FetchPlan fetchPlan

events

protected EventHub events

listener

protected EntityPropertyChangeListener listener

loader

protected DataLoader loader

listenersEnabled

protected boolean listenersEnabled

Constructor Details

InstanceContainerImpl

public InstanceContainerImpl(MetaClass entityMetaClass)

Method Details

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

getItemOrNull

@Nullable
public E getItemOrNull()

Description copied from interface: InstanceContainer

Returns the contained entity instance or null if there is no entity in the container.

Specified by:

getItemOrNull in interface InstanceContainer<E>

getItem

public E getItem()

Description copied from interface: InstanceContainer

Returns the contained entity instance.

Specified by:

getItem in interface InstanceContainer<E>

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>

getEntityMetaClass

public MetaClass getEntityMetaClass()

Description copied from interface: InstanceContainer

Returns the meta-class of entities that can be stored in the container.

Specified by:

getEntityMetaClass in interface InstanceContainer<E>

getFetchPlan

@Nullable
public FetchPlan getFetchPlan()

Description copied from interface: InstanceContainer

Returns the view which was set by previous call to InstanceContainer.setFetchPlan(FetchPlan). The view is normally used when loading entities for this container.

Specified by:

getFetchPlan in interface InstanceContainer<E>

setFetchPlan

public void setFetchPlan(FetchPlan fetchPlan)

Sets the FetchPlan for the instance container.

Specified by:

setFetchPlan in interface InstanceContainer<E>

Parameters:

fetchPlan - the FetchPlan instance to be set

addItemPropertyChangeListener

public Subscription addItemPropertyChangeListener(Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)

Description copied from interface: InstanceContainer

Adds listener to InstanceContainer.ItemPropertyChangeEvents.

Specified by:

addItemPropertyChangeListener in interface InstanceContainer<E>

addItemChangeListener

public Subscription addItemChangeListener(Consumer<InstanceContainer.ItemChangeEvent<E>> listener)

Description copied from interface: InstanceContainer

Adds listener to InstanceContainer.ItemChangeEvents.

Specified by:

addItemChangeListener in interface InstanceContainer<E>

attachListener

protected void attachListener(Object entity)

detachListener

protected void detachListener(Object entity)

toString

public String toString()

Overrides:

toString in class Object

getLoader

@Nullable
public DataLoader getLoader()

Description copied from interface: HasLoader

Returns the loader of this container.

Specified by:

getLoader in interface HasLoader

setLoader

public void setLoader(DataLoader loader)

Description copied from interface: HasLoader

Sets the loader for this container.

Specified by:

setLoader in interface HasLoader

fireItemChanged

protected void fireItemChanged(@Nullable
 E prevItem)

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

Parameters:

e - an EntityPropertyChangeEvent object containing information about the changed property

mute

public void mute()

Description copied from interface: InstanceContainer

Disables all event listeners on container data change.
Can be used with InstanceContainer.unmute() for bulk data modification as a perfomance optimization.

Specified by:

mute in interface InstanceContainer<E>

unmute

public void unmute()

Description copied from interface: InstanceContainer

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

Specified by:

unmute in interface InstanceContainer<E>