[test] updated Spreadsheet write from Map data tests for xls and xlsx

millij · millij · commit 2e4e91c6abba · 2025-01-24T16:57:07.000+05:30
diff --git a/src/main/java/io/github/millij/poi/ss/writer/AbstractSpreadsheetWriter.java b/src/main/java/io/github/millij/poi/ss/writer/AbstractSpreadsheetWriter.java
@@ -52,14 +52,14 @@ public AbstractSpreadsheetWriter(final Workbook workbook) {
     // ------------------------------------------------------------------------
 
 
-    // Sheet :: Add
+    // Sheet :: Bean
 
     @Override
     public <T> void addSheet(final Class<T> beanType, final List<T> rowObjects, final String inSheetName,
             final List<String> inHeaders) {
         // Sanity checks
         if (Objects.isNull(beanType)) {
-            throw new IllegalArgumentException("AbstractSpreadsheetWriter :: Bean Type is NULL");
+            throw new IllegalArgumentException("#addSheet :: Bean Type is NULL");
         }
 
         // Sheet config
@@ -110,15 +110,18 @@ public <T> void addSheet(final Class<T> beanType, final List<T> rowObjects, fina
         }
     }
 
+
+    // Sheet :: Map<String, Object>
+
     @Override
-    public void addSheet(final String inSheetName, final List<String> inHeaders,
-            final List<Map<String, String>> rowsData) {
+    public void addSheet(final List<Map<String, Object>> rowsData, final String inSheetName,
+            final List<String> inHeaders) {
         // Sanity check
         if (Objects.isNull(rowsData)) {
-            throw new IllegalArgumentException("AbstractSpreadsheetWriter :: Rows data map is NULL");
+            throw new IllegalArgumentException("#addSheet :: Rows data map is NULL");
         }
-        if (Objects.isNull(inHeaders)) {
-            throw new IllegalArgumentException("AbstractSpreadsheetWriter :: Headers list is NULL");
+        if (Objects.isNull(inHeaders) || inHeaders.isEmpty()) {
+            throw new IllegalArgumentException("#addSheet :: Headers list is NULL or EMPTY");
         }
 
         try {
@@ -144,19 +147,19 @@ public void addSheet(final String inSheetName, final List<String> inHeaders,
             // Data Rows
             for (int i = 0, rowNum = 1; i < rowsData.size(); i++, rowNum++) {
                 final Row row = sheet.createRow(rowNum);
-                final Map<String, String> rowData = rowsData.get(i);
-
-                // Skip if row is null
-                if (Objects.isNull(rowData)) {
-                    continue;
+                final Map<String, Object> rowData = rowsData.get(i);
+                if (Objects.isNull(rowData) || rowData.isEmpty()) {
+                    continue; // Skip if row is null
                 }
 
                 for (int cellNum = 0; cellNum < inHeaders.size(); cellNum++) {
                     final String key = inHeaders.get(cellNum);
-                    final String value = rowData.get(key);
+                    final Object value = rowData.get(key);
 
                     final Cell cell = row.createCell(cellNum);
-                    cell.setCellValue(value);
+                    if (Objects.nonNull(value)) {
+                        cell.setCellValue(String.valueOf(value));
+                    }
                 }
             }
         } catch (Exception ex) {
@@ -166,18 +169,21 @@ public void addSheet(final String inSheetName, final List<String> inHeaders,
     }
 
 
-    // Sheet :: Append to existing
-
-
     // Write
 
     @Override
-    public void write(final String filepath) throws IOException {
-        try (final OutputStream outputStrem = new FileOutputStream(new File(filepath))) {
+    public void write(final File file) throws IOException {
+        // Sanity checks
+        if (Objects.isNull(file)) {
+            throw new IllegalArgumentException("#write :: Input File object is NULL");
+        }
+
+        try (final OutputStream outputStrem = new FileOutputStream(file)) {
             workbook.write(outputStrem);
             workbook.close();
+
         } catch (Exception ex) {
-            final String errMsg = String.format("Failed to write workbook data to file : %s", filepath);
+            final String errMsg = String.format("Failed to write workbook data to file : %s", file.getPath());
             LOGGER.error(errMsg);
             throw ex;
         }
diff --git a/src/main/java/io/github/millij/poi/ss/writer/SpreadsheetWriter.java b/src/main/java/io/github/millij/poi/ss/writer/SpreadsheetWriter.java
@@ -1,9 +1,12 @@
 package io.github.millij.poi.ss.writer;
 
+import java.io.File;
 import java.io.IOException;
 import java.util.List;
 import java.util.Map;
 
+import org.apache.logging.log4j.util.Strings;
+
 
 /**
  * Representation of a Spreadsheet Writer. To write data to files, create a new Instance of {@link SpreadsheetWriter},
@@ -13,9 +16,12 @@
  */
 public interface SpreadsheetWriter {
 
+    //
+    // Add Sheet :: Beans
+
     /**
-     * This method will attempt to add a new sheet and add the beans a rows of data. To write the data to a file, call
-     * {@link #write(String)} method once the data addition is completed.
+     * Add a new sheet and add the beans a rows of data. To write the data to a file, call {@link #write(String)} method
+     * once the data addition is completed.
      * 
      * <br/>
      * <b>Sheet Name</b> : default sheet name will be used
@@ -31,8 +37,8 @@ default <T> void addSheet(Class<T> beanClz, List<T> beans) {
     }
 
     /**
-     * This method will attempt to add a new sheet and add the beans a rows of data. To write the data to a file, call
-     * {@link #write(String)} method once the data addition is completed.
+     * Add a new sheet and add the beans a rows of data. To write the data to a file, call {@link #write(String)} method
+     * once the data addition is completed.
      * 
      * <br/>
      * <b>Headers</b> : all possible properties as defined by the Type will be used as headers
@@ -46,8 +52,8 @@ default <T> void addSheet(Class<T> beanClz, List<T> beans, String sheetName) {
     }
 
     /**
-     * This method will attempt to add a new sheet and add the beans a rows of data. To write the data to a file, call
-     * {@link #write(String)} method once the data addition is completed.
+     * Add a new sheet and add the beans a rows of data. To write the data to a file, call {@link #write(String)} method
+     * once the data addition is completed.
      * 
      * <br/>
      * <b>Sheet Name</b> : default sheet name will be used
@@ -61,9 +67,10 @@ default <T> void addSheet(Class<T> beanClz, List<T> beans, List<String> headers)
         this.addSheet(beanClz, beans, null, headers);
     }
 
+
     /**
-     * This method will attempt to add a new sheet and add the beans a rows of data. To write the data to a file, call
-     * {@link #write(String)} method once the data addition is completed.
+     * Add a new sheet and add the beans a rows of data. To write the data to a file, call {@link #write(String)} method
+     * once the data addition is completed.
      * 
      * @param beanClz The Class type to serialize the rows data
      * @param beans List of Data beans of the parameterized type
@@ -74,27 +81,58 @@ default <T> void addSheet(Class<T> beanClz, List<T> beans, List<String> headers)
     <T> void addSheet(Class<T> beanClz, List<T> beans, String sheetName, List<String> headers);
 
 
+    //
+    // Add Sheet :: Map<String, Object>
+
+    /**
+     * Add a new sheet and add the rows of data defined by a {@link Map}. The <code>null</code> entry in the rows data
+     * list will be skipped and no rows will be added to the sheet.
+     * 
+     * @param rowsData List of Rows defined by a {@link Map}s where the map key is header and value is the row value
+     * @param headers a {@link List} of Header names to write in the file
+     */
+    default void addSheet(List<Map<String, Object>> rowsData, List<String> headers) {
+        this.addSheet(rowsData, null, headers);
+    }
+
     /**
-     * This method will attempt to add a new sheet and add the rows of data from the rows data. The
-     * <code>null</code> entry in the rows data list will be skipped and no rows will be added to the
-     * sheet.
+     * Add a new sheet and add the rows of data defined by a {@link Map}. The <code>null</code> entry in the rows data
+     * list will be skipped and no rows will be added to the sheet.
      * 
+     * @param rowsData List of Rows defined by a {@link Map}s where the map key is header and value is the row value
      * @param sheetName Name of the Sheet. (set it to <code>null</code> for default name)
-     * @param headers a {@link List} of Header names to write in the file. <code>null</code> or empty
-     *        list will default to all writable properties.
-     * @param rowsData List of Map, representing the sheet data. Each Map represents the row data where
-     *        the map elements stores a value for a header as key.
+     * @param headers a {@link List} of Header names to write in the file
      */
-    void addSheet(String sheetName, List<String> headers, List<Map<String, String>> rowsData);
+    void addSheet(List<Map<String, Object>> rowsData, String sheetName, List<String> headers);
 
 
+    //
+    // Write
+
     /**
      * Writes the current Spreadsheet workbook to a file in the specified path.
      * 
      * @param filepath output filepath (including filename).
      * 
      * @throws IOException if the filepath is not writable.
      */
-    void write(String filepath) throws IOException;
+    default void write(final String filepath) throws IOException {
+        // Sanity checks
+        if (Strings.isBlank(filepath)) {
+            throw new IllegalArgumentException("#write :: Input File Path is BLANK");
+        }
+
+        this.write(new File(filepath));
+    }
+
+    /**
+     * Writes the current Spreadsheet workbook to a file
+     * 
+     * @param fiel output file
+     * 
+     * @throws IOException if the file is not writable.
+     */
+    void write(File file) throws IOException;
+
 
 }
diff --git a/src/test/java/io/github/millij/poi/ss/reader/XlsReaderTest.java b/src/test/java/io/github/millij/poi/ss/reader/XlsReaderTest.java
@@ -163,7 +163,7 @@ public void test_read_xls_single_sheet_with_callback() throws SpreadsheetReadExc
 
         // Read
         XlsReader reader = new XlsReader();
-        reader.read(Employee.class, xlsFile, new RowListener<>() {
+        reader.read(Employee.class, xlsFile, new RowListener<Employee>() {
 
             @Override
             public void row(int rowNum, Employee employee) {
diff --git a/src/test/java/io/github/millij/poi/ss/reader/XlsxReaderTest.java b/src/test/java/io/github/millij/poi/ss/reader/XlsxReaderTest.java
@@ -163,7 +163,7 @@ public void test_read_xlsx_single_sheet_with_callback() throws SpreadsheetReadEx
 
         // Read
         final XlsxReader reader = new XlsxReader();
-        reader.read(Employee.class, xlsxFile, new RowListener<>() {
+        reader.read(Employee.class, xlsxFile, new RowListener<Employee>() {
 
             @Override
             public void row(int rowNum, Employee employee) {
diff --git a/src/test/java/io/github/millij/poi/ss/writer/XlsWriterTest.java b/src/test/java/io/github/millij/poi/ss/writer/XlsWriterTest.java
diff --git a/src/test/java/io/github/millij/poi/ss/writer/XlsxWriterTest.java b/src/test/java/io/github/millij/poi/ss/writer/XlsxWriterTest.java
