com.haulmont.cuba.gui.model.impl

Class CollectionLoaderImpl<E extends Entity>

java.lang.Object

com.haulmont.cuba.gui.model.impl.CollectionLoaderImpl<E>

All Implemented Interfaces:

BaseCollectionLoader, CollectionLoader<E>, DataLoader, LoaderSupportsApplyToSelected

public class CollectionLoaderImpl<E extends Entity>
extends java.lang.Object
implements CollectionLoader<E>, LoaderSupportsApplyToSelected

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.model.CollectionLoader

CollectionLoader.PostLoadEvent<T extends Entity>, CollectionLoader.PreLoadEvent<T extends Entity>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cacheable
protected Condition	condition
protected CollectionContainer<E>	container
protected DataContext	dataContext
protected java.util.function.Function<LoadContext<E>,java.util.List<E>>	delegate
protected EventHub	events
protected int	firstResult
protected LoadContext.Query	lastQuery
protected boolean	loadDynamicAttributes
protected int	maxResults
protected java.util.Map<java.lang.String,java.lang.Object>	parameters
protected java.util.List<LoadContext.Query>	prevQueries
protected java.lang.String	query
protected java.lang.Integer	queryKey
protected boolean	softDeletion
protected Sort	sort
protected View	view
protected java.lang.String	viewName

Constructor Summary

Constructors

Constructor and Description
CollectionLoaderImpl(org.springframework.context.ApplicationContext applicationContext)

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.
Condition	getCondition() Returns the root condition which is used together with the query when loading entities.
CollectionContainer<E>	getContainer() Returns the container which accepts loaded entities.
DataContext	getDataContext() Returns data context.
protected DataManager	getDataManager()
int	getFirstResult() The position of the first instance to load, numbered from 0.
LoadContext.Query	getLastQuery() Returns last query executed by loader
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.
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.util.List<LoadContext.Query>	getPrevQueries() Allows to load data on a previous loading result.
java.lang.String	getQuery() Returns the query which is used for loading entities.
java.lang.Integer	getQueryKey()
Sort	getSort() Returns the sort object which is used when loading.
protected SorterFactory	getSorterFactory()
View	getView() Returns the view which is used when loading.
protected ViewRepository	getViewRepository()
boolean	isCacheable() Returns true if the query for loading data is cacheable.
boolean	isLoadDynamicAttributes() Returns true if the entity's dynamic attributes are loaded.
boolean	isSoftDeletion() Returns true if the loader respects soft deletion, i.e.
void	load() Loads data to the connected container.
void	removeParameter(java.lang.String name) Removes a query parameter.
protected View	resolveView()
protected void	sendPostLoadEvent(java.util.List<E> entities)
protected boolean	sendPreLoadEvent(LoadContext<E> loadContext)
void	setCacheable(boolean cacheable) Sets the query for loading data cacheable.
void	setCondition(Condition condition) Sets the root condition which will be used together with the query when loading entities.
void	setContainer(CollectionContainer<E> 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	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	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	setPrevQueries(java.util.List<LoadContext.Query> prevQueries) Set previous queries which allows to load data on a previous loading result.
void	setQuery(java.lang.String query) Sets a query which will be used for loading entities.
void	setQueryKey(java.lang.Integer queryKey)
void	setSoftDeletion(boolean softDeletion) Set to false if you want to load softly deleted instances too.
void	setSort(Sort sort) Sets the sort object which is used when loading.
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 class java.lang.Object

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

Field Detail

dataContext

protected DataContext dataContext

container

protected CollectionContainer<E extends Entity> container

query

protected java.lang.String query

condition

protected Condition condition

parameters

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

firstResult

protected int firstResult

maxResults

protected int maxResults

softDeletion

protected boolean softDeletion

loadDynamicAttributes

protected boolean loadDynamicAttributes

cacheable

protected boolean cacheable

view

protected View view

viewName

protected java.lang.String viewName

sort

protected Sort sort

delegate

protected java.util.function.Function<LoadContext<E extends Entity>,java.util.List<E extends Entity>> delegate

lastQuery

protected LoadContext.Query lastQuery

prevQueries

protected java.util.List<LoadContext.Query> prevQueries

queryKey

protected java.lang.Integer queryKey

events

protected EventHub events

Constructor Detail

CollectionLoaderImpl

public CollectionLoaderImpl(org.springframework.context.ApplicationContext applicationContext)

Method Detail

getViewRepository

protected ViewRepository getViewRepository()

getDataManager

protected DataManager getDataManager()

getSorterFactory

protected SorterFactory getSorterFactory()

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(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 LoadContext<E> createLoadContext()

Description copied from interface: CollectionLoader

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.

Specified by:

createLoadContext in interface CollectionLoader<E extends Entity>

resolveView

protected View resolveView()

sendPreLoadEvent

protected boolean sendPreLoadEvent(LoadContext<E> loadContext)

sendPostLoadEvent

protected void sendPostLoadEvent(java.util.List<E> entities)

getContainer

public CollectionContainer<E> getContainer()

Description copied from interface: CollectionLoader

Returns the container which accepts loaded entities.

Specified by:

getContainer in interface BaseCollectionLoader

Specified by:

getContainer in interface CollectionLoader<E extends Entity>

Specified by:

getContainer in interface DataLoader

setContainer

public void setContainer(CollectionContainer<E> container)

Description copied from interface: CollectionLoader

Sets the container which accepts loaded entities.

Specified by:

setContainer in interface CollectionLoader<E extends Entity>

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

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(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,
                         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

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

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

isSoftDeletion

public boolean isSoftDeletion()

Description copied from interface: DataLoader

Returns true if the loader respects soft deletion, i.e. softly deleted instances are not loaded.

Specified by:

isSoftDeletion in interface DataLoader

setSoftDeletion

public void setSoftDeletion(boolean softDeletion)

Description copied from interface: DataLoader

Set to false if you want to load softly deleted instances too. Soft deletion is true by default.

Specified by:

setSoftDeletion in interface DataLoader

isLoadDynamicAttributes

public boolean isLoadDynamicAttributes()

Description copied from interface: CollectionLoader

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

Specified by:

isLoadDynamicAttributes in interface CollectionLoader<E extends Entity>

setLoadDynamicAttributes

public void setLoadDynamicAttributes(boolean loadDynamicAttributes)

Description copied from interface: CollectionLoader

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

Specified by:

setLoadDynamicAttributes in interface CollectionLoader<E extends Entity>

isCacheable

public boolean isCacheable()

Description copied from interface: CollectionLoader

Returns true if the query for loading data is cacheable.

Specified by:

isCacheable in interface CollectionLoader<E extends Entity>

setCacheable

public void setCacheable(boolean cacheable)

Description copied from interface: CollectionLoader

Sets the query for loading data cacheable.

Specified by:

setCacheable in interface CollectionLoader<E extends Entity>

getView

public View getView()

Description copied from interface: CollectionLoader

Returns the view which is used when loading.

Specified by:

getView in interface CollectionLoader<E extends Entity>

setView

public void setView(View view)

Description copied from interface: CollectionLoader

Sets the view which is used when loading.

Specified by:

setView in interface CollectionLoader<E extends Entity>

setView

public void setView(java.lang.String viewName)

Description copied from interface: CollectionLoader

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

Specified by:

setView in interface CollectionLoader<E extends Entity>

getSort

public 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(Sort sort)

Description copied from interface: BaseCollectionLoader

Sets the sort object which is used when loading.

Specified by:

setSort in interface BaseCollectionLoader

getLoadDelegate

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

Description copied from interface: CollectionLoader

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

Specified by:

getLoadDelegate in interface CollectionLoader<E extends Entity>

setLoadDelegate

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

Description copied from interface: CollectionLoader

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

Specified by:

setLoadDelegate in interface CollectionLoader<E extends Entity>

addPreLoadListener

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

Description copied from interface: CollectionLoader

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
     }
 

Specified by:

addPreLoadListener in interface CollectionLoader<E extends Entity>

Parameters:

listener - listener

Returns:

subscription

addPostLoadListener

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

Description copied from interface: CollectionLoader

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
     }
 

Specified by:

addPostLoadListener in interface CollectionLoader<E extends Entity>

Parameters:

listener - listener

Returns:

subscription

getLastQuery

public LoadContext.Query getLastQuery()

Description copied from interface: LoaderSupportsApplyToSelected

Returns last query executed by loader

Specified by:

getLastQuery in interface LoaderSupportsApplyToSelected

getPrevQueries

public java.util.List<LoadContext.Query> getPrevQueries()

Description copied from interface: LoaderSupportsApplyToSelected

Allows to load data on a previous loading result.

Specified by:

getPrevQueries in interface LoaderSupportsApplyToSelected

Returns:

editable list of previous queries

setPrevQueries

public void setPrevQueries(java.util.List<LoadContext.Query> prevQueries)

Description copied from interface: LoaderSupportsApplyToSelected

Set previous queries which allows to load data on a previous loading result.

Specified by:

setPrevQueries in interface LoaderSupportsApplyToSelected

getQueryKey

public java.lang.Integer getQueryKey()

Specified by:

getQueryKey in interface LoaderSupportsApplyToSelected

Returns:

key of the current stack of sequential queries, which is unique for the current user session

setQueryKey

public void setQueryKey(java.lang.Integer queryKey)

Specified by:

setQueryKey in interface LoaderSupportsApplyToSelected

Parameters:

queryKey - key of the current stack of sequential queries, which is unique for the current user session