io.jmix.ui.model

Interface DataLoader

All Known Subinterfaces:

BaseCollectionLoader, CollectionLoader<E>, InstanceLoader<E>, KeyValueCollectionLoader, KeyValueInstanceLoader

All Known Implementing Classes:

CollectionLoaderImpl, InstanceLoaderImpl, KeyValueCollectionLoaderImpl, KeyValueInstanceLoaderImpl

public interface DataLoader

The root interface in the data loaders hierarchy. Data loaders are designed to load entity instances and collections from the middle tier to data containers.

See Also:

InstanceContainer, CollectionContainer

Method Summary

Modifier and Type	Method and Description
io.jmix.core.querycondition.Condition	getCondition() Returns the root condition which is used together with the query when loading entities.
InstanceContainer	getContainer() Returns connected container.
DataContext	getDataContext() Returns data context.
java.util.Map<java.lang.String,java.io.Serializable>	getHints()
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.
void	load() Loads data to the connected container.
void	removeParameter(java.lang.String name) Removes a query parameter.
void	setCondition(io.jmix.core.querycondition.Condition condition) Sets the root condition which will be used together with the query when loading 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	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.

Method Detail

load

void load()

Loads data to the connected container.

getContainer

InstanceContainer getContainer()

Returns connected container.

getDataContext

@Nullable
DataContext getDataContext()

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

setDataContext

void setDataContext(@Nullable
                    DataContext dataContext)

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

getQuery

java.lang.String getQuery()

Returns the query which is used for loading entities.

setQuery

void setQuery(java.lang.String query)

Sets a query which will be used for loading entities.

getCondition

@Nullable
io.jmix.core.querycondition.Condition getCondition()

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

setCondition

void setCondition(io.jmix.core.querycondition.Condition condition)

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

getParameters

java.util.Map<java.lang.String,java.lang.Object> getParameters()

Returns the map of query parameters.

setParameters

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

Sets the map of query parameters.

getParameter

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

Returns a query parameter by its name.

setParameter

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

Sets a query parameter.

removeParameter

void removeParameter(java.lang.String name)

Removes a query parameter.

setHint

void setHint(java.lang.String hintName,
             java.io.Serializable value)

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

getHints

java.util.Map<java.lang.String,java.io.Serializable> getHints()

Returns:

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