Package io.jmix.flowui.data.pagination

Class PaginationDataLoaderImpl

java.lang.Object

io.jmix.flowui.data.pagination.PaginationDataLoaderImpl

All Implemented Interfaces:

PaginationDataLoader

@Component("flowui_PaginationDataLoaderImpl")
@Scope("prototype")
public class PaginationDataLoaderImpl
extends Object
implements PaginationDataLoader

Implementation of the PaginationDataLoader interface. Provides functionality for managing pagination when loading entity data, including setting and retrieving the starting position, maximum number of results, and total count of data items. Also handles refreshing the data and responding to collection change events.

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionContainer<?>	container
protected Consumer<CollectionContainer.CollectionChangeEvent<?>>	containerCollectionChangeListener
protected DataManager	dataManager
protected BaseCollectionLoader	loader
protected Consumer<CollectionChangeType>	refreshListener
protected Function<DataLoadContext,Integer>	totalCountDelegate
protected WeakCollectionChangeListener<?>	weakContainerCollectionChangeListener

Constructor Summary

Constructors

Constructor	Description
PaginationDataLoaderImpl(BaseCollectionLoader loader)

Method Summary

Modifier and Type	Method	Description
protected void	attachCollectionChangeListener()
int	getCount()
MetaClass	getEntityMetaClass()
int	getFirstResult()
int	getMaxResults()
Function<DataLoadContext,Integer>	getTotalCountDelegate()
void	refresh()	Reloads instances.
void	removeCollectionChangeListener()	Removes collection change listener.
void	setCollectionChangeListener(Consumer<CollectionChangeType> listener)	Sets collection change listener.
void	setDataManager(DataManager dataManager)
void	setFirstResult(int startPosition)	Sets the position of the first instance to load.
void	setMaxResults(int maxResults)	Sets maximum number of instances to load.
void	setTotalCountDelegate(Function<DataLoadContext,Integer> totalCountDelegate)	Sets delegate which is used to get the total count of items.
int	size()

Methods inherited from class java.lang.Object

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

Field Details

dataManager

protected DataManager dataManager

container

protected CollectionContainer<?> container

loader

protected BaseCollectionLoader loader

refreshListener

protected Consumer<CollectionChangeType> refreshListener

weakContainerCollectionChangeListener

protected WeakCollectionChangeListener<?> weakContainerCollectionChangeListener

containerCollectionChangeListener

protected Consumer<CollectionContainer.CollectionChangeEvent<?>> containerCollectionChangeListener

totalCountDelegate

protected Function<DataLoadContext,Integer> totalCountDelegate

Constructor Details

PaginationDataLoaderImpl

public PaginationDataLoaderImpl(BaseCollectionLoader loader)

Method Details

attachCollectionChangeListener

protected void attachCollectionChangeListener()

setDataManager

@Autowired
public void setDataManager(DataManager dataManager)

getFirstResult

public int getFirstResult()

Specified by:

getFirstResult in interface PaginationDataLoader

Returns:

first position to load

setFirstResult

public void setFirstResult(int startPosition)

Description copied from interface: PaginationDataLoader

Sets the position of the first instance to load.

Specified by:

setFirstResult in interface PaginationDataLoader

getMaxResults

public int getMaxResults()

Specified by:

getMaxResults in interface PaginationDataLoader

Returns:

maximum number of instances to load

setMaxResults

public void setMaxResults(int maxResults)

Description copied from interface: PaginationDataLoader

Sets maximum number of instances to load.

Specified by:

setMaxResults in interface PaginationDataLoader

getCount

public int getCount()

Specified by:

getCount in interface PaginationDataLoader

Returns:

number of instances in the data store

size

public int size()

Specified by:

size in interface PaginationDataLoader

Returns:

number of instances are currently loaded

refresh

public void refresh()

Description copied from interface: PaginationDataLoader

Reloads instances.

Specified by:

refresh in interface PaginationDataLoader

removeCollectionChangeListener

public void removeCollectionChangeListener()

Description copied from interface: PaginationDataLoader

Removes collection change listener.

Specified by:

removeCollectionChangeListener in interface PaginationDataLoader

setCollectionChangeListener

public void setCollectionChangeListener(Consumer<CollectionChangeType> listener)

Description copied from interface: PaginationDataLoader

Sets collection change listener.

Specified by:

setCollectionChangeListener in interface PaginationDataLoader

getEntityMetaClass

public MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface PaginationDataLoader

Returns:

meta class of entity

getTotalCountDelegate

@Nullable
public Function<DataLoadContext,Integer> getTotalCountDelegate()

Specified by:

getTotalCountDelegate in interface PaginationDataLoader

Returns:

total count delegate or null otherwise

setTotalCountDelegate

public void setTotalCountDelegate(@Nullable
 Function<DataLoadContext,Integer> totalCountDelegate)

Description copied from interface: PaginationDataLoader

Sets delegate which is used to get the total count of items.

Specified by:

setTotalCountDelegate in interface PaginationDataLoader

Parameters:

totalCountDelegate - function that takes current DataLoadContext of loader and return calculated total count