Package io.jmix.gridexportui.exporter

Class AbstractTableExporter<T extends AbstractTableExporter>

java.lang.Object

io.jmix.gridexportui.exporter.AbstractTableExporter<T>

All Implemented Interfaces:

TableExporter

Direct Known Subclasses:

ExcelExporter, JsonExporter

public abstract class AbstractTableExporter<T extends AbstractTableExporter>
extends Object
implements TableExporter

Base table exporter class.
Just create an instance of ExportAction with withExporter method.

Nested Class Summary

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

TableExporter.ColumnValueContext

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Function<TableExporter.ColumnValueContext,Object>>	columnValueProviders
protected CoreProperties	coreProperties
protected DatatypeRegistry	datatypeRegistry
protected String	fileName
protected Messages	messages
protected MessageTools	messageTools
protected MetadataTools	metadataTools
protected UiProperties	uiProperties

Constructor Summary

Constructors

Constructor	Description
AbstractTableExporter()

Method Summary

Modifier and Type	Method	Description
void	addColumnValueProvider(String columnId, Function<TableExporter.ColumnValueContext,Object> columnValueProvider)	Adds a function to get value from the column.
protected Function<Object,InstanceContainer<Object>>	createInstanceContainerProvider(DataGrid dataGrid, Object item)
protected String	formatValue(Object cellValue)
protected String	formatValue(Object cellValue, MetaPropertyPath metaPropertyPath)
protected Object	getColumnValue(DataGrid dataGrid, DataGrid.Column column, Object instance)
protected Object	getColumnValue(Table table, Table.Column column, Object instance)
Function<TableExporter.ColumnValueContext,Object>	getColumnValueProvider(String columnId)
String	getFileName()
protected String	getFileName(DataGrid<Object> dataGrid)
protected String	getFileName(Table<Object> table)
protected String	getMetaClassName(MetaClass metaClass)
void	removeColumnValueProvider(String columnId)	Removes an column value provider function by column id.
void	setFileName(String fileName)
T	withFileName(String fileName)

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.TableExporter

exportDataGrid, exportTable, getCaption

Field Details

messageTools

@Autowired
protected MessageTools messageTools

messages

@Autowired
protected Messages messages

metadataTools

@Autowired
protected MetadataTools metadataTools

datatypeRegistry

@Autowired
protected DatatypeRegistry datatypeRegistry

uiProperties

@Autowired
protected UiProperties uiProperties

coreProperties

@Autowired
protected CoreProperties coreProperties

fileName

protected String fileName

columnValueProviders

protected Map<String,Function<TableExporter.ColumnValueContext,Object>> columnValueProviders

Constructor Details

AbstractTableExporter

public AbstractTableExporter()

Method Details

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

withFileName

public T withFileName(String fileName)

addColumnValueProvider

public void addColumnValueProvider(String columnId,
 Function<TableExporter.ColumnValueContext,Object> columnValueProvider)

Description copied from interface: TableExporter

Adds a function to get value from the column.

Specified by:

addColumnValueProvider in interface TableExporter

Parameters:

columnId - column id

columnValueProvider - column value provider function

removeColumnValueProvider

public void removeColumnValueProvider(String columnId)

Description copied from interface: TableExporter

Removes an column value provider function by column id.

Specified by:

removeColumnValueProvider in interface TableExporter

Parameters:

columnId - column id

getColumnValueProvider

@Nullable
public Function<TableExporter.ColumnValueContext,Object> getColumnValueProvider(String columnId)

Specified by:

getColumnValueProvider in interface TableExporter

Parameters:

columnId - column id

Returns:

column value provider function for the column id

getMetaClassName

protected String getMetaClassName(MetaClass metaClass)

getFileName

protected String getFileName(Table<Object> table)

getFileName

protected String getFileName(DataGrid<Object> dataGrid)

getColumnValue

@Nullable
protected Object getColumnValue(Table table,
 Table.Column column,
 Object instance)

getColumnValue

@Nullable
protected Object getColumnValue(DataGrid dataGrid,
 DataGrid.Column column,
 Object instance)

createInstanceContainerProvider

protected Function<Object,InstanceContainer<Object>> createInstanceContainerProvider(DataGrid dataGrid,
 Object item)

formatValue

protected String formatValue(@Nullable
 Object cellValue,
 MetaPropertyPath metaPropertyPath)

formatValue

protected String formatValue(@Nullable
 Object cellValue)