Merge pull request #3 from MBenincasa/develop

RELEASE v0.2.1 - I have handled the case of unsupported values in con…

Author: MBenincasa

CHANGELOG.MD

@@ -1,3 +1,9 @@
+# v0.2.1
+### Features
+* New services for writing to an existing Excel file that take different input parameters
+### Fixes
+* Converting a value within a cell to an object returned null or failed. An error log is now written when an unsupported type is passed
+
 # v0.2.0
 ### Deprecations
 * All old tools are deprecated starting with this version. They have been replaced by new tools based on static methods.
@@ -6,7 +12,7 @@
 * There are new utility methods such as returning the index of the last row or the last column of a row.
 ### Fixes
 * The FileInputStream was not closed when the Workbook was opened from a File
-### Cosmetics
+### Enchantment
 * Removed some checks and repetitive code
 
 # v0.1.1

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.mbenincasa</groupId>
     <artifactId>java-excel-utils</artifactId>
-    <version>0.2.0</version>
+    <version>0.2.1</version>
     <packaging>jar</packaging>
     <name>Java library with tools for Excel files</name>
     <description>Java library that collects tools and methods to speed up development with Excel sheets</description>

src/main/java/samples/convertCsvFileToExcelFile/Main.java

@@ -1,12 +1,9 @@
 package samples.convertCsvFileToExcelFile;
 
 import enums.Extension;
-import org.apache.poi.ss.usermodel.Workbook;
 import tools.Converter;
-import tools.WorkbookUtility;
 
 import java.io.File;
-import java.io.FileOutputStream;
 
 public class Main {
 
@@ -19,12 +16,7 @@ public static void main(String[] args) {
             System.out.println("Start the conversion...");
             File excelFile = Converter.csvToExcel(csvFile, "./src/main/resources/", "employee_2", Extension.XLSX);
             System.out.println("First conversion completed...");
-
-            Workbook workbook = WorkbookUtility.open(excelFile);
-            Converter.csvToExistingExcel(workbook, csvFile2);
-            FileOutputStream fileOutputStream = new FileOutputStream(excelFile);
-            workbook.write(fileOutputStream);
-            WorkbookUtility.close(workbook, fileOutputStream);
+            Converter.csvToExistingExcel(excelFile, csvFile2);
             System.out.println("The file is ready. Path: " + excelFile.getAbsolutePath());
         } catch (Exception e) {
             System.err.println("There was an error. Check the console");

src/main/java/samples/convertExcelFileToObjectsSample/Main.java

@@ -13,8 +13,8 @@ public static void main(String[] args) {
 
         try {
             System.out.println("Start the conversion...");
-            List<Car> employees = (List<Car>) Converter.excelToObjects(file, Car.class);
-            System.out.println("The list is ready. List: " + employees.toString());
+            List<Car> cars = (List<Car>) Converter.excelToObjects(file, Car.class);
+            System.out.println("The list is ready. List: " + cars);
         } catch (Exception e) {
             System.err.println("There was an error. Check the console");
             throw new RuntimeException(e);

src/main/java/samples/convertObjectsToExcelFileSample/Main.java

@@ -1,12 +1,9 @@
 package samples.convertObjectsToExcelFileSample;
 
 import enums.Extension;
-import org.apache.poi.ss.usermodel.Workbook;
 import tools.Converter;
-import tools.WorkbookUtility;
 
 import java.io.File;
-import java.io.FileOutputStream;
 import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.util.ArrayList;
@@ -30,12 +27,7 @@ public static void main(String[] args) {
             System.out.println("Start the conversion...");
             File report = Converter.objectsToExcel(employees, Employee.class, "./src/main/resources/", "employee", Extension.XLSX, true);
             System.out.println("First conversion completed...");
-
-            Workbook workbook = WorkbookUtility.open(report);
-            Converter.objectsToExistingExcel(workbook, offices, Office.class, true);
-            FileOutputStream fileOutputStream = new FileOutputStream(report);
-            workbook.write(fileOutputStream);
-            WorkbookUtility.close(workbook, fileOutputStream);
+            Converter.objectsToExistingExcel(report, offices, Office.class, true);
             System.out.println("The file is ready. Path: " + report.getAbsolutePath());
         } catch (Exception e) {
             System.err.println("There was an error. Check the console");

src/main/java/tools/Converter.java

@@ -10,6 +10,8 @@
 import exceptions.*;
 import org.apache.commons.beanutils.PropertyUtils;
 import org.apache.commons.io.FilenameUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.apache.poi.ss.usermodel.*;
 
 import java.io.*;
@@ -26,6 +28,8 @@
  */
 public class Converter {
 
+    private static Logger logger = LogManager.getLogger(Converter.class);
+
     /**
      * Convert a list of objects into an Excel file<p>
      * Note: The type of the elements of the {@code objects} list must coincide with the type of {@code clazz}<p>
@@ -264,6 +268,47 @@ public static File objectsToExcel(List<?> objects, Class<?> clazz, String path,
         return file;
     }
 
+    /**
+     * This method allows you to convert objects into a Sheet of a File that already exists.<p>
+     * By default, the header is added if not specified
+     * @param file The {@code File} to update
+     * @param objects The list of objects that will be converted into an Excel file
+     * @param clazz The class of the list elements
+     * @throws OpenWorkbookException If an error occurred while opening the workbook
+     * @throws ExtensionNotValidException If the input file extension does not belong to an Excel file
+     * @throws IOException If an I/O error has occurred
+     * @throws IllegalAccessException If a field or fields of the {@code clazz} could not be accessed
+     * @since 0.2.1
+     */
+    public static void objectsToExistingExcel(File file, List<?> objects, Class<?> clazz) throws OpenWorkbookException, ExtensionNotValidException, IOException, IllegalAccessException {
+        objectsToExistingExcel(file, objects, clazz, true);
+    }
+
+    /**
+     * This method allows you to convert objects into a Sheet of a File that already exists.
+     * @param file The {@code File} to update
+     * @param objects The list of objects that will be converted into an Excel file
+     * @param clazz The class of the list elements
+     * @param writeHeader If {@code true} it will write the header to the first line
+     * @throws OpenWorkbookException If an error occurred while opening the workbook
+     * @throws ExtensionNotValidException If the input file extension does not belong to an Excel file
+     * @throws IOException If an I/O error has occurred
+     * @throws IllegalAccessException If a field or fields of the {@code clazz} could not be accessed
+     * @since 0.2.1
+     */
+    public static void objectsToExistingExcel(File file, List<?> objects, Class<?> clazz, Boolean writeHeader) throws OpenWorkbookException, ExtensionNotValidException, IOException, IllegalAccessException {
+        /* Open workbook */
+        Workbook workbook = WorkbookUtility.open(file);
+        objectsToExistingExcel(workbook, objects, clazz, writeHeader);
+
+        /* Write file */
+        FileOutputStream fileOutputStream = new FileOutputStream(file);
+        workbook.write(fileOutputStream);
+
+        /* Close file */
+        WorkbookUtility.close(workbook, fileOutputStream);
+    }
+
     /**
      * This method allows you to convert objects into a Sheet of a Workbook that already exists.<p>
      * Note: This method does not call the "write" method of the workbook.<p>
@@ -557,6 +602,52 @@ public static File csvToExcel(File fileInput, String path, String filename, Exte
         return outputFile;
     }
 
+    /**
+     * Convert the CSV file into a new sheet of an existing File.
+     * @param fileOutput The {@code File} to update
+     * @param fileInput The input CSV file that will be converted into an Excel file
+     * @throws OpenWorkbookException If an error occurred while opening the workbook
+     * @throws ExtensionNotValidException If the input file extension does not belong to a CSV file
+     * @throws IOException If an I/O error has occurred
+     * @throws CsvValidationException If the CSV file has invalid formatting
+     * @since 0.2.1
+     */
+    public static void csvToExistingExcel(File fileOutput, File fileInput) throws OpenWorkbookException, ExtensionNotValidException, IOException, CsvValidationException {
+        /* Open workbook */
+        Workbook workbook = WorkbookUtility.open(fileOutput);
+        csvToExistingExcel(workbook, fileInput);
+
+        /* Write file */
+        FileOutputStream fileOutputStream = new FileOutputStream(fileOutput);
+        workbook.write(fileOutputStream);
+
+        /* Close file */
+        WorkbookUtility.close(workbook, fileOutputStream);
+    }
+
+    /**
+     * Writes the data present in the CSVReader to a new sheet of an existing File.
+     * @param fileOutput The {@code File} to update
+     * @param csvReader The {@code CSVReader} of the CSV input file
+     * @throws OpenWorkbookException If an error occurred while opening the workbook
+     * @throws ExtensionNotValidException If the input file extension does not belong to a CSV file
+     * @throws IOException If an I/O error has occurred
+     * @throws CsvValidationException If the CSV file has invalid formatting
+     * @since 0.2.1
+     */
+    public static void csvToExistingExcel(File fileOutput, CSVReader csvReader) throws OpenWorkbookException, ExtensionNotValidException, IOException, CsvValidationException {
+        /* Open workbook */
+        Workbook workbook = WorkbookUtility.open(fileOutput);
+        csvToExistingExcel(workbook, csvReader);
+
+        /* Write file */
+        FileOutputStream fileOutputStream = new FileOutputStream(fileOutput);
+        workbook.write(fileOutputStream);
+
+        /* Close file */
+        WorkbookUtility.close(workbook, fileOutputStream, csvReader);
+    }
+
     /**
      * Convert the CSV file into a new sheet of an existing Workbook.<p>
      * Note: This method does not call the "write" method of the workbook.
@@ -661,11 +752,14 @@ private static Object convertCellValuesToObject(Class<?> clazz, Row row, Field[]
                         PropertyUtils.setSimpleProperty(obj, headerName, cell.getLocalDateTimeCellValue());
                     } else if (LocalDate.class.equals(field.getType())) {
                         PropertyUtils.setSimpleProperty(obj, headerName, cell.getLocalDateTimeCellValue().toLocalDate());
+                    } else {
+                        logger.error("{} type is not supported. It was not possible to write '{}'", field.getType(), headerName);
                     }
 
                 }
                 case BOOLEAN -> PropertyUtils.setSimpleProperty(obj, headerName, cell.getBooleanCellValue());
-                default -> PropertyUtils.setSimpleProperty(obj, headerName, cell.getStringCellValue());
+                case STRING -> PropertyUtils.setSimpleProperty(obj, headerName, cell.getStringCellValue());
+                default -> logger.error("Cell type not supported. It was not possible to write '{}'", headerName);
             }
         }
         return obj;