Package io.jmix.gridexportflowui.exporter.entitiesloader

Interface AllEntitiesLoader

All Known Implementing Classes:

AbstractAllEntitiesLoader, KeysetAllEntitiesLoader, LimitOffsetAllEntitiesLoader

@NullMarked
public interface AllEntitiesLoader

This interface should be implemented by any bean which loads all entities for json or excel export.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AllEntitiesLoader.ExportedEntityVisitor	Visitor is passed to AllEntitiesLoader to export loaded entity

Method Summary

Modifier and Type	Method	Description
String	getPaginationStrategy()	Type of data loading strategy defined as string constant.
void	loadAll(DataUnit dataUnit, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor)	Deprecated, for removal: This API element is subject to removal in a future version. implement and use loadAll(DataUnit, ExportedEntityVisitor, int) instead, which takes the batch size configured for the exporter.
default void	loadAll(DataUnit dataUnit, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor, int loadBatchSize)	Loads entities in batches of the given size and exports each entity using the AllEntitiesLoader.ExportedEntityVisitor.

Method Details

getPaginationStrategy

String getPaginationStrategy()

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

loadAll

@Deprecated(since="3.1",
            forRemoval=true)
void loadAll(DataUnit dataUnit,
 AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor)

Deprecated, for removal: This API element is subject to removal in a future version.

implement and use loadAll(DataUnit, ExportedEntityVisitor, int) instead, which takes the batch size configured for the exporter. This method will be removed and the one with the batch size will become abstract.

Loads entities in batches of the size the loader chooses itself and exports each entity using the AllEntitiesLoader.ExportedEntityVisitor.

Parameters:

dataUnit - data unit linked with the data

exportedEntityVisitor - visitor which exports entity to appropriate format

loadAll

default void loadAll(DataUnit dataUnit,
 AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor,
 int loadBatchSize)

Loads entities in batches of the given size and exports each entity using the AllEntitiesLoader.ExportedEntityVisitor. A loader whose data source has no notion of batches may ignore the batch size.

The default implementation exists only for loaders written before the batch size was introduced: it ignores loadBatchSize and delegates to loadAll(DataUnit, ExportedEntityVisitor). Override it.

Parameters:

dataUnit - data unit linked with the data

exportedEntityVisitor - visitor which exports entity to appropriate format

loadBatchSize - number of entities loaded in one query, positive