Merge pull request #7 from MBenincasa/develop

Develop

Author: MBenincasa

CHANGELOG.MD

@@ -1,3 +1,18 @@
+# v0.4.0
+### Deprecations
+* All methods of the Converter class up to version 0.2.1 have been deprecated
+### Features
+* There are new methods that convert Excel <-> POJOs and Excel <-> CSV. Besides conversion between files, conversions between streams and byte arrays are now available. Data is no longer returned in a List but in a Stream
+* Excel <-> Json conversion is now available
+* The writeAndClose method is available in ExcelWorkbook
+* ExcelCell provides new ways to read a cell.
+### Fixes
+* The error is handled better when trying to create a Sheet already present in the Workbook
+* The readCell(Class<?> type) method did not always return the requested type
+### Removed
+* The WorkbookUtility and SheetUtility classes have been removed
+* Several ExcelUtility methods have been removed
+
 # v0.3.0
 ### Deprecations
 * The WorkbookUtility and SheetUtility classes have been deprecated

README.md

@@ -26,6 +26,7 @@ At any time you can retrieve the associated Apache POI components.
 
 ```
 public void toPOI() {
+    // Initialize the components
     Workbook workbook = excelWorkbook.getWorkbook();
     Sheet sheet = excelSheet.getSheet();
     Row row = excelRow.getRow();
@@ -36,9 +37,34 @@ public void toPOI() {
 One of the main features of the library is to be able to perform conversions. The **Converter** class has methods that convert **Excel <-> POJOs** and **Excel <-> CSV**.<br>
 This is an example of Excel to POJOs:
 ```
-public void ExcelToObjects() {
+public void excelToObjects() {
+    // Initialize List<ExcelToObject<?>> excelToObjects...
     File file = new File("./src/main/resources/car.xlsx");
-    List<Car> cars = (List<Car>) Converter.excelToObjects(file, Car.class);
+    Map<String, Stream<?>> map = Converter.excelFileToObjects(file, excelToObjects);
+    for (Map.Entry<String, Stream<?>> entry : map.entrySet()) {
+        System.out.println("Sheet: " + entry.getKey());
+        System.out.println("Data: " + entry.getValue().toList());
+    }
+}
+```
+
+This is an example of POJOs to Excel:
+```
+public void objectsToExcel() {
+    // Initialize List<ObjectToExcel<?>> list...
+    list.add(new ObjectToExcel<>("Employee", Employee.class, employeeStream));
+    list.add(new ObjectToExcel<>("Office", Office.class, officeStream));
+    File fileOutput = Converter.objectsToExcelFile(list, Extension.XLSX, "./src/main/resources/result", true);
+}
+```
+
+ExcelCell provides generic methods for reading a cell.
+```
+public void readValue() {
+    // Initialize ExcelCell excelCell...
+    Integer intVal = excelCell.readValue(Integer.class);
+    Double doubleVal = excelCell.readValue();
+    String stringVal = excelCell.readValueAsString();
 }
 ```
 
@@ -55,6 +81,8 @@ Java 17 or above.
 - org.projectlombok:lombok:jar:1.18.24
 - commons-beanutils:commons-beanutils:jar:1.9.4
 - com.opencsv:opencsv:jar:5.7.1
+- com.fasterxml.jackson.core:jackson-databind:jar:2.14.2
+- org.apache.logging.log4j:log4j-core:jar:2.20.0
 - org.junit.jupiter:junit-jupiter:jar:5.9.2
 - org.junit.platform:junit-platform-suite-engine:jar:1.9.2
 
@@ -63,7 +91,7 @@ Java 17 or above.
 <dependency>
   <groupId>io.github.mbenincasa</groupId>
   <artifactId>java-excel-utils</artifactId>
-  <version>x.y.z</version>
+  <version>0.4.0</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.mbenincasa</groupId>
     <artifactId>java-excel-utils</artifactId>
-    <version>0.3.0</version>
+    <version>0.4.0</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>
@@ -133,6 +133,16 @@
             <artifactId>opencsv</artifactId>
             <version>5.7.1</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.14.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <version>2.20.0</version>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>

src/main/java/io/github/mbenincasa/javaexcelutils/enums/Extension.java

@@ -29,7 +29,13 @@ public enum Extension {
     /**
      * This extension is used for CSV (Comma-separated values) files
      */
-    CSV("csv", "CSV");
+    CSV("csv", "CSV"),
+
+    /**
+     * @since 0.4.0
+     * This extension is used for JSON (JavaScript Object Notation) files
+     */
+    JSON("json", "JSON");
 
     /**
      * The extension's name
@@ -60,6 +66,6 @@ public static Extension getExcelExtension(String ext) throws ExtensionNotValidEx
      * @since 0.1.1
      */
     public Boolean isExcelExtension() {
-        return this.getType().equalsIgnoreCase("EXCEL");
+        return this.type.equalsIgnoreCase("EXCEL");
     }
 }

src/main/java/io/github/mbenincasa/javaexcelutils/model/converter/ExcelToObject.java

@@ -0,0 +1,27 @@
+package io.github.mbenincasa.javaexcelutils.model.converter;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * This is a support class that is used by the {@code Converter} to perform conversions from Excel to Objects
+ * @author Mirko Benincasa
+ * @since 0.4.0
+ * @param <T> The class parameter, for each Sheet, that maps a row into the parameter object
+ */
+@AllArgsConstructor
+@Getter
+@Setter
+public class ExcelToObject<T> {
+
+    /**
+     * The name of the Sheet to read
+     */
+    private String sheetName;
+
+    /**
+     * The object class
+     */
+    private Class<T> clazz;
+}

src/main/java/io/github/mbenincasa/javaexcelutils/model/converter/JsonToExcel.java

@@ -0,0 +1,27 @@
+package io.github.mbenincasa.javaexcelutils.model.converter;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * This is a support class that is used by the {@code Converter} to perform conversions from Json to Excel
+ * @author Mirko Benincasa
+ * @since 0.4.0
+ * @param <T> The class parameter, for each Sheet, that maps a Json object into the parameter object
+ */
+@AllArgsConstructor
+@Getter
+@Setter
+public class JsonToExcel<T> {
+
+    /**
+     * The name to assign to the Sheet
+     */
+    private String sheetName;
+
+    /**
+     * The object class
+     */
+    private Class<T> clazz;
+}

src/main/java/io/github/mbenincasa/javaexcelutils/model/converter/ObjectToExcel.java

@@ -0,0 +1,34 @@
+package io.github.mbenincasa.javaexcelutils.model.converter;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.stream.Stream;
+
+/**
+ * This is a helper class used by {@code Converter} to convert objects in an Excel Sheet
+ * @author Mirko Benincasa
+ * @since 0.4.0
+ * @param <T> The class parameter, for each sheet, which maps objects to a Sheet
+ */
+@AllArgsConstructor
+@Getter
+@Setter
+public class ObjectToExcel<T> {
+
+    /**
+     * The name to assign to the Sheet
+     */
+    private String sheetName;
+
+    /**
+     * The object class
+     */
+    private Class<T> clazz;
+
+    /**
+     * A Stream of objects
+     */
+    private Stream<T> stream;
+}

src/main/java/io/github/mbenincasa/javaexcelutils/model/ExcelCell.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelCell.java

@@ -1,13 +1,10 @@
-package io.github.mbenincasa.javaexcelutils.model;
+package io.github.mbenincasa.javaexcelutils.model.excel;
 
 import io.github.mbenincasa.javaexcelutils.exceptions.ReadValueException;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
-import org.apache.poi.ss.usermodel.Cell;
-import org.apache.poi.ss.usermodel.CellStyle;
-import org.apache.poi.ss.usermodel.FormulaEvaluator;
-import org.apache.poi.ss.usermodel.Row;
+import org.apache.poi.ss.usermodel.*;
 
 import java.time.LocalDate;
 import java.time.LocalDateTime;
@@ -44,15 +41,45 @@ public ExcelRow getRow() {
 
     /**
      * Read the value written inside the Cell
-     * @param type The class type of the object written to the Cell
      * @return The value written in the Cell
      * @throws ReadValueException If an error occurs while reading
+     * @since 0.4.0
      */
-    public Object readValue(Class<?> type) throws ReadValueException {
+    public Object readValue() throws ReadValueException {
         Object val;
         switch (this.cell.getCellType()) {
             case BOOLEAN -> val = this.cell.getBooleanCellValue();
             case STRING -> val = this.cell.getStringCellValue();
+            case NUMERIC -> val = this.cell.getNumericCellValue();
+            case FORMULA -> val = this.cell.getCellFormula();
+            case BLANK -> val = "";
+            default -> throw new ReadValueException("An error occurred while reading. CellType '" + this.cell.getCellType() + "'");
+        }
+
+        return val;
+    }
+
+    /**
+     * Read the value written inside the Cell
+     * @param type The class type of the object written to the Cell
+     * @return The value written in the Cell
+     * @throws ReadValueException If an error occurs while reading
+     */
+    public Object readValue(Class<?> type) throws ReadValueException {
+        Object val;
+        switch (this.cell.getCellType()) {
+            case BOOLEAN -> {
+                if (!Boolean.class.equals(type)) {
+                    throw new ReadValueException("This type '" + type + "' is either incompatible with the CellType '" + this.cell.getCellType() + "'");
+                }
+                val = this.cell.getBooleanCellValue();
+            }
+            case STRING -> {
+                if (!String.class.equals(type)) {
+                    throw new ReadValueException("This type '" + type + "' is either incompatible with the CellType '" + this.cell.getCellType() + "'");
+                }
+                val = this.cell.getStringCellValue();
+            }
             case NUMERIC -> {
                 if (Integer.class.equals(type)) {
                     val = (int) this.cell.getNumericCellValue();
@@ -67,7 +94,7 @@ public Object readValue(Class<?> type) throws ReadValueException {
                 } else if (LocalDate.class.equals(type)) {
                     val = this.cell.getLocalDateTimeCellValue().toLocalDate();
                 } else {
-                    throw new ReadValueException("This numeric type is not supported: " + type);
+                    throw new ReadValueException("This type '" + type + "' is either incompatible with the CellType '" + this.cell.getCellType() + "' or not yet supported");
                 }
             }
             case FORMULA -> {
@@ -85,6 +112,16 @@ public Object readValue(Class<?> type) throws ReadValueException {
         return val;
     }
 
+    /**
+     * Read the value written inside the Cell as String
+     * @return The value written in the Cell
+     * @since 0.4.0
+     */
+    public String readValueAsString() {
+        DataFormatter formatter = new DataFormatter(true);
+        return formatter.formatCellValue(this.cell);
+    }
+
     /**
      * Writes inside the cell
      * @param val The value to write in the Cell

src/main/java/io/github/mbenincasa/javaexcelutils/model/ExcelRow.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelRow.java

@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.model;
+package io.github.mbenincasa.javaexcelutils.model.excel;
 
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;

src/main/java/io/github/mbenincasa/javaexcelutils/model/ExcelSheet.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelSheet.java

@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.model;
+package io.github.mbenincasa.javaexcelutils.model.excel;
 
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;