Package com.inductiveautomation.rm.out
Class RMExcelWriterXlsx
- java.lang.Object
-
- com.inductiveautomation.rm.out.RMExcelWriterXlsx
-
- All Implemented Interfaces:
ExcelAdapter<RMDocument,org.apache.poi.xssf.usermodel.XSSFWorkbook>
public class RMExcelWriterXlsx extends java.lang.Object implements ExcelAdapter<RMDocument,org.apache.poi.xssf.usermodel.XSSFWorkbook>
This class is used to generate an Excel file from an RMDocument. You simply invoke this with: new RMExcelWriter().getBytes(aDoc);
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.util.excel.adapters.ExcelAdapter
ExcelAdapter.KnownTypes
-
-
Constructor Summary
Constructors Constructor Description RMExcelWriterXlsx()
Creates a basic xlsx excel writer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
drawSheet(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook, java.lang.String sheetName, RMDocument document, boolean headerRow, boolean nullsEmpty)
Draws aSheet
for the specificExcelAdapter
org.apache.poi.xssf.usermodel.XSSFWorkbook
drawWorkbook(boolean headerRow, boolean nullsEmpty, RMDocument... documents)
Draws the supplied object(s)ExcelAdapter
and returnsExcelAdapter
byte[]
getBytes(RMDocument aDoc)
Returns a byte array of an Excel file (.xls) for the given RMDocument.
-
-
-
Method Detail
-
drawWorkbook
public org.apache.poi.xssf.usermodel.XSSFWorkbook drawWorkbook(boolean headerRow, boolean nullsEmpty, RMDocument... documents)
Description copied from interface:ExcelAdapter
Draws the supplied object(s)ExcelAdapter
and returnsExcelAdapter
- Specified by:
drawWorkbook
in interfaceExcelAdapter<RMDocument,org.apache.poi.xssf.usermodel.XSSFWorkbook>
- Parameters:
headerRow
- iftrue
, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.nullsEmpty
- iftrue
, null values will not be written to cells in the excel document. It is up to the implementation whether this is respected or not.documents
- The object(s) that the Adapter is compatible with for writing.- Returns:
- A
Workbook
of typeU
that can be closed or further manipulated.
-
drawSheet
public boolean drawSheet(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook, java.lang.String sheetName, RMDocument document, boolean headerRow, boolean nullsEmpty)
Description copied from interface:ExcelAdapter
Draws aSheet
for the specificExcelAdapter
- Specified by:
drawSheet
in interfaceExcelAdapter<RMDocument,org.apache.poi.xssf.usermodel.XSSFWorkbook>
- Parameters:
workbook
- the Workbook to add the new sheet tosheetName
- the name of the sheet. This name should be checked viaWorkbookUtil.createSafeSheetName(String)
document
- the object to write to the sheetheaderRow
- iftrue
, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.nullsEmpty
- iftrue
, 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.
-
getBytes
public byte[] getBytes(RMDocument aDoc)
Returns a byte array of an Excel file (.xls) for the given RMDocument.- Parameters:
aDoc
- the RMDocument to retrieve the bytes from. Must not be null- Returns:
- the byte array of the contents of the document
-
-