Package io.jmix.gridexportflowui.exporter.excel

Class ExcelAllRecordsExporter

java.lang.Object

io.jmix.gridexportflowui.exporter.AbstractAllRecordsExporter

io.jmix.gridexportflowui.exporter.excel.ExcelAllRecordsExporter

@Component("grdexp_ExcelAllRecordsExporter")
public class ExcelAllRecordsExporter
extends AbstractAllRecordsExporter

Class is used by ExportAction for exporting all records from the database.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExcelAllRecordsExporter.RowCreationContext

Field Summary

Fields inherited from class io.jmix.gridexportflowui.exporter.AbstractAllRecordsExporter

dataManager, gridExportProperties, LAST_LOADED_PK_CONDITION_PARAMETER_NAME, metadataTools, platformTransactionManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	exportAll(DataUnit dataUnit, Consumer<ExcelAllRecordsExporter.RowCreationContext> excelRowCreator, Predicate<Integer> excelRowChecker)	Method loads all entity instances associated with the given dataUnit and applies the excelRowCreator function to each loaded entity instance.

Methods inherited from class io.jmix.gridexportflowui.exporter.AbstractAllRecordsExporter

exportAll, exportEntities, exportKeyValueEntities, generateLoadContext, generateLoadContext, getDataLoader, getValueLoadContextQuery, setDataManager, setGridExportProperties, setPlatformTransactionManager

Methods inherited from class java.lang.Object

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

Constructor Details

ExcelAllRecordsExporter

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

Method Details

exportAll

protected void exportAll(DataUnit dataUnit,
 Consumer<ExcelAllRecordsExporter.RowCreationContext> excelRowCreator,
 Predicate<Integer> excelRowChecker)

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

Parameters:

dataUnit - data unit linked with the data

excelRowCreator - function that is being applied to each loaded instance

excelRowChecker - function that checks for exceeding the maximum number of rows in XLSX format