io.jmix.uiexport.exporter.json

Class JsonExporter

java.lang.Object

io.jmix.uiexport.exporter.AbstractTableExporter<JsonExporter>

io.jmix.uiexport.exporter.json.JsonExporter

All Implemented Interfaces:

TableExporter

@Component(value="ui_JsonExporter")
 @Scope(value="prototype")
public class JsonExporter
extends AbstractTableExporter<JsonExporter>

Use this class to export Table into JSON format.
Just create an instance of ExportAction with withExporter method.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.uiexport.exporter.TableExporter

TableExporter.ColumnValueContext

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Function<com.google.gson.GsonBuilder,com.google.gson.GsonBuilder>	gsonConfigurer
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata

Fields inherited from class io.jmix.uiexport.exporter.AbstractTableExporter

columnValueProviders, coreProperties, datatypeRegistry, fileName, messageTools, metadataTools, uiProperties

Constructor Summary

Constructors

Constructor and Description
JsonExporter()

Method Summary

Modifier and Type	Method and Description
protected com.google.gson.Gson	createGsonForSerialization()
void	exportDataGrid(Downloader downloader, DataGrid<java.lang.Object> dataGrid, ExportMode exportMode) download dataGrid content via downloader
void	exportTable(Downloader downloader, Table<java.lang.Object> table, ExportMode exportMode) download table content via downloader
java.lang.String	getCaption() returns exporter caption
protected java.util.Collection<java.lang.Object>	getItems(DataGrid<java.lang.Object> dataGrid, ExportMode exportMode)
protected java.util.Collection<java.lang.Object>	getItems(Table<java.lang.Object> table, ExportMode exportMode)
JsonExporter	withGsonConfigurator(java.util.function.Function<com.google.gson.GsonBuilder,com.google.gson.GsonBuilder> gsonConfigurator) Configure Gson builder for export

Methods inherited from class io.jmix.uiexport.exporter.AbstractTableExporter

addColumnValueProvider, createInstanceContainerProvider, formatValue, getColumnValue, getColumnValue, getColumnValueProvider, getFileName, getFileName, getFileName, getMetaClassName, removeColumnValueProvider, setFileName, withFileName

Methods inherited from class java.lang.Object

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

Field Detail

messages

@Autowired
protected io.jmix.core.Messages messages

metadata

@Autowired
protected io.jmix.core.Metadata metadata

gsonConfigurer

protected java.util.function.Function<com.google.gson.GsonBuilder,com.google.gson.GsonBuilder> gsonConfigurer

Constructor Detail

JsonExporter

public JsonExporter()

Method Detail

withGsonConfigurator

public JsonExporter withGsonConfigurator(java.util.function.Function<com.google.gson.GsonBuilder,com.google.gson.GsonBuilder> gsonConfigurator)

Configure Gson builder for export

Parameters:

gsonConfigurator - Gson configurator function

Returns:

exporter instance

exportTable

public void exportTable(Downloader downloader,
                        Table<java.lang.Object> table,
                        ExportMode exportMode)

Description copied from interface: TableExporter

download table content via downloader

exportDataGrid

public void exportDataGrid(Downloader downloader,
                           DataGrid<java.lang.Object> dataGrid,
                           ExportMode exportMode)

Description copied from interface: TableExporter

download dataGrid content via downloader

createGsonForSerialization

protected com.google.gson.Gson createGsonForSerialization()

getItems

protected java.util.Collection<java.lang.Object> getItems(Table<java.lang.Object> table,
                                                          ExportMode exportMode)

getItems

protected java.util.Collection<java.lang.Object> getItems(DataGrid<java.lang.Object> dataGrid,
                                                          ExportMode exportMode)

getCaption

public java.lang.String getCaption()

Description copied from interface: TableExporter

returns exporter caption