io.jmix.pivottable.component.impl

Class PivotExcelExporter

java.lang.Object

io.jmix.pivottable.component.impl.PivotExcelExporter

@Component(value="ui_PivotExcelExporter")
 @Scope(value="prototype")
public class PivotExcelExporter
extends java.lang.Object

Exports PivotData to XLS file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PivotExcelExporter.ExportFormat

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.poi.ss.usermodel.CellStyle	boldCellDateStyle
protected org.apache.poi.ss.usermodel.CellStyle	boldCellDateTimeStyle
protected org.apache.poi.ss.usermodel.CellStyle	boldCellDoubleStyle
protected org.apache.poi.ss.usermodel.CellStyle	boldCellIntegerStyle
protected org.apache.poi.ss.usermodel.CellStyle	boldCellTimeStyle
protected org.apache.poi.ss.usermodel.CellStyle	cellDateStyle
protected org.apache.poi.ss.usermodel.CellStyle	cellDateTimeStyle
protected org.apache.poi.ss.usermodel.CellStyle	cellDoubleStyle
protected org.apache.poi.ss.usermodel.CellStyle	cellIntegerStyle
protected org.apache.poi.ss.usermodel.CellStyle	cellLabelBoldStyle
protected org.apache.poi.ss.usermodel.CellStyle	cellTimeStyle
protected static int	COLUMN_WIDTH_MULTIPLIER CAUTION Magic number! This multiplier is used for calculating column width.
protected io.jmix.core.CoreProperties	coreProperties
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected io.jmix.core.metamodel.datatype.DatatypeRegistry	datatypeRegistry
protected java.text.SimpleDateFormat	dateFormatter
protected java.lang.String	dateParseFormat
protected java.text.SimpleDateFormat	dateTimeFormatter
protected java.lang.String	dateTimeParseFormat
static java.lang.String	DEFAULT_FILE_NAME
protected Downloader	downloader
protected io.jmix.core.metamodel.model.MetaClass	entityMetaClass
protected PivotExcelExporter.ExportFormat	exportFormat
protected java.lang.String	fileName
static int	MAX_ROW_INDEX
protected io.jmix.core.Messages	messages
protected io.jmix.core.MessageTools	messageTools
protected Notifications	notifications
protected org.apache.poi.ss.usermodel.Sheet	sheet
protected org.apache.poi.ss.usermodel.Font	stdFont
protected java.text.SimpleDateFormat	timeFormatter
protected java.lang.String	timeParseFormat
protected UiProperties	uiProperties
protected org.apache.poi.ss.usermodel.Workbook	wb

Constructor Summary

Constructors

Constructor and Description
PivotExcelExporter()
PivotExcelExporter(PivotTable pivotTable)

Method Summary

Modifier and Type	Method and Description
protected void	createCellsStyle()
protected void	createRows(PivotData pivotData)
protected void	createWorkbookWithSheet()
protected void	export(Downloader downloader)
void	exportPivotTable(PivotData pivotData, java.lang.String fileName) Exports pivot table data to the excel file.
void	exportPivotTable(PivotData pivotData, java.lang.String fileName, Downloader downloader) Exports pivot table data to the excel file.
protected short	getBuiltinFormat(java.lang.String format)
java.lang.String	getDateParseFormat()
java.lang.String	getDateTimeParseFormat()
PivotExcelExporter.ExportFormat	getExportFormat()
java.lang.String	getTimeParseFormat()
void	init(PivotTable pivotTable)
protected void	initCell(org.apache.poi.ss.usermodel.Cell excelCell, PivotDataSeparatedCell cell)
protected void	initDateTimeCell(org.apache.poi.ss.usermodel.Cell excelCell, PivotDataSeparatedCell cell, java.text.SimpleDateFormat formatter, org.apache.poi.ss.usermodel.CellStyle cellStyle, org.apache.poi.ss.usermodel.CellStyle boldCellStyle)
protected void	initNotifications(PivotTable pivotTable)
protected boolean	isPivotDataEmpty(PivotData pivotData)
boolean	isXlsMaxRowNumberExceeded(PivotData pivotData)
void	setDateParseFormat(java.lang.String dateParseFormat) Sets date format that will be used to finding dateTime value and exporting it to excel with date type.
void	setDateTimeParseFormat(java.lang.String dateTimeParseFormat) Sets dateTime format that will be used to finding dateTime value and exporting it to excel with dateTime type.
void	setDownloader(Downloader downloader)
void	setExportFormat(PivotExcelExporter.ExportFormat exportFormat) Sets export format XLS or XLSX.
void	setMessages(io.jmix.core.Messages messages)
void	setTimeParseFormat(java.lang.String timeParseFormat) Sets date format that will be used to finding dateTime value and exporting it to excel with date type.
protected void	showNoDataWarning()
protected void	showWarnNotification()
protected void	updateColumnSize(ExcelAutoColumnSizer[] sizers, PivotDataSeparatedCell cell)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ROW_INDEX

public static final int MAX_ROW_INDEX

See Also:

Constant Field Values

COLUMN_WIDTH_MULTIPLIER

protected static final int COLUMN_WIDTH_MULTIPLIER

CAUTION Magic number! This multiplier is used for calculating column width. Without this multiplier all columns in the file will be collapsed.

See Also:

Constant Field Values

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

See Also:

Constant Field Values

exportFormat

protected PivotExcelExporter.ExportFormat exportFormat

wb

protected org.apache.poi.ss.usermodel.Workbook wb

sheet

protected org.apache.poi.ss.usermodel.Sheet sheet

stdFont

protected org.apache.poi.ss.usermodel.Font stdFont

cellLabelBoldStyle

protected org.apache.poi.ss.usermodel.CellStyle cellLabelBoldStyle

cellDateTimeStyle

protected org.apache.poi.ss.usermodel.CellStyle cellDateTimeStyle

boldCellDateTimeStyle

protected org.apache.poi.ss.usermodel.CellStyle boldCellDateTimeStyle

cellDateStyle

protected org.apache.poi.ss.usermodel.CellStyle cellDateStyle

boldCellDateStyle

protected org.apache.poi.ss.usermodel.CellStyle boldCellDateStyle

cellTimeStyle

protected org.apache.poi.ss.usermodel.CellStyle cellTimeStyle

boldCellTimeStyle

protected org.apache.poi.ss.usermodel.CellStyle boldCellTimeStyle

cellIntegerStyle

protected org.apache.poi.ss.usermodel.CellStyle cellIntegerStyle

boldCellIntegerStyle

protected org.apache.poi.ss.usermodel.CellStyle boldCellIntegerStyle

cellDoubleStyle

protected org.apache.poi.ss.usermodel.CellStyle cellDoubleStyle

boldCellDoubleStyle

protected org.apache.poi.ss.usermodel.CellStyle boldCellDoubleStyle

fileName

protected java.lang.String fileName

entityMetaClass

protected io.jmix.core.metamodel.model.MetaClass entityMetaClass

messages

protected io.jmix.core.Messages messages

downloader

protected Downloader downloader

dateTimeParseFormat

protected java.lang.String dateTimeParseFormat

dateTimeFormatter

protected java.text.SimpleDateFormat dateTimeFormatter

dateParseFormat

protected java.lang.String dateParseFormat

dateFormatter

protected java.text.SimpleDateFormat dateFormatter

timeParseFormat

protected java.lang.String timeParseFormat

timeFormatter

protected java.text.SimpleDateFormat timeFormatter

notifications

protected Notifications notifications

coreProperties

@Autowired
protected io.jmix.core.CoreProperties coreProperties

uiProperties

@Autowired
protected UiProperties uiProperties

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

datatypeRegistry

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

currentAuthentication

@Autowired
protected io.jmix.core.security.CurrentAuthentication currentAuthentication

Constructor Detail

PivotExcelExporter

public PivotExcelExporter(PivotTable pivotTable)

PivotExcelExporter

public PivotExcelExporter()

Method Detail

init

public void init(PivotTable pivotTable)

setMessages

@Autowired
public void setMessages(io.jmix.core.Messages messages)

setDownloader

@Autowired
public void setDownloader(Downloader downloader)

initNotifications

protected void initNotifications(PivotTable pivotTable)

exportPivotTable

public void exportPivotTable(PivotData pivotData,
                             java.lang.String fileName)

Exports pivot table data to the excel file. File format can be configured by setExportFormat(ExportFormat).

Parameters:

pivotData - pivot with aggregated data

fileName - file name

exportPivotTable

public void exportPivotTable(PivotData pivotData,
                             java.lang.String fileName,
                             Downloader downloader)

Exports pivot table data to the excel file. File format can be configured by setExportFormat(ExportFormat).

Parameters:

pivotData - pivot with aggregated data

fileName - file name

downloader - Downloader implementation

createRows

protected void createRows(PivotData pivotData)

initCell

protected void initCell(org.apache.poi.ss.usermodel.Cell excelCell,
                        PivotDataSeparatedCell cell)

updateColumnSize

protected void updateColumnSize(ExcelAutoColumnSizer[] sizers,
                                PivotDataSeparatedCell cell)

initDateTimeCell

protected void initDateTimeCell(org.apache.poi.ss.usermodel.Cell excelCell,
                                PivotDataSeparatedCell cell,
                                java.text.SimpleDateFormat formatter,
                                org.apache.poi.ss.usermodel.CellStyle cellStyle,
                                org.apache.poi.ss.usermodel.CellStyle boldCellStyle)

createWorkbookWithSheet

protected void createWorkbookWithSheet()

createCellsStyle

protected void createCellsStyle()

getBuiltinFormat

protected short getBuiltinFormat(java.lang.String format)

showWarnNotification

protected void showWarnNotification()

export

protected void export(Downloader downloader)

showNoDataWarning

protected void showNoDataWarning()

isPivotDataEmpty

protected boolean isPivotDataEmpty(PivotData pivotData)

isXlsMaxRowNumberExceeded

public boolean isXlsMaxRowNumberExceeded(PivotData pivotData)

Parameters:

pivotData - pivot with aggregated data

Returns:

true if exported table contains more than 65536 records

getDateTimeParseFormat

@Nullable
public java.lang.String getDateTimeParseFormat()

Returns:

dateTime format or null

setDateTimeParseFormat

public void setDateTimeParseFormat(java.lang.String dateTimeParseFormat)

Sets dateTime format that will be used to finding dateTime value and exporting it to excel with dateTime type.

Parameters:

dateTimeParseFormat - dateTime format (e.g. dd/MM/yyyy HH:mm)

getDateParseFormat

@Nullable
public java.lang.String getDateParseFormat()

Returns:

date format or null

setDateParseFormat

public void setDateParseFormat(java.lang.String dateParseFormat)

Sets date format that will be used to finding dateTime value and exporting it to excel with date type. If there is no format set, date properties will be recognized as text value.

Parameters:

dateParseFormat - date format (e.g. dd/MM/yyyy)

getTimeParseFormat

@Nullable
public java.lang.String getTimeParseFormat()

Returns:

time format or null

setTimeParseFormat

public void setTimeParseFormat(java.lang.String timeParseFormat)

Sets date format that will be used to finding dateTime value and exporting it to excel with date type. If there is no format set, time properties will be recognized as text value.

Parameters:

timeParseFormat - time format (e.g. HH:mm)

getExportFormat

public PivotExcelExporter.ExportFormat getExportFormat()

Returns:

export format XLS or XLSX

setExportFormat

public void setExportFormat(PivotExcelExporter.ExportFormat exportFormat)

Sets export format XLS or XLSX. The default value is XLSX.

Parameters:

exportFormat - format that should have exported file