Package io.jmix.gridexportui.exporter.entitiesloader

Class KeysetAllEntitiesLoader

java.lang.Object

io.jmix.gridexportui.exporter.entitiesloader.AbstractAllEntitiesLoader

io.jmix.gridexportui.exporter.entitiesloader.KeysetAllEntitiesLoader

All Implemented Interfaces:

AllEntitiesLoader

@Component
public class KeysetAllEntitiesLoader
extends AbstractAllEntitiesLoader

This loader implements the keyset pagination strategy. Entities retrieval is based on sorting by primary key. The next page starts after the last entity on the previous 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
protected static String	LAST_LOADED_PK_CONDITION_PARAMETER_NAME
static final String	PAGINATION_STRATEGY

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

dataManager, gridExportProperties, metadataTools, platformTransactionManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected LoadContext	generateLoadContext(DataUnit dataUnit, Sort sort)	Generates the load context using the given DataUnit.
String	getPaginationStrategy()	Type of data loading strategy defined as string constant.
void	loadAll(DataUnit dataUnit, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor, Sort sort)	Method loads all entity instances associated with the given dataUnit and pass each loaded entity instance to the exportedEntityVisitor.

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

LAST_LOADED_PK_CONDITION_PARAMETER_NAME

protected static String LAST_LOADED_PK_CONDITION_PARAMETER_NAME

Constructor Details

KeysetAllEntitiesLoader

public KeysetAllEntitiesLoader(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

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

Generates the load context using the given DataUnit.

Specified by:

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.

loadAll

public void loadAll(DataUnit dataUnit,
 AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor,
 @Nullable
 Sort sort)

Method loads all entity instances associated with the given dataUnit and pass each loaded entity instance to the exportedEntityVisitor. Creation of the output file row is the responsibility of that visitor. Data is loaded in batches, the batch size is configured by the GridExportProperties.getExportAllBatchSize().

Parameters:

dataUnit - data unit linked with the data

exportedEntityVisitor - function that is responsible for export

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