io.jmix.ui.model.impl

Class KeyValueInstanceLoaderImpl

java.lang.Object

io.jmix.ui.model.impl.KeyValueInstanceLoaderImpl

All Implemented Interfaces:

DataLoader, KeyValueInstanceLoader

public class KeyValueInstanceLoaderImpl
extends java.lang.Object
implements KeyValueInstanceLoader

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.model.KeyValueInstanceLoader

KeyValueInstanceLoader.PostLoadEvent, KeyValueInstanceLoader.PreLoadEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.querycondition.Condition	condition
protected KeyValueContainer	container
protected DataContext	dataContext
protected io.jmix.core.DataManager	dataManager
protected java.util.function.Function<io.jmix.core.ValueLoadContext,io.jmix.core.entity.KeyValueEntity>	delegate
protected io.jmix.core.common.event.EventHub	events
protected java.util.Map<java.lang.String,java.io.Serializable>	hints
protected java.util.Map<java.lang.String,java.lang.Object>	parameters
protected java.lang.String	query
protected java.lang.String	storeName

Constructor Summary

Constructors

Constructor and Description
KeyValueInstanceLoaderImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addPostLoadListener(java.util.function.Consumer<KeyValueInstanceLoader.PostLoadEvent> listener) Adds a listener to KeyValueInstanceLoader.PostLoadEvent.
io.jmix.core.common.event.Subscription	addPreLoadListener(java.util.function.Consumer<KeyValueInstanceLoader.PreLoadEvent> listener) Adds a listener to KeyValueInstanceLoader.PreLoadEvent.
io.jmix.core.ValueLoadContext	createLoadContext() Returns ValueLoadContext which is created by the parameters of this loader.
io.jmix.core.querycondition.Condition	getCondition() Returns the root condition which is used together with the query when loading entities.
KeyValueContainer	getContainer() Returns the container which accepts loaded entities.
DataContext	getDataContext() Returns data context.
java.util.Map<java.lang.String,java.io.Serializable>	getHints()
java.util.function.Function<io.jmix.core.ValueLoadContext,io.jmix.core.entity.KeyValueEntity>	getLoadDelegate() Returns a function which will be used to load data instead of standard implementation.
java.lang.Object	getParameter(java.lang.String name) Returns a query parameter by its name.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Returns the map of query parameters.
java.lang.String	getQuery() Returns the query which is used for loading entities.
java.lang.String	getStoreName() Returns data store name.
void	load() Loads data to the connected container.
void	removeParameter(java.lang.String name) Removes a query parameter.
protected void	sendPostLoadEvent(io.jmix.core.entity.KeyValueEntity entity)
protected boolean	sendPreLoadEvent(io.jmix.core.ValueLoadContext loadContext)
void	setCondition(io.jmix.core.querycondition.Condition condition) Sets the root condition which will be used together with the query when loading entities.
void	setContainer(KeyValueContainer container) Sets the container which accepts loaded entities.
void	setDataContext(DataContext dataContext) Sets the data context for the loader.
void	setHint(java.lang.String hintName, java.io.Serializable value) Sets custom hint that should be used by the query for loading data.
void	setLoadDelegate(java.util.function.Function<io.jmix.core.ValueLoadContext,io.jmix.core.entity.KeyValueEntity> delegate) Sets a function which will be used to load data instead of standard implementation.
void	setParameter(java.lang.String name, java.lang.Object value) Sets a query parameter.
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Sets the map of query parameters.
void	setQuery(java.lang.String query) Sets a query which will be used for loading entities.
void	setStoreName(java.lang.String name) Sets the data store name.

Methods inherited from class java.lang.Object

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

Field Detail

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

dataContext

protected DataContext dataContext

container

protected KeyValueContainer container

query

protected java.lang.String query

condition

protected io.jmix.core.querycondition.Condition condition

parameters

protected java.util.Map<java.lang.String,java.lang.Object> parameters

hints

protected java.util.Map<java.lang.String,java.io.Serializable> hints

storeName

protected java.lang.String storeName

delegate

protected java.util.function.Function<io.jmix.core.ValueLoadContext,io.jmix.core.entity.KeyValueEntity> delegate

events

protected io.jmix.core.common.event.EventHub events

Constructor Detail

KeyValueInstanceLoaderImpl

public KeyValueInstanceLoaderImpl()

Method Detail

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

load

public void load()

Description copied from interface: DataLoader

Loads data to the connected container.

Specified by:

load in interface DataLoader

createLoadContext

public io.jmix.core.ValueLoadContext createLoadContext()

Description copied from interface: KeyValueInstanceLoader

Returns ValueLoadContext which is created by the parameters of this loader. The ValueLoadContext can be used with DataManager to load data by the same conditions.

Specified by:

createLoadContext in interface KeyValueInstanceLoader

sendPreLoadEvent

protected boolean sendPreLoadEvent(io.jmix.core.ValueLoadContext loadContext)

sendPostLoadEvent

protected void sendPostLoadEvent(@Nullable
                                 io.jmix.core.entity.KeyValueEntity entity)

getContainer

public KeyValueContainer getContainer()

Description copied from interface: KeyValueInstanceLoader

Returns the container which accepts loaded entities.

Specified by:

getContainer in interface DataLoader

Specified by:

getContainer in interface KeyValueInstanceLoader

setContainer

public void setContainer(KeyValueContainer container)

Description copied from interface: KeyValueInstanceLoader

Sets the container which accepts loaded entities.

Specified by:

setContainer in interface KeyValueInstanceLoader

getQuery

public java.lang.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(java.lang.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 io.jmix.core.querycondition.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(io.jmix.core.querycondition.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 java.util.Map<java.lang.String,java.lang.Object> getParameters()

Description copied from interface: DataLoader

Returns the map of query parameters.

Specified by:

getParameters in interface DataLoader

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: DataLoader

Sets the map of query parameters.

Specified by:

setParameters in interface DataLoader

getParameter

public java.lang.Object getParameter(java.lang.String name)

Description copied from interface: DataLoader

Returns a query parameter by its name.

Specified by:

getParameter in interface DataLoader

setParameter

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

Description copied from interface: DataLoader

Sets a query parameter.

Specified by:

setParameter in interface DataLoader

removeParameter

public void removeParameter(java.lang.String name)

Description copied from interface: DataLoader

Removes a query parameter.

Specified by:

removeParameter in interface DataLoader

setHint

public void setHint(java.lang.String hintName,
                    java.io.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 java.util.Map<java.lang.String,java.io.Serializable> getHints()

Specified by:

getHints in interface DataLoader

Returns:

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

getLoadDelegate

public java.util.function.Function<io.jmix.core.ValueLoadContext,io.jmix.core.entity.KeyValueEntity> getLoadDelegate()

Description copied from interface: KeyValueInstanceLoader

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

Specified by:

getLoadDelegate in interface KeyValueInstanceLoader

setLoadDelegate

public void setLoadDelegate(java.util.function.Function<io.jmix.core.ValueLoadContext,io.jmix.core.entity.KeyValueEntity> delegate)

Description copied from interface: KeyValueInstanceLoader

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

Specified by:

setLoadDelegate in interface KeyValueInstanceLoader

addPreLoadListener

public io.jmix.core.common.event.Subscription addPreLoadListener(java.util.function.Consumer<KeyValueInstanceLoader.PreLoadEvent> listener)

Description copied from interface: KeyValueInstanceLoader

Adds a listener to KeyValueInstanceLoader.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(KeyValueInstanceLoader.PreLoadEvent event) {
         // handle event here
     }
 

Specified by:

addPreLoadListener in interface KeyValueInstanceLoader

Parameters:

listener - listener

Returns:

subscription

addPostLoadListener

public io.jmix.core.common.event.Subscription addPostLoadListener(java.util.function.Consumer<KeyValueInstanceLoader.PostLoadEvent> listener)

Description copied from interface: KeyValueInstanceLoader

Adds a listener to KeyValueInstanceLoader.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(KeyValueInstanceLoader.PostLoadEvent event) {
         // handle event here
     }
 

Specified by:

addPostLoadListener in interface KeyValueInstanceLoader

Parameters:

listener - listener

Returns:

subscription

getStoreName

public java.lang.String getStoreName()

Description copied from interface: KeyValueInstanceLoader

Returns data store name.

Specified by:

getStoreName in interface KeyValueInstanceLoader

setStoreName

public void setStoreName(java.lang.String name)

Description copied from interface: KeyValueInstanceLoader

Sets the data store name. By default, the main data store is used.

Specified by:

setStoreName in interface KeyValueInstanceLoader