io.jmix.ui.model.impl

Class KeyValueCollectionLoaderImpl

java.lang.Object

io.jmix.ui.model.impl.KeyValueCollectionLoaderImpl

All Implemented Interfaces:

BaseCollectionLoader, DataLoader, KeyValueCollectionLoader

public class KeyValueCollectionLoaderImpl
extends java.lang.Object
implements KeyValueCollectionLoader

Nested Class Summary

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

KeyValueCollectionLoader.PostLoadEvent, KeyValueCollectionLoader.PreLoadEvent

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
KeyValueCollectionLoaderImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addPostLoadListener(java.util.function.Consumer<KeyValueCollectionLoader.PostLoadEvent> listener) Adds a listener to KeyValueCollectionLoader.PostLoadEvent.
io.jmix.core.common.event.Subscription	addPreLoadListener(java.util.function.Consumer<KeyValueCollectionLoader.PreLoadEvent> listener) Adds a listener to KeyValueCollectionLoader.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.
KeyValueCollectionContainer	getContainer() Returns the container which accepts loaded entities.
DataContext	getDataContext() Returns data context.
java.util.function.Function<io.jmix.core.ValueLoadContext,java.util.List<io.jmix.core.entity.KeyValueEntity>>	getDelegate() Returns a function which will be used to load data instead of standard implementation.
int	getFirstResult() The position of the first instance to load, numbered from 0.
java.util.Map<java.lang.String,java.io.Serializable>	getHints()
int	getMaxResults() The maximum number of instances to load.
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.
io.jmix.core.Sort	getSort() Returns the sort object which is used when loading.
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(java.util.List<io.jmix.core.entity.KeyValueEntity> entities)
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(KeyValueCollectionContainer container) Sets the container which accepts loaded entities.
void	setDataContext(DataContext dataContext) Sets the data context for the loader.
void	setFirstResult(int firstResult) Sets the position of the first instance to load, numbered from 0.
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,java.util.List<io.jmix.core.entity.KeyValueEntity>> delegate) Sets a function which will be used to load data instead of standard implementation.
void	setMaxResults(int maxResults) Sets the maximum number of instances to load.
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	setSort(io.jmix.core.Sort sort) Sets the sort object which is used when loading.
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

sorterFactory

@Autowired
protected SorterFactory sorterFactory

dataContext

protected DataContext dataContext

container

protected KeyValueCollectionContainer 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

firstResult

protected int firstResult

maxResults

protected int maxResults

sort

protected io.jmix.core.Sort sort

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,java.util.List<io.jmix.core.entity.KeyValueEntity>> delegate

events

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

Constructor Detail

KeyValueCollectionLoaderImpl

public KeyValueCollectionLoaderImpl()

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: KeyValueCollectionLoader

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 KeyValueCollectionLoader

sendPreLoadEvent

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

sendPostLoadEvent

protected void sendPostLoadEvent(java.util.List<io.jmix.core.entity.KeyValueEntity> entities)

getContainer

public KeyValueCollectionContainer getContainer()

Description copied from interface: KeyValueCollectionLoader

Returns the container which accepts loaded entities.

Specified by:

getContainer in interface BaseCollectionLoader

Specified by:

getContainer in interface DataLoader

Specified by:

getContainer in interface KeyValueCollectionLoader

setContainer

public void setContainer(KeyValueCollectionContainer container)

Description copied from interface: KeyValueCollectionLoader

Sets the container which accepts loaded entities.

Specified by:

setContainer in interface KeyValueCollectionLoader

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

getMaxResults

public int getMaxResults()

Description copied from interface: BaseCollectionLoader

The maximum number of instances to load. Returns Integer.MAX_VALUE if BaseCollectionLoader.setMaxResults(int) was not called.

Specified by:

getMaxResults in interface BaseCollectionLoader

setMaxResults

public void setMaxResults(int maxResults)

Description copied from interface: BaseCollectionLoader

Sets the maximum number of instances to load.

Specified by:

setMaxResults in interface BaseCollectionLoader

getSort

@Nullable
public io.jmix.core.Sort getSort()

Description copied from interface: BaseCollectionLoader

Returns the sort object which is used when loading.

Specified by:

getSort in interface BaseCollectionLoader

setSort

public void setSort(@Nullable
                    io.jmix.core.Sort sort)

Description copied from interface: BaseCollectionLoader

Sets the sort object which is used when loading.

Specified by:

setSort in interface BaseCollectionLoader

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.

getDelegate

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

Description copied from interface: KeyValueCollectionLoader

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

Specified by:

getDelegate in interface KeyValueCollectionLoader

setLoadDelegate

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

Description copied from interface: KeyValueCollectionLoader

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

Specified by:

setLoadDelegate in interface KeyValueCollectionLoader

addPreLoadListener

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

Description copied from interface: KeyValueCollectionLoader

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

Specified by:

addPreLoadListener in interface KeyValueCollectionLoader

Parameters:

listener - listener

Returns:

subscription

addPostLoadListener

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

Description copied from interface: KeyValueCollectionLoader

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

Specified by:

addPostLoadListener in interface KeyValueCollectionLoader

Parameters:

listener - listener

Returns:

subscription

getStoreName

public java.lang.String getStoreName()

Description copied from interface: KeyValueCollectionLoader

Returns data store name.

Specified by:

getStoreName in interface KeyValueCollectionLoader

setStoreName

public void setStoreName(@Nullable
                         java.lang.String name)

Description copied from interface: KeyValueCollectionLoader

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

Specified by:

setStoreName in interface KeyValueCollectionLoader

getFirstResult

public int getFirstResult()

Description copied from interface: BaseCollectionLoader

The position of the first instance to load, numbered from 0. Returns 0 if BaseCollectionLoader.setFirstResult(int) was not called.

Specified by:

getFirstResult in interface BaseCollectionLoader

setFirstResult

public void setFirstResult(int firstResult)

Description copied from interface: BaseCollectionLoader

Sets the position of the first instance to load, numbered from 0.

Specified by:

setFirstResult in interface BaseCollectionLoader