Package io.jmix.gridexportui.exporter.entitiesloader

Class LimitOffsetAllEntitiesLoader

java.lang.Object

io.jmix.gridexportui.exporter.entitiesloader.AbstractAllEntitiesLoader

io.jmix.gridexportui.exporter.entitiesloader.LimitOffsetAllEntitiesLoader

All Implemented Interfaces:

AllEntitiesLoader

@Component
public class LimitOffsetAllEntitiesLoader
extends AbstractAllEntitiesLoader

This loader implements limit-offset pagination strategy. Entities are fetched in the same order as in the data store. The strategy uses two parameters. The first, offset, sets a number of the starting record of the page. The second, limit, defines the number of records in the page.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.gridexportui.exporter.entitiesloader.AllEntitiesLoader

AllEntitiesLoader.ExportedEntityVisitor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAGINATION_STRATEGY

Fields inherited from class io.jmix.gridexportui.exporter.entitiesloader.AbstractAllEntitiesLoader

dataManager, gridExportProperties, metadataTools, platformTransactionManager

Constructor Summary

Constructors

Constructor	Description
LimitOffsetAllEntitiesLoader(MetadataTools metadataTools, DataManager dataManager, org.springframework.transaction.PlatformTransactionManager platformTransactionManager, GridExportProperties gridExportProperties)

Method Summary

Modifier and Type	Method	Description
LoadContext	generateLoadContext(DataUnit dataUnit, Sort sort)	Deprecated. use generateLoadContext(CollectionLoader) instead
protected LoadContext	generateLoadContext(CollectionLoader loader)
String	getPaginationStrategy()	Type of data loading strategy defined as string constant.
protected void	loadEntities(CollectionLoader<?> collectionLoader, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor, int loadBatchSize)	Sequential data loading

Methods inherited from class io.jmix.gridexportui.exporter.entitiesloader.AbstractAllEntitiesLoader

getDataLoader, getValueLoadContextQuery, loadAll, loadAll, loadKeyValueEntities

Methods inherited from class java.lang.Object

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

Field Details

PAGINATION_STRATEGY

public static final String PAGINATION_STRATEGY

See Also:

• Constant Field Values

Constructor Details

LimitOffsetAllEntitiesLoader

public LimitOffsetAllEntitiesLoader(MetadataTools metadataTools,
 DataManager dataManager,
 org.springframework.transaction.PlatformTransactionManager platformTransactionManager,
 GridExportProperties gridExportProperties)

Method Details

getPaginationStrategy

public String getPaginationStrategy()

Description copied from interface: AllEntitiesLoader

Type of data loading strategy defined as string constant. AllEntitiesLoaderFactory.getEntitiesLoader() returns loader which pagination strategy equals to GridExportProperties.getExportAllPaginationStrategy()

generateLoadContext

public LoadContext generateLoadContext(DataUnit dataUnit,
 @Nullable
 Sort sort)

Deprecated.

use generateLoadContext(CollectionLoader) instead

Generates the load context using the given DataUnit.

Overrides:

generateLoadContext in class AbstractAllEntitiesLoader

Parameters:

dataUnit - data unit linked with the data

sort - An optional sorting specification for the data. If null sorting will be applied by the primary key.

generateLoadContext

protected LoadContext generateLoadContext(CollectionLoader loader)

Specified by:

generateLoadContext in class AbstractAllEntitiesLoader

loadEntities

protected void loadEntities(CollectionLoader<?> collectionLoader,
 AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor,
 int loadBatchSize)

Sequential data loading

Specified by:

loadEntities in class AbstractAllEntitiesLoader

Parameters:

exportedEntityVisitor - AllEntitiesLoader.ExportedEntityVisitor.visitEntity(EntityExportContext)