Package io.jmix.gridexportflowui.exporter.entitiesloader

Class AbstractAllEntitiesLoader

java.lang.Object

io.jmix.gridexportflowui.exporter.entitiesloader.AbstractAllEntitiesLoader

All Implemented Interfaces:

AllEntitiesLoader

Direct Known Subclasses:

KeysetAllEntitiesLoader, LimitOffsetAllEntitiesLoader

@NullMarked
public abstract class AbstractAllEntitiesLoader
extends Object
implements AllEntitiesLoader

Base class for the all entities loader which is used to export to other data formats such as excel or json

Nested Class Summary

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

AllEntitiesLoader.ExportedEntityVisitor

Field Summary

Fields

Modifier and Type	Field	Description
protected DataManager	dataManager
protected GridExportProperties	gridExportProperties
protected MetadataTools	metadataTools
protected org.springframework.transaction.PlatformTransactionManager	platformTransactionManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract LoadContext	generateLoadContext(CollectionLoader loader)
protected @Nullable DataLoader	getDataLoader(DataUnit dataUnit)
protected ValueLoadContext.Query	getValueLoadContextQuery(ValueLoadContext valueLoadContext)
void	loadAll(DataUnit dataUnit, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor)	Deprecated, for removal: This API element is subject to removal in a future version. use loadAll(DataUnit, ExportedEntityVisitor, int) instead
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.
protected abstract void	loadEntities(CollectionLoader<?> collectionLoader, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor, int loadBatchSize)
protected void	loadKeyValueEntities(KeyValueCollectionLoader loader, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor, int loadBatchSize)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.gridexportflowui.exporter.entitiesloader.AllEntitiesLoader

getPaginationStrategy

Field Details

metadataTools

protected MetadataTools metadataTools

dataManager

protected DataManager dataManager

platformTransactionManager

protected org.springframework.transaction.PlatformTransactionManager platformTransactionManager

gridExportProperties

protected GridExportProperties gridExportProperties

Constructor Details

AbstractAllEntitiesLoader

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

Method Details

loadAll

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

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

use loadAll(DataUnit, ExportedEntityVisitor, int) instead

Loads all entity instances associated with the given dataUnit and calls the entityExporter to export each loaded entity instance. Creation of the output file object is the responsibility of entityExporter. Data is loaded in batches, the batch size is configured by the GridExportProperties.getExportAllBatchSize().

Specified by:

loadAll in interface AllEntitiesLoader

Parameters:

dataUnit - data unit linked with the data

exportedEntityVisitor - visitor which exports entity to appropriate format

loadAll

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

Description copied from interface: AllEntitiesLoader

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 AllEntitiesLoader.loadAll(DataUnit, ExportedEntityVisitor). Override it.

Specified by:

loadAll in interface AllEntitiesLoader

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

generateLoadContext

protected abstract LoadContext generateLoadContext(CollectionLoader loader)

loadEntities

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

getDataLoader

protected @Nullable DataLoader getDataLoader(DataUnit dataUnit)

loadKeyValueEntities

protected void loadKeyValueEntities(KeyValueCollectionLoader loader,
 AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor,
 int loadBatchSize)

getValueLoadContextQuery

protected ValueLoadContext.Query getValueLoadContextQuery(ValueLoadContext valueLoadContext)