Package io.jmix.flowui.facet.impl

Class AbstractDataLoadCoordinator

java.lang.Object

io.jmix.flowui.facet.impl.AbstractFacet

io.jmix.flowui.facet.impl.AbstractDataLoadCoordinator

All Implemented Interfaces:

DataLoadCoordinator, Facet

Direct Known Subclasses:

FragmentDataLoadCoordinatorImpl, ViewDataLoadCoordinatorImpl

public abstract class AbstractDataLoadCoordinator
extends AbstractFacet
implements DataLoadCoordinator

An abstract implementation of the DataLoadCoordinator interface. This class is responsible for managing data loading triggers in a UI. It provides mechanisms to configure triggers and associate them with data loaders, components, or instance containers. These triggers allow automatic data loading by observing changes in specific sources or events.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.facet.DataLoadCoordinator

DataLoadCoordinator.LikeClause, DataLoadCoordinator.Trigger

Field Summary

Fields

Modifier and Type	Field	Description
protected String	componentPrefix
protected String	containerPrefix
protected static final Pattern	LIKE_PATTERN
protected ReflectionCacheManager	reflectionCacheManager
protected List<DataLoadCoordinator.Trigger>	triggers

Fields inherited from class io.jmix.flowui.facet.impl.AbstractFacet

id, owner

Fields inherited from interface io.jmix.flowui.facet.DataLoadCoordinator

DEFAULT_COMPONENT_PREFIX, DEFAULT_CONTAINER_PREFIX, NAME

Constructor Summary

Constructors

Constructor	Description
AbstractDataLoadCoordinator(ReflectionCacheManager reflectionCacheManager, QueryParamValuesManager queryParamValuesManager)

Method Summary

Modifier and Type	Method	Description
void	addOnComponentValueChangedLoadTrigger(DataLoader loader, com.vaadin.flow.component.Component component, String param, DataLoadCoordinator.LikeClause likeClause)	Adds trigger on visual component ValueChangeEvent.
void	addOnContainerItemChangedLoadTrigger(DataLoader loader, InstanceContainer<?> container, String param)	Adds trigger on data container ItemChangeEvent.
protected abstract void	addOnDefaultEventLoadTrigger(DataLoader loader)
void	configureAutomatically()	Configures triggers automatically relying upon parameter prefixes.
protected void	configureAutomatically(DataLoader loader)
protected boolean	containsLikeClause(Condition condition, String parameter)
protected boolean	containsLikeClause(String query, String parameter)
protected abstract com.vaadin.flow.component.Component	findComponent(String componentId)
protected DataLoadCoordinator.LikeClause	findLikeClause(DataLoader loader, String parameter)
protected String	findSingleParam(DataLoader loader)
protected List<String>	getConditionParameters(DataLoader loader)
protected abstract HasDataComponents	getOwnerData()
protected com.vaadin.flow.component.Composite<?>	getOwnerNN()
List<DataLoadCoordinator.Trigger>	getTriggers()	Returns configured triggers.
protected Stream<DataLoader>	getUnconfiguredLoaders(HasDataComponents data)
protected boolean	loaderIsNotConfiguredYet(DataLoader loader)
void	setComponentPrefix(String value)	Sets parameter prefix to denote a visual component.
void	setContainerPrefix(String value)	Sets parameter prefix to denote a data container.

Methods inherited from class io.jmix.flowui.facet.impl.AbstractFacet

getId, getOwner, setId, setOwner

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.facet.DataLoadCoordinator

addOnViewEventLoadTrigger

Methods inherited from interface io.jmix.flowui.facet.Facet

getId, getOwner, setId, setOwner

Field Details

LIKE_PATTERN

protected static final Pattern LIKE_PATTERN

containerPrefix

protected String containerPrefix

componentPrefix

protected String componentPrefix

triggers

protected List<DataLoadCoordinator.Trigger> triggers

reflectionCacheManager

protected ReflectionCacheManager reflectionCacheManager

Constructor Details

AbstractDataLoadCoordinator

public AbstractDataLoadCoordinator(ReflectionCacheManager reflectionCacheManager,
 QueryParamValuesManager queryParamValuesManager)

Method Details

setContainerPrefix

public void setContainerPrefix(String value)

Description copied from interface: DataLoadCoordinator

Sets parameter prefix to denote a data container.

Specified by:

setContainerPrefix in interface DataLoadCoordinator

setComponentPrefix

public void setComponentPrefix(String value)

Description copied from interface: DataLoadCoordinator

Sets parameter prefix to denote a visual component.

Specified by:

setComponentPrefix in interface DataLoadCoordinator

getTriggers

public List<DataLoadCoordinator.Trigger> getTriggers()

Description copied from interface: DataLoadCoordinator

Returns configured triggers.

Specified by:

getTriggers in interface DataLoadCoordinator

addOnContainerItemChangedLoadTrigger

public void addOnContainerItemChangedLoadTrigger(DataLoader loader,
 InstanceContainer<?> container,
 @Nullable
 String param)

Description copied from interface: DataLoadCoordinator

Adds trigger on data container ItemChangeEvent.

Specified by:

addOnContainerItemChangedLoadTrigger in interface DataLoadCoordinator

Parameters:

loader - loader

container - master data container

param - loader parameter

addOnComponentValueChangedLoadTrigger

public void addOnComponentValueChangedLoadTrigger(DataLoader loader,
 com.vaadin.flow.component.Component component,
 @Nullable
 String param,
 DataLoadCoordinator.LikeClause likeClause)

Description copied from interface: DataLoadCoordinator

Adds trigger on visual component ValueChangeEvent.

Specified by:

addOnComponentValueChangedLoadTrigger in interface DataLoadCoordinator

Parameters:

loader - loader

component - component which must implement HasValue

param - loader parameter

likeClause - whether the condition using the parameter is a LIKE clause

configureAutomatically

public void configureAutomatically()

Description copied from interface: DataLoadCoordinator

Configures triggers automatically relying upon parameter prefixes. All data containers that don't have a prefixed parameter in the query string are configured to be triggered on View.BeforeShowEvent in case of View facet owner or Fragment.ReadyEvent in case of Fragment facet owner or AttachEvent.

Specified by:

configureAutomatically in interface DataLoadCoordinator

getOwnerData

protected abstract HasDataComponents getOwnerData()

getUnconfiguredLoaders

protected Stream<DataLoader> getUnconfiguredLoaders(HasDataComponents data)

loaderIsNotConfiguredYet

protected boolean loaderIsNotConfiguredYet(DataLoader loader)

configureAutomatically

protected void configureAutomatically(DataLoader loader)

findComponent

protected abstract com.vaadin.flow.component.Component findComponent(String componentId)

addOnDefaultEventLoadTrigger

protected abstract void addOnDefaultEventLoadTrigger(DataLoader loader)

containsLikeClause

protected boolean containsLikeClause(Condition condition,
 String parameter)

getConditionParameters

protected List<String> getConditionParameters(DataLoader loader)

findSingleParam

protected String findSingleParam(DataLoader loader)

findLikeClause

protected DataLoadCoordinator.LikeClause findLikeClause(DataLoader loader,
 String parameter)

containsLikeClause

protected boolean containsLikeClause(String query,
 String parameter)

getOwnerNN

protected com.vaadin.flow.component.Composite<?> getOwnerNN()