Package com.inductiveautomation.ignition.common.util.excel.adapters

Class DatasetExcelAdapter

java.lang.Object

com.inductiveautomation.ignition.common.util.excel.adapters.DatasetExcelAdapter

All Implemented Interfaces:

ExcelAdapter<Dataset,org.apache.poi.xssf.streaming.SXSSFWorkbook>

public class DatasetExcelAdapter
extends java.lang.Object
implements ExcelAdapter<Dataset,org.apache.poi.xssf.streaming.SXSSFWorkbook>

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.util.excel.adapters.ExcelAdapter

ExcelAdapter.KnownTypes

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_ROWS_IN_MEMORY

Constructor Summary

Constructors

Constructor	Description
DatasetExcelAdapter()

Method Summary

Modifier and Type	Method	Description
boolean	drawSheet(org.apache.poi.xssf.streaming.SXSSFWorkbook workbook, java.lang.String sheetName, Dataset dataset, boolean headerRow, boolean nullsEmpty)	Draws a Sheet for the specific ExcelAdapter
org.apache.poi.xssf.streaming.SXSSFWorkbook	drawWorkbook(boolean headerRow, boolean nullsEmpty, Dataset[] datasets, java.lang.String[] sheetNames)	Draws the supplied object(s) ExcelAdapter and returns ExcelAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.util.excel.adapters.ExcelAdapter

drawWorkbook

Field Detail

MAX_ROWS_IN_MEMORY

public static final int MAX_ROWS_IN_MEMORY

See Also:

Constant Field Values

Constructor Detail

DatasetExcelAdapter

public DatasetExcelAdapter()

Method Detail

drawWorkbook

public org.apache.poi.xssf.streaming.SXSSFWorkbook drawWorkbook(boolean headerRow,
                                                                boolean nullsEmpty,
                                                                Dataset[] datasets,
                                                                java.lang.String[] sheetNames)

Description copied from interface: ExcelAdapter

Draws the supplied object(s) ExcelAdapter and returns ExcelAdapter

Specified by:

drawWorkbook in interface ExcelAdapter<Dataset,org.apache.poi.xssf.streaming.SXSSFWorkbook>

Parameters:

headerRow - if true, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.

nullsEmpty - if true, null values will not be written to cells in the excel document. It is up to the implementation whether this is respected or not.

datasets - The object(s) that the Adapter is compatible with for writing.

sheetNames - The names of the sheets to create. If null, will use a generic default.

Returns:

A Workbook of type U that can be closed or further manipulated.

drawSheet

public boolean drawSheet(org.apache.poi.xssf.streaming.SXSSFWorkbook workbook,
                         java.lang.String sheetName,
                         Dataset dataset,
                         boolean headerRow,
                         boolean nullsEmpty)

Description copied from interface: ExcelAdapter

Draws a Sheet for the specific ExcelAdapter

Specified by:

drawSheet in interface ExcelAdapter<Dataset,org.apache.poi.xssf.streaming.SXSSFWorkbook>

Parameters:

workbook - the Workbook to add the new sheet to

sheetName - the name of the sheet. This name should be checked via WorkbookUtil.createSafeSheetName(String)

dataset - the object to write to the sheet

headerRow - if true, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.

nullsEmpty - if true, null values will not be written to cells in the excel document. It is up to the implementation whether this is respected or not.

Returns:

true if the object was successfully written to the workbook as a new sheet, false if the object was not written successfully.