com.haulmont.cuba.gui.model

Interface CollectionLoader<E extends Entity>

All Superinterfaces:

BaseCollectionLoader, DataLoader

All Known Implementing Classes:

CollectionLoaderImpl

@InstallSubject(value="loadDelegate")
public interface CollectionLoader<E extends Entity>
extends BaseCollectionLoader

Loader of entity collections.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CollectionLoader.PostLoadEvent<T extends Entity> Event sent after successful loading of entities, merging them into DataContext and setting to the container.
static class	CollectionLoader.PreLoadEvent<T extends Entity> Event sent before loading entities.

Method Summary

Modifier and Type	Method and Description
Subscription	addPostLoadListener(java.util.function.Consumer<CollectionLoader.PostLoadEvent<E>> listener) Adds a listener to CollectionLoader.PostLoadEvent.
Subscription	addPreLoadListener(java.util.function.Consumer<CollectionLoader.PreLoadEvent<E>> listener) Adds a listener to CollectionLoader.PreLoadEvent.
LoadContext<E>	createLoadContext() Returns LoadContext which is created by the parameters of this loader.
CollectionContainer<E>	getContainer() Returns the container which accepts loaded entities.
java.util.function.Function<LoadContext<E>,java.util.List<E>>	getLoadDelegate() Returns a function which will be used to load data instead of standard implementation.
View	getView() Returns the view which is used when loading.
boolean	isCacheable() Returns true if the query for loading data is cacheable.
boolean	isLoadDynamicAttributes() Returns true if the entity's dynamic attributes are loaded.
void	setCacheable(boolean cacheable) Sets the query for loading data cacheable.
void	setContainer(CollectionContainer<E> container) Sets the container which accepts loaded entities.
void	setLoadDelegate(java.util.function.Function<LoadContext<E>,java.util.List<E>> delegate) Sets a function which will be used to load data instead of standard implementation.
void	setLoadDynamicAttributes(boolean loadDynamicAttributes) Set to true to load the entity's dynamic attributes.
void	setView(java.lang.String viewName) Sets the name of the view which is used when loading.
void	setView(View view) Sets the view which is used when loading.

Methods inherited from interface com.haulmont.cuba.gui.model.BaseCollectionLoader

getFirstResult, getMaxResults, getSort, setFirstResult, setMaxResults, setSort

Methods inherited from interface com.haulmont.cuba.gui.model.DataLoader

getCondition, getDataContext, getParameter, getParameters, getQuery, isSoftDeletion, load, removeParameter, setCondition, setDataContext, setParameter, setParameters, setQuery, setSoftDeletion

Method Detail

getContainer

CollectionContainer<E> getContainer()

Returns the container which accepts loaded entities.

Specified by:

getContainer in interface BaseCollectionLoader

Specified by:

getContainer in interface DataLoader

setContainer

void setContainer(CollectionContainer<E> container)

Sets the container which accepts loaded entities.

createLoadContext

LoadContext<E> createLoadContext()

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

isLoadDynamicAttributes

boolean isLoadDynamicAttributes()

Returns true if the entity's dynamic attributes are loaded.

setLoadDynamicAttributes

void setLoadDynamicAttributes(boolean loadDynamicAttributes)

Set to true to load the entity's dynamic attributes. Dynamic attributes are not loaded by default.

isCacheable

boolean isCacheable()

Returns true if the query for loading data is cacheable.

setCacheable

void setCacheable(boolean cacheable)

Sets the query for loading data cacheable.

getView

View getView()

Returns the view which is used when loading.

setView

void setView(View view)

Sets the view which is used when loading.

setView

void setView(java.lang.String viewName)

Sets the name of the view which is used when loading.

Throws:

java.lang.IllegalStateException - if the view has already been set by setView(View)

getLoadDelegate

java.util.function.Function<LoadContext<E>,java.util.List<E>> getLoadDelegate()

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

setLoadDelegate

void setLoadDelegate(java.util.function.Function<LoadContext<E>,java.util.List<E>> delegate)

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

addPreLoadListener

Subscription addPreLoadListener(java.util.function.Consumer<CollectionLoader.PreLoadEvent<E>> listener)

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

Parameters:

listener - listener

Returns:

subscription

addPostLoadListener

Subscription addPostLoadListener(java.util.function.Consumer<CollectionLoader.PostLoadEvent<E>> listener)

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

Parameters:

listener - listener

Returns:

subscription