Package com.inductiveautomation.rm.out

Class 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);

    • 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 a Sheet for the specific ExcelAdapter
      org.apache.poi.xssf.usermodel.XSSFWorkbook drawWorkbook​(boolean headerRow, boolean nullsEmpty, RMDocument[] documents, java.lang.String[] ignored)
      Draws the supplied object(s) ExcelAdapter and returns ExcelAdapter
      byte[] getBytes​(RMDocument aDoc)
      Returns a byte array of an Excel file (.xls) for the given RMDocument.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RMExcelWriterXlsx

        public RMExcelWriterXlsx()
        Creates a basic xlsx excel writer.

    • Method Detail

      • drawWorkbook

        public org.apache.poi.xssf.usermodel.XSSFWorkbook drawWorkbook​(boolean headerRow,
                                                               boolean nullsEmpty,
                                                               RMDocument[] documents,
                                                               java.lang.String[] ignored)
        Description copied from interface: ExcelAdapter
        Draws the supplied object(s) ExcelAdapter and returns ExcelAdapter
        Specified by:
        drawWorkbook in interface ExcelAdapter<RMDocument,​org.apache.poi.xssf.usermodel.XSSFWorkbook>
        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.
        documents - The object(s) that the Adapter is compatible with for writing.
        ignored - 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.usermodel.XSSFWorkbook workbook,
                         java.lang.String sheetName,
                         RMDocument document,
                         boolean headerRow,
                         boolean nullsEmpty)
        Description copied from interface: ExcelAdapter
        Draws a Sheet for the specific ExcelAdapter
        Specified by:
        drawSheet in interface ExcelAdapter<RMDocument,​org.apache.poi.xssf.usermodel.XSSFWorkbook>
        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)
        document - 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.

      • 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