Package io.jmix.flowui.model.impl

Class InstanceLoaderImpl<E>

java.lang.Object

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

Type Parameters:

E - type of the entity being loaded

All Implemented Interfaces:

DataLoader, InstanceLoader<E>

public class InstanceLoaderImpl<E>
extends Object
implements InstanceLoader<E>

Implementation of the InstanceLoader interface. Provides a mechanism for loading a single entity instance into an associated InstanceContainer.

Nested Class Summary

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

InstanceLoader.PostLoadEvent<T>, InstanceLoader.PreLoadEvent<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected Condition	condition
protected InstanceContainer<E>	container
protected DataContext	dataContext
protected DataManager	dataManager
protected Function<LoadContext<E>,E>	delegate
protected Object	entityId
protected EventHub	events
protected FetchPlan	fetchPlan
protected String	fetchPlanName
protected FetchPlanRepository	fetchPlanRepository
protected Map<String,Serializable>	hints
protected BiFunction<Object,FetchPlan,Optional<E>>	loadFromRepositoryDelegate
protected Metadata	metadata
protected io.micrometer.core.instrument.MeterRegistry	meterRegistry
protected Function<DataLoader,DataLoaderMonitoringInfo>	monitoringInfoProvider
protected Map<String,Object>	parameters
protected String	query
protected List<QueryStringProcessor>	queryStringProcessors

Constructor Summary

Constructors

Constructor	Description
InstanceLoaderImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addPostLoadListener(Consumer<InstanceLoader.PostLoadEvent<E>> listener)	Adds a listener to InstanceLoader.PostLoadEvent.
Subscription	addPreLoadListener(Consumer<InstanceLoader.PreLoadEvent<E>> listener)	Adds a listener to InstanceLoader.PreLoadEvent.
LoadContext<E>	createLoadContext()	Creates and configures a LoadContext instance for retrieving an entity or entities from the data store.
Condition	getCondition()	Returns the root condition which is used together with the query when loading entities.
InstanceContainer<E>	getContainer()	Returns the container which accepts the loaded entity.
DataContext	getDataContext()	Returns data context.
Object	getEntityId()	Returns id of the entity to load.
FetchPlan	getFetchPlan()	Returns the fetch plan used for loading the entity.
Map<String,Serializable>	getHints()
Function<LoadContext<E>,E>	getLoadDelegate()	Returns a function which will be used to load data instead of standard implementation.
BiFunction<Object,FetchPlan,Optional<E>>	getLoadFromRepositoryDelegate()
Function<DataLoader,DataLoaderMonitoringInfo>	getMonitoringInfoProvider()	Returns function that provides monitoring info about this data loader.
Object	getParameter(String name)	Returns a query parameter by its name.
Map<String,Object>	getParameters()	Returns the map of query parameters.
String	getQuery()	Returns the query which is used for loading entities.
void	load()	Loads data to the connected container.
protected boolean	needLoad()
void	removeParameter(String name)	Removes a query parameter.
protected FetchPlan	resolveFetchPlan()
protected void	sendPostLoadEvent(E entity)
protected boolean	sendPreLoadEvent(LoadContext<E> loadContext)
void	setCondition(Condition condition)	Sets the root condition which will be used together with the query when loading entities.
void	setContainer(InstanceContainer<E> container)	Sets the container which accepts the loaded entity.
void	setDataContext(DataContext dataContext)	Sets the data context for the loader.
void	setEntityId(Object entityId)	Sets the id of the entity to load.
void	setFetchPlan(FetchPlan fetchPlan)	Sets the fetch plan to use for loading the entity.
void	setFetchPlan(String fetchPlanName)	Sets the name of the fetch plan to use for loading the entity.
void	setHint(String hintName, Serializable value)	Sets custom hint that should be used by the query for loading data.
void	setLoadDelegate(Function<LoadContext<E>,E> delegate)	Sets a function which will be used to load data instead of standard implementation.
void	setLoadFromRepositoryDelegate(BiFunction<Object,FetchPlan,Optional<E>> delegate)
void	setMonitoringInfoProvider(Function<DataLoader,DataLoaderMonitoringInfo> monitoringInfoProvider)	Sets function that provides monitoring info about this data loader.
void	setParameter(String name, Object value)	Sets a query parameter.
void	setParameters(Map<String,Object> parameters)	Sets the map of query parameters.
void	setQuery(String query)	Sets a query which will be used for loading entities.

Methods inherited from class java.lang.Object

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

Field Details

dataManager

@Autowired
protected DataManager dataManager

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

queryStringProcessors

@Autowired
protected List<QueryStringProcessor> queryStringProcessors

metadata

@Autowired
protected Metadata metadata

meterRegistry

@Autowired
protected io.micrometer.core.instrument.MeterRegistry meterRegistry

dataContext

protected DataContext dataContext

container

protected InstanceContainer<E> container

query

protected String query

condition

protected Condition condition

parameters

protected Map<String,Object> parameters

entityId

protected Object entityId

fetchPlan

protected FetchPlan fetchPlan

fetchPlanName

protected String fetchPlanName

hints

protected Map<String,Serializable> hints

delegate

protected Function<LoadContext<E>,E> delegate

loadFromRepositoryDelegate

protected BiFunction<Object,FetchPlan,Optional<E>> loadFromRepositoryDelegate

events

protected EventHub events

monitoringInfoProvider

protected Function<DataLoader,DataLoaderMonitoringInfo> monitoringInfoProvider

Constructor Details

InstanceLoaderImpl

public InstanceLoaderImpl()

Method Details

getDataContext

@Nullable
public DataContext getDataContext()

Description copied from interface: DataLoader

Returns data context. If the data context is set, all loaded instance will be merged into it.

Specified by:

getDataContext in interface DataLoader

setDataContext

public void setDataContext(@Nullable
 DataContext dataContext)

Description copied from interface: DataLoader

Sets the data context for the loader. If the data context is set, all loaded instance will be merged into it.

Specified by:

setDataContext in interface DataLoader

setMonitoringInfoProvider

public void setMonitoringInfoProvider(Function<DataLoader,DataLoaderMonitoringInfo> monitoringInfoProvider)

Description copied from interface: DataLoader

Sets function that provides monitoring info about this data loader.

Specified by:

setMonitoringInfoProvider in interface DataLoader

getMonitoringInfoProvider

public Function<DataLoader,DataLoaderMonitoringInfo> getMonitoringInfoProvider()

Description copied from interface: DataLoader

Returns function that provides monitoring info about this data loader.

Specified by:

getMonitoringInfoProvider in interface DataLoader

load

public void load()

Description copied from interface: DataLoader

Loads data to the connected container.

Specified by:

load in interface DataLoader

needLoad

protected boolean needLoad()

createLoadContext

public LoadContext<E> createLoadContext()

Creates and configures a LoadContext instance for retrieving an entity or entities from the data store.

Returns:

a configured LoadContext instance for loading entities

resolveFetchPlan

protected FetchPlan resolveFetchPlan()

sendPreLoadEvent

protected boolean sendPreLoadEvent(LoadContext<E> loadContext)

sendPostLoadEvent

protected void sendPostLoadEvent(E entity)

getContainer

public InstanceContainer<E> getContainer()

Description copied from interface: InstanceLoader

Returns the container which accepts the loaded entity.

Specified by:

getContainer in interface DataLoader

Specified by:

getContainer in interface InstanceLoader<E>

setContainer

public void setContainer(InstanceContainer<E> container)

Description copied from interface: InstanceLoader

Sets the container which accepts the loaded entity.

Specified by:

setContainer in interface InstanceLoader<E>

getQuery

public String getQuery()

Description copied from interface: DataLoader

Returns the query which is used for loading entities.

Specified by:

getQuery in interface DataLoader

setQuery

public void setQuery(String query)

Description copied from interface: DataLoader

Sets a query which will be used for loading entities.

Specified by:

setQuery in interface DataLoader

getCondition

@Nullable
public Condition getCondition()

Description copied from interface: DataLoader

Returns the root condition which is used together with the query when loading entities.

Specified by:

getCondition in interface DataLoader

setCondition

public void setCondition(@Nullable
 Condition condition)

Description copied from interface: DataLoader

Sets the root condition which will be used together with the query when loading entities.

Specified by:

setCondition in interface DataLoader

getParameters

public Map<String,Object> getParameters()

Description copied from interface: DataLoader

Returns the map of query parameters.

Specified by:

getParameters in interface DataLoader

setParameters

public void setParameters(Map<String,Object> parameters)

Description copied from interface: DataLoader

Sets the map of query parameters.

Specified by:

setParameters in interface DataLoader

getParameter

public Object getParameter(String name)

Description copied from interface: DataLoader

Returns a query parameter by its name.

Specified by:

getParameter in interface DataLoader

setParameter

public void setParameter(String name,
 @Nullable
 Object value)

Description copied from interface: DataLoader

Sets a query parameter.

Specified by:

setParameter in interface DataLoader

removeParameter

public void removeParameter(String name)

Description copied from interface: DataLoader

Removes a query parameter.

Specified by:

removeParameter in interface DataLoader

getEntityId

@Nullable
public Object getEntityId()

Description copied from interface: InstanceLoader

Returns id of the entity to load.

Specified by:

getEntityId in interface InstanceLoader<E>

setEntityId

public void setEntityId(@Nullable
 Object entityId)

Description copied from interface: InstanceLoader

Sets the id of the entity to load.

Specified by:

setEntityId in interface InstanceLoader<E>

setHint

public void setHint(String hintName,
 Serializable value)

Description copied from interface: DataLoader

Sets custom hint that should be used by the query for loading data.

Specified by:

setHint in interface DataLoader

getHints

public Map<String,Serializable> getHints()

Specified by:

getHints in interface DataLoader

Returns:

custom hints which are used by the query for loading data.

getLoadDelegate

public Function<LoadContext<E>,E> getLoadDelegate()

Description copied from interface: InstanceLoader

Returns a function which will be used to load data instead of standard implementation.

Specified by:

getLoadDelegate in interface InstanceLoader<E>

setLoadDelegate

public void setLoadDelegate(Function<LoadContext<E>,E> delegate)

Description copied from interface: InstanceLoader

Sets a function which will be used to load data instead of standard implementation.

Specified by:

setLoadDelegate in interface InstanceLoader<E>

getLoadFromRepositoryDelegate

public BiFunction<Object,FetchPlan,Optional<E>> getLoadFromRepositoryDelegate()

Specified by:

getLoadFromRepositoryDelegate in interface InstanceLoader<E>

setLoadFromRepositoryDelegate

public void setLoadFromRepositoryDelegate(BiFunction<Object,FetchPlan,Optional<E>> delegate)

Specified by:

setLoadFromRepositoryDelegate in interface InstanceLoader<E>

addPreLoadListener

public Subscription addPreLoadListener(Consumer<InstanceLoader.PreLoadEvent<E>> listener)

Description copied from interface: InstanceLoader

Adds a listener to InstanceLoader.PreLoadEvent.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe(id = "fooDl", target = Target.DATA_LOADER)
     private void onFooDlPreLoad(InstanceLoader.PreLoadEvent<Foo> event) {
         // handle event here
     }
 

Specified by:

addPreLoadListener in interface InstanceLoader<E>

Parameters:

listener - listener

Returns:

subscription

addPostLoadListener

public Subscription addPostLoadListener(Consumer<InstanceLoader.PostLoadEvent<E>> listener)

Description copied from interface: InstanceLoader

Adds a listener to InstanceLoader.PostLoadEvent.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe(id = "fooDl", target = Target.DATA_LOADER)
     private void onFooDlPostLoad(InstanceLoader.PostLoadEvent<Foo> event) {
         // handle event here
     }
 

Specified by:

addPostLoadListener in interface InstanceLoader<E>

Parameters:

listener - listener

Returns:

subscription

getFetchPlan

public FetchPlan getFetchPlan()

Description copied from interface: InstanceLoader

Returns the fetch plan used for loading the entity.

Specified by:

getFetchPlan in interface InstanceLoader<E>

setFetchPlan

public void setFetchPlan(FetchPlan fetchPlan)

Description copied from interface: InstanceLoader

Sets the fetch plan to use for loading the entity.

Specified by:

setFetchPlan in interface InstanceLoader<E>

setFetchPlan

public void setFetchPlan(String fetchPlanName)

Description copied from interface: InstanceLoader

Sets the name of the fetch plan to use for loading the entity.

Specified by:

setFetchPlan in interface InstanceLoader<E>