Package io.jmix.gridexportflowui.exporter

Class AbstractDataGridExporter<T extends AbstractDataGridExporter<?>>

java.lang.Object

io.jmix.gridexportflowui.exporter.AbstractDataGridExporter<T>

All Implemented Interfaces:

DataGridExporter

Direct Known Subclasses:

ExcelExporter, JsonExporter

public abstract class AbstractDataGridExporter<T extends AbstractDataGridExporter<?>>
extends Object
implements DataGridExporter

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.gridexportflowui.exporter.DataGridExporter

DataGridExporter.ColumnValueContext

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Function<DataGridExporter.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
AbstractDataGridExporter()

Method Summary

Modifier and Type	Method	Description
void	addColumnValueProvider(String columnId, Function<DataGridExporter.ColumnValueContext,Object> columnValueProvider)	Adds a function to get value from the column.
protected Function<Object,InstanceContainer<Object>>	createInstanceContainerProvider(com.vaadin.flow.component.grid.Grid<?> dataGrid, Object item)
protected String	formatValue(Object cellValue)
protected String	formatValue(Object cellValue, MetaPropertyPath metaPropertyPath)
protected Object	getColumnValue(com.vaadin.flow.component.grid.Grid<?> dataGrid, com.vaadin.flow.component.grid.Grid.Column<?> column, Object instance)
Function<DataGridExporter.ColumnValueContext,Object>	getColumnValueProvider(String columnId)
String	getFileName()
protected String	getFileName(com.vaadin.flow.component.grid.Grid<Object> dataGrid)
protected String	getMetaClassName(MetaClass metaClass)
void	removeColumnValueProvider(String columnId)	Removes an column value provider function by column id.
void	setCoreProperties(CoreProperties coreProperties)
void	setDatatypeRegistry(DatatypeRegistry datatypeRegistry)
void	setFileName(String fileName)
void	setMessages(Messages messages)
void	setMessageTools(MessageTools messageTools)
void	setMetadataTools(MetadataTools metadataTools)
void	setUiProperties(UiProperties uiProperties)
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.gridexportflowui.exporter.DataGridExporter

exportDataGrid, getLabel

Field Details

messageTools

protected MessageTools messageTools

datatypeRegistry

protected DatatypeRegistry datatypeRegistry

messages

protected Messages messages

metadataTools

protected MetadataTools metadataTools

uiProperties

protected UiProperties uiProperties

coreProperties

protected CoreProperties coreProperties

fileName

protected String fileName

columnValueProviders

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

Constructor Details

AbstractDataGridExporter

public AbstractDataGridExporter()

Method Details

setMessageTools

@Autowired
public void setMessageTools(MessageTools messageTools)

setDatatypeRegistry

@Autowired
public void setDatatypeRegistry(DatatypeRegistry datatypeRegistry)

setMessages

@Autowired
public void setMessages(Messages messages)

setMetadataTools

@Autowired
public void setMetadataTools(MetadataTools metadataTools)

setUiProperties

@Autowired
public void setUiProperties(UiProperties uiProperties)

setCoreProperties

@Autowired
public void setCoreProperties(CoreProperties coreProperties)

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

withFileName

public T withFileName(String fileName)

addColumnValueProvider

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

Description copied from interface: DataGridExporter

Adds a function to get value from the column.

Specified by:

addColumnValueProvider in interface DataGridExporter

Parameters:

columnId - column id

columnValueProvider - column value provider function

removeColumnValueProvider

public void removeColumnValueProvider(String columnId)

Description copied from interface: DataGridExporter

Removes an column value provider function by column id.

Specified by:

removeColumnValueProvider in interface DataGridExporter

Parameters:

columnId - column id

getColumnValueProvider

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

Specified by:

getColumnValueProvider in interface DataGridExporter

Parameters:

columnId - column id

Returns:

column value provider function for the column id

getMetaClassName

protected String getMetaClassName(MetaClass metaClass)

getFileName

protected String getFileName(com.vaadin.flow.component.grid.Grid<Object> dataGrid)

getColumnValue

@Nullable
protected Object getColumnValue(com.vaadin.flow.component.grid.Grid<?> dataGrid,
 com.vaadin.flow.component.grid.Grid.Column<?> column,
 Object instance)

createInstanceContainerProvider

protected Function<Object,InstanceContainer<Object>> createInstanceContainerProvider(com.vaadin.flow.component.grid.Grid<?> dataGrid,
 Object item)

formatValue

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

formatValue

protected String formatValue(@Nullable
 Object cellValue)