Package com.ocs.dynamo.ui.composite.export

Interface ExportService

All Known Implementing Classes:

ExportServiceImpl

public interface ExportService

Service for exporting grid contents to XLSX or CSV

Author:

Bas Rutten

Method Summary

Modifier and Type	Method	Description
<ID extends Serializable,T extends AbstractEntity<ID>> byte[]	exportCsv(EntityModel<T> entityModel, ExportMode mode, com.vaadin.flow.function.SerializablePredicate<T> predicate, List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders, FetchJoinInformation... joins)	Exports to CSV
<ID extends Serializable,T extends AbstractEntity<ID>> byte[]	exportCsvFixed(EntityModel<T> entityModel, ExportMode mode, List<T> items)	Exports a fixed set to CSV
<ID extends Serializable,T extends AbstractEntity<ID>> byte[]	exportCsvPivot(EntityModel<T> entityModel, com.vaadin.flow.function.SerializablePredicate<T> predicate, List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders, PivotParameters pivotParameters, FetchJoinInformation... joins)	Exports pivoted data to CSV
<ID extends Serializable,T extends AbstractEntity<ID>> byte[]	exportExcel(EntityModel<T> entityModel, ExportMode mode, com.vaadin.flow.function.SerializablePredicate<T> predicate, List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders, Supplier<CustomXlsStyleGenerator<ID,T>> customGenerator, FetchJoinInformation... joins)	Exports to Excel
<ID extends Serializable,T extends AbstractEntity<ID>> byte[]	exportExcelFixed(EntityModel<T> entityModel, ExportMode mode, Supplier<CustomXlsStyleGenerator<ID,T>> customGenerator, List<T> items)	Exports a fixed set to Excel
<ID extends Serializable,T extends AbstractEntity<ID>> byte[]	exportExcelPivot(EntityModel<T> entityModel, com.vaadin.flow.function.SerializablePredicate<T> predicate, List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders, Supplier<CustomXlsStyleGenerator<ID,T>> customGenerator, PivotParameters pivotParameters, FetchJoinInformation... joins)

Method Detail

exportCsv

<ID extends Serializable,T extends AbstractEntity<ID>> byte[] exportCsv(EntityModel<T> entityModel,
                                                                              ExportMode mode,
                                                                              com.vaadin.flow.function.SerializablePredicate<T> predicate,
                                                                              List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders,
                                                                              FetchJoinInformation... joins)

Exports to CSV

Parameters:

entityModel - the entity model of the entity to export

predicate - the predicate

sortOrders - the list of sort orders

joins - the joins to use when fetching data

Returns:

exportCsvFixed

<ID extends Serializable,T extends AbstractEntity<ID>> byte[] exportCsvFixed(EntityModel<T> entityModel,
                                                                                   ExportMode mode,
                                                                                   List<T> items)

Exports a fixed set to CSV

Parameters:

entityModel - the entity model

mode - the export mode

items - the set of items to export

Returns:

exportCsvPivot

<ID extends Serializable,T extends AbstractEntity<ID>> byte[] exportCsvPivot(EntityModel<T> entityModel,
                                                                                   com.vaadin.flow.function.SerializablePredicate<T> predicate,
                                                                                   List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders,
                                                                                   PivotParameters pivotParameters,
                                                                                   FetchJoinInformation... joins)

Exports pivoted data to CSV

Type Parameters:

ID -

T -

Parameters:

entityModel -

mode -

predicate -

sortOrders -

pivotParameters -

joins -

Returns:

exportExcel

<ID extends Serializable,T extends AbstractEntity<ID>> byte[] exportExcel(EntityModel<T> entityModel,
                                                                                ExportMode mode,
                                                                                com.vaadin.flow.function.SerializablePredicate<T> predicate,
                                                                                List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders,
                                                                                Supplier<CustomXlsStyleGenerator<ID,T>> customGenerator,
                                                                                FetchJoinInformation... joins)

Exports to Excel

Parameters:

entityModel - the entity model of the entity to export

predicate - the predicate

mode - the desired export mode

sortOrders - the list of sort orders

customGenerator - the custom style generator *

joins - the joins to use when fetching data

Returns:

exportExcelFixed

<ID extends Serializable,T extends AbstractEntity<ID>> byte[] exportExcelFixed(EntityModel<T> entityModel,
                                                                                     ExportMode mode,
                                                                                     Supplier<CustomXlsStyleGenerator<ID,T>> customGenerator,
                                                                                     List<T> items)

Exports a fixed set to Excel

Parameters:

entityModel - the entity model

mode - the export mode

items - the set of items to export

Returns:

exportExcelPivot

<ID extends Serializable,T extends AbstractEntity<ID>> byte[] exportExcelPivot(EntityModel<T> entityModel,
                                                                                     com.vaadin.flow.function.SerializablePredicate<T> predicate,
                                                                                     List<com.vaadin.flow.data.provider.SortOrder<?>> sortOrders,
                                                                                     Supplier<CustomXlsStyleGenerator<ID,T>> customGenerator,
                                                                                     PivotParameters pivotParameters,
                                                                                     FetchJoinInformation... joins)

Type Parameters:

ID -

T -

Parameters:

entityModel -

mode -

predicate -

sortOrders -

customGenerator -

pivotParameters -

joins -

Returns: