Package io.jmix.gridexportui.exporter.entitiesloader

Class AbstractAllEntitiesLoader

java.lang.Object

io.jmix.gridexportui.exporter.entitiesloader.AbstractAllEntitiesLoader

All Implemented Interfaces:

AllEntitiesLoader

Direct Known Subclasses:

KeysetAllEntitiesLoader, LimitOffsetAllEntitiesLoader

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.gridexportui.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 LoadContext	generateLoadContext(DataUnit dataUnit, Sort sort)	Deprecated, for removal: This API element is subject to removal in a future version. Use generateLoadContext(CollectionLoader) instead.
protected abstract LoadContext	generateLoadContext(CollectionLoader dataUnit)
protected DataLoader	getDataLoader(DataUnit dataUnit)
protected ValueLoadContext.Query	getValueLoadContextQuery(ValueLoadContext valueLoadContext)
void	loadAll(DataUnit dataUnit, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor)	Loads all entity instances associated with the given dataUnit and calls the entityExporter to export each loaded entity instance.
void	loadAll(DataUnit dataUnit, AllEntitiesLoader.ExportedEntityVisitor exportedEntityVisitor, Sort sort)	Load entities and export 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.gridexportui.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

generateLoadContext

@Deprecated(forRemoval=true,
            since="1.7")
protected LoadContext generateLoadContext(DataUnit dataUnit,
 @Nullable
 Sort sort)

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

Use generateLoadContext(CollectionLoader) instead.

generateLoadContext

protected abstract LoadContext generateLoadContext(CollectionLoader dataUnit)

loadAll

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

Description copied from interface: AllEntitiesLoader

Load entities and export each entity using the AllEntitiesLoader.ExportedEntityVisitor

Specified by:

loadAll in interface AllEntitiesLoader

loadAll

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

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 an entity to the appropriate format

loadEntities

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

getDataLoader

protected DataLoader getDataLoader(DataUnit dataUnit)

loadKeyValueEntities

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

getValueLoadContextQuery

protected ValueLoadContext.Query getValueLoadContextQuery(ValueLoadContext valueLoadContext)