io.jmix.uiexport.exporter

Class AbstractTableExporter<T extends AbstractTableExporter>

java.lang.Object

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

All Implemented Interfaces:

TableExporter

Direct Known Subclasses:

ExcelExporter, JsonExporter

public abstract class AbstractTableExporter<T extends AbstractTableExporter>
extends java.lang.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.uiexport.exporter.TableExporter

TableExporter.ColumnValueContext

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object>>	columnValueProviders
protected io.jmix.core.CoreProperties	coreProperties
protected io.jmix.core.metamodel.datatype.DatatypeRegistry	datatypeRegistry
protected java.lang.String	fileName
protected io.jmix.core.Messages	messages
protected io.jmix.core.MessageTools	messageTools
protected io.jmix.core.MetadataTools	metadataTools
protected UiProperties	uiProperties

Constructor Summary

Constructors

Constructor and Description
AbstractTableExporter()

Method Summary

Modifier and Type	Method and Description
void	addColumnValueProvider(java.lang.String columnId, java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object> columnValueProvider) Adds a function to get value from the column.
protected java.util.function.Function<java.lang.Object,InstanceContainer<java.lang.Object>>	createInstanceContainerProvider(DataGrid dataGrid, java.lang.Object item)
protected java.lang.String	formatValue(java.lang.Object cellValue, io.jmix.core.metamodel.model.MetaPropertyPath metaPropertyPath)
protected java.lang.Object	getColumnValue(DataGrid dataGrid, DataGrid.Column column, java.lang.Object instance)
protected java.lang.Object	getColumnValue(Table table, Table.Column column, java.lang.Object instance)
java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object>	getColumnValueProvider(java.lang.String columnId)
java.lang.String	getFileName()
protected java.lang.String	getFileName(DataGrid<java.lang.Object> dataGrid)
protected java.lang.String	getFileName(Table<java.lang.Object> table)
protected java.lang.String	getMetaClassName(io.jmix.core.metamodel.model.MetaClass metaClass)
void	removeColumnValueProvider(java.lang.String columnId) Removes an column value provider function by column id.
void	setFileName(java.lang.String fileName)
T	withFileName(java.lang.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.uiexport.exporter.TableExporter

exportDataGrid, exportTable, getCaption

Field Detail

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

messages

@Autowired
protected io.jmix.core.Messages messages

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

datatypeRegistry

@Autowired
protected io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry

uiProperties

@Autowired
protected UiProperties uiProperties

coreProperties

@Autowired
protected io.jmix.core.CoreProperties coreProperties

fileName

protected java.lang.String fileName

columnValueProviders

protected java.util.Map<java.lang.String,java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object>> columnValueProviders

Constructor Detail

AbstractTableExporter

public AbstractTableExporter()

Method Detail

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

withFileName

public T withFileName(java.lang.String fileName)

addColumnValueProvider

public void addColumnValueProvider(java.lang.String columnId,
                                   java.util.function.Function<TableExporter.ColumnValueContext,java.lang.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(java.lang.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 java.util.function.Function<TableExporter.ColumnValueContext,java.lang.Object> getColumnValueProvider(java.lang.String columnId)

Specified by:

getColumnValueProvider in interface TableExporter

Parameters:

columnId - column id

Returns:

column value provider function for the column id

getMetaClassName

protected java.lang.String getMetaClassName(io.jmix.core.metamodel.model.MetaClass metaClass)

getFileName

protected java.lang.String getFileName(Table<java.lang.Object> table)

getFileName

protected java.lang.String getFileName(DataGrid<java.lang.Object> dataGrid)

getColumnValue

protected java.lang.Object getColumnValue(Table table,
                                          Table.Column column,
                                          java.lang.Object instance)

getColumnValue

protected java.lang.Object getColumnValue(DataGrid dataGrid,
                                          DataGrid.Column column,
                                          java.lang.Object instance)

createInstanceContainerProvider

protected java.util.function.Function<java.lang.Object,InstanceContainer<java.lang.Object>> createInstanceContainerProvider(DataGrid dataGrid,
                                                                                                                            java.lang.Object item)

formatValue

protected java.lang.String formatValue(@Nullable
                                       java.lang.Object cellValue,
                                       io.jmix.core.metamodel.model.MetaPropertyPath metaPropertyPath)