Added the parseToObject() method present in ExcelSheet which is used to parse a Sheet into a Java object.

MBenincasa · MBenincasa · commit 8ed98649d760 · 2023-05-20T15:01:50.000+02:00
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/annotations/ExcelCellMapping.java b/src/main/java/io/github/mbenincasa/javaexcelutils/annotations/ExcelCellMapping.java
@@ -0,0 +1,26 @@
+package io.github.mbenincasa.javaexcelutils.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation is needed when the parseToObject() method in ExcelSheet is used
+ * @author Mirko Benincasa
+ * @since 0.5.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface ExcelCellMapping {
+
+    /**
+     * @return the value to add to the source row
+     */
+    int deltaRow();
+
+    /**
+     * @return the value to add to the source column
+     */
+    int deltaCol();
+}
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelSheet.java b/src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelSheet.java
@@ -1,14 +1,19 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelCellMapping;
 import io.github.mbenincasa.javaexcelutils.exceptions.CellNotFoundException;
+import io.github.mbenincasa.javaexcelutils.exceptions.ReadValueException;
 import io.github.mbenincasa.javaexcelutils.exceptions.RowNotFoundException;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelCellParser;
 import io.github.mbenincasa.javaexcelutils.tools.ExcelUtility;
 import lombok.*;
 import org.apache.poi.ss.usermodel.Cell;
 import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.util.CellRangeAddress;
 
+import java.lang.reflect.Field;
+import java.lang.reflect.InvocationTargetException;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -165,18 +170,6 @@ public void appendCells(String startingCell, Stream<Object[]> data) {
         writeOrAppendCells(data, rowIndex, colIndex);
     }
 
-    private void writeOrAppendCells(Stream<Object[]> data, AtomicInteger rowIndex, int colIndex) {
-        data.forEach(rowData -> {
-            ExcelRow excelRow = getOrCreateRow(rowIndex.get());
-            for (int i = 0; i < rowData.length; i++) {
-                Object value = rowData[i];
-                ExcelCell excelCell = excelRow.getOrCreateCell(colIndex + i);
-                excelCell.writeValue(value);
-            }
-            rowIndex.getAndIncrement();
-        });
-    }
-
     /**
      * Method used to delete cells based on the selected range, for example: 'A1:B2'
      * @param cellRange The range of cells to be deleted
@@ -260,4 +253,56 @@ public Integer countAllRows(Boolean alsoEmpty) {
 
         return count;
     }
+
+    /**
+     * @param clazz The class of the object to return
+     * @param startingCell The name of the source cell
+     * @param <T> The class parameter of the object
+     * @return The object parsed
+     * @throws NoSuchMethodException If the setting method or empty constructor of the object is not found
+     * @throws InvocationTargetException If an error occurs while instantiating a new object or setting a field
+     * @throws InstantiationException If an error occurs while instantiating a new object
+     * @throws IllegalAccessException If a field or fields of the {@code clazz} could not be accessed
+     * @throws ReadValueException If an error occurs while reading a cell
+     * @since 0.5.0
+     */
+    public <T> T parseToObject(Class<T> clazz, String startingCell) throws NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException, ReadValueException {
+        T obj = clazz.getDeclaredConstructor().newInstance();
+        int[] cellIndexes = ExcelUtility.getCellIndexes(startingCell);
+        int startingRow = cellIndexes[0];
+        int startingCol = cellIndexes[1];
+        Field[] fields = clazz.getDeclaredFields();
+
+        for (Field field : fields) {
+            if (!field.isAnnotationPresent(ExcelCellMapping.class))
+                continue;
+
+            ExcelCellMapping excelCellMapping = field.getAnnotation(ExcelCellMapping.class);
+            int deltaRow = excelCellMapping.deltaRow();
+            int deltaCol = excelCellMapping.deltaCol();
+            ExcelRow excelRow = getOrCreateRow(startingRow + deltaRow);
+            ExcelCell excelCell = excelRow.getOrCreateCell(startingCol + deltaCol);
+            field.setAccessible(true);
+
+            Object value = ExcelCellParser.class.isAssignableFrom(field.getType())
+                    ? parseToObject(field.getType(), ExcelUtility.getCellName(startingRow + deltaRow, startingCol + deltaCol))
+                    : excelCell.readValue(field.getType());
+            field.set(obj, value);
+
+        }
+
+        return obj;
+    }
+
+    private void writeOrAppendCells(Stream<Object[]> data, AtomicInteger rowIndex, int colIndex) {
+        data.forEach(rowData -> {
+            ExcelRow excelRow = getOrCreateRow(rowIndex.get());
+            for (int i = 0; i < rowData.length; i++) {
+                Object value = rowData[i];
+                ExcelCell excelCell = excelRow.getOrCreateCell(colIndex + i);
+                excelCell.writeValue(value);
+            }
+            rowIndex.getAndIncrement();
+        });
+    }
 }
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/model/parser/ExcelCellParser.java b/src/main/java/io/github/mbenincasa/javaexcelutils/model/parser/ExcelCellParser.java
@@ -0,0 +1,10 @@
+package io.github.mbenincasa.javaexcelutils.model.parser;
+
+/**
+ * This interface is needed when the parseToObject() method in the ExcelSheet is used.
+ * All objects to be parsed must implement this interface to identify that it is not a cell to read.
+ * @author Mirko Benincasa
+ * @since 0.5.0
+ */
+public interface ExcelCellParser {
+}
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertExcelFileToObjects/Employee.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertExcelFileToObjects/Employee.java
@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjectsSample;
+package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjects;
 
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelBodyStyle;
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelField;
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertExcelFileToObjects/Main.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertExcelFileToObjects/Main.java
@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjectsSample;
+package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjects;
 
 import io.github.mbenincasa.javaexcelutils.model.converter.ExcelToObject;
 import io.github.mbenincasa.javaexcelutils.tools.Converter;
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertExcelFileToObjects/Office.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertExcelFileToObjects/Office.java
@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjectsSample;
+package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjects;
 
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelBodyStyle;
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelField;
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertObjectsToExcelFile/Employee.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertObjectsToExcelFile/Employee.java
@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.samples.convertObjectsToExcelFileSample;
+package io.github.mbenincasa.javaexcelutils.samples.convertObjectsToExcelFile;
 
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelBodyStyle;
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelField;
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertObjectsToExcelFile/Main.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertObjectsToExcelFile/Main.java
@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.samples.convertObjectsToExcelFileSample;
+package io.github.mbenincasa.javaexcelutils.samples.convertObjectsToExcelFile;
 
 import io.github.mbenincasa.javaexcelutils.enums.Extension;
 import io.github.mbenincasa.javaexcelutils.model.converter.ObjectToExcel;
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertObjectsToExcelFile/Office.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertObjectsToExcelFile/Office.java
@@ -1,4 +1,4 @@
-package io.github.mbenincasa.javaexcelutils.samples.convertObjectsToExcelFileSample;
+package io.github.mbenincasa.javaexcelutils.samples.convertObjectsToExcelFile;
 
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelBodyStyle;
 import io.github.mbenincasa.javaexcelutils.annotations.ExcelField;
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Address.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Address.java
@@ -0,0 +1,20 @@
+package io.github.mbenincasa.javaexcelutils.samples.parseSheetToExcel;
+
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelCellMapping;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelCellParser;
+import lombok.AllArgsConstructor;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Setter
+@ToString
+public class Address implements ExcelCellParser {
+
+    @ExcelCellMapping(deltaRow = 1, deltaCol = 0)
+    private String city;
+    @ExcelCellMapping(deltaRow = 2, deltaCol = 0)
+    private String cap;
+}
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Employee.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Employee.java
@@ -0,0 +1,30 @@
+package io.github.mbenincasa.javaexcelutils.samples.parseSheetToExcel;
+
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelCellMapping;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelCellParser;
+import lombok.AllArgsConstructor;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+import java.time.LocalDate;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Setter
+@ToString
+public class Employee implements ExcelCellParser {
+
+    @ExcelCellMapping(deltaRow = 0, deltaCol = 1)
+    private String name;
+    @ExcelCellMapping(deltaRow = 1, deltaCol = 1)
+    private String lastName;
+    @ExcelCellMapping(deltaRow = 2, deltaCol = 1)
+    private Integer age;
+    @ExcelCellMapping(deltaRow = 3, deltaCol = 1)
+    private LocalDate hireDate;
+    @ExcelCellMapping(deltaRow = 3, deltaCol = 2)
+    private LocalDate terminationDate;
+    @ExcelCellMapping(deltaRow = 4, deltaCol = 4)
+    private Address address;
+}
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Main.java b/src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Main.java
@@ -0,0 +1,26 @@
+package io.github.mbenincasa.javaexcelutils.samples.parseSheetToExcel;
+
+import io.github.mbenincasa.javaexcelutils.model.excel.ExcelSheet;
+import io.github.mbenincasa.javaexcelutils.model.excel.ExcelWorkbook;
+
+import java.io.File;
+
+public class Main {
+
+    public static void main(String[] args) {
+
+        File file = new File("./src/main/resources/parse_to_object.xlsx");
+        try {
+            ExcelWorkbook excelWorkbook = ExcelWorkbook.open(file);
+            ExcelSheet excelSheet = excelWorkbook.getSheet("DATA");
+            System.out.println("Start the parsing...");
+            Employee employee = excelSheet.parseToObject(Employee.class, "A1");
+            System.out.println("...completed");
+            System.out.println("Data: " + employee.toString());
+        } catch (Exception e) {
+            System.err.println("There was an error. Check the console");
+            throw new RuntimeException(e);
+        }
+
+    }
+}
diff --git a/src/main/java/io/github/mbenincasa/javaexcelutils/tools/Converter.java b/src/main/java/io/github/mbenincasa/javaexcelutils/tools/Converter.java
@@ -171,7 +171,7 @@ public static Map<String, Stream<?>> excelByteToObjects(byte[] bytes, List<Excel
      * @throws HeaderNotPresentException If the first row is empty and does not contain the header
      * @throws InvocationTargetException If an error occurs while instantiating a new object or setting a field
      * @throws NoSuchMethodException If the setting method or empty constructor of the object is not found
-     * @throws InstantiationException f an error occurs while instantiating a new object
+     * @throws InstantiationException If an error occurs while instantiating a new object
      * @throws IllegalAccessException If a field or fields of the {@code clazz} could not be accessed
      * @throws ExtensionNotValidException If the input file extension does not belong to an Excel file
      * @since 0.4.0
diff --git a/src/test/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelSheetTest.java b/src/test/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelSheetTest.java
@@ -1,19 +1,23 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
 import io.github.mbenincasa.javaexcelutils.exceptions.*;
+import io.github.mbenincasa.javaexcelutils.tools.utils.ParsableEmployee;
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.usermodel.Workbook;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
+import java.time.LocalDate;
 import java.util.List;
 import java.util.stream.Stream;
 
 public class ExcelSheetTest {
 
     private final File excelFile = new File("./src/test/resources/employee.xlsx");
+    private final File excelFileToParse = new File("./src/test/resources/parse_to_object.xlsx");
 
     @Test
     void getWorkbook() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException {
@@ -161,4 +165,18 @@ void of() throws OpenWorkbookException, ExtensionNotValidException, IOException
         Assertions.assertEquals(sheet.getSheetName(), excelSheet.getName());
         Assertions.assertEquals(sheet.getWorkbook().getSheetIndex(sheet), excelSheet.getIndex());
     }
+
+    @Test
+    void parseToObject() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException, ReadValueException, InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException {
+        ExcelWorkbook excelWorkbook = ExcelWorkbook.open(excelFileToParse);
+        ExcelSheet excelSheet = excelWorkbook.getSheet("DATA");
+        ParsableEmployee employee = excelSheet.parseToObject(ParsableEmployee.class, "A1");
+        Assertions.assertEquals("Mario", employee.getName());
+        Assertions.assertEquals("Rossi", employee.getLastName());
+        Assertions.assertEquals(25, employee.getAge());
+        Assertions.assertEquals(LocalDate.of(2022, 1 , 12), employee.getHireDate());
+        Assertions.assertEquals(LocalDate.of(2022, 2 , 12), employee.getTerminationDate());
+        Assertions.assertEquals("Nocera Inferiore", employee.getAddress().getCity());
+        Assertions.assertEquals("84014", employee.getAddress().getCap());
+    }
 }
diff --git a/src/test/java/io/github/mbenincasa/javaexcelutils/tools/utils/ParsableAddress.java b/src/test/java/io/github/mbenincasa/javaexcelutils/tools/utils/ParsableAddress.java
@@ -0,0 +1,20 @@
+package io.github.mbenincasa.javaexcelutils.tools.utils;
+
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelCellMapping;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelCellParser;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Getter
+@ToString
+public class ParsableAddress implements ExcelCellParser {
+
+    @ExcelCellMapping(deltaRow = 1, deltaCol = 0)
+    private String city;
+    @ExcelCellMapping(deltaRow = 2, deltaCol = 0)
+    private String cap;
+}
diff --git a/src/test/java/io/github/mbenincasa/javaexcelutils/tools/utils/ParsableEmployee.java b/src/test/java/io/github/mbenincasa/javaexcelutils/tools/utils/ParsableEmployee.java
@@ -0,0 +1,30 @@
+package io.github.mbenincasa.javaexcelutils.tools.utils;
+
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelCellMapping;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelCellParser;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+import java.time.LocalDate;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Getter
+@ToString
+public class ParsableEmployee implements ExcelCellParser {
+
+    @ExcelCellMapping(deltaRow = 0, deltaCol = 1)
+    private String name;
+    @ExcelCellMapping(deltaRow = 1, deltaCol = 1)
+    private String lastName;
+    @ExcelCellMapping(deltaRow = 2, deltaCol = 1)
+    private Integer age;
+    @ExcelCellMapping(deltaRow = 3, deltaCol = 1)
+    private LocalDate hireDate;
+    @ExcelCellMapping(deltaRow = 3, deltaCol = 2)
+    private LocalDate terminationDate;
+    @ExcelCellMapping(deltaRow = 4, deltaCol = 4)
+    private ParsableAddress address;
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjectsSample;`
	`1`	`+package io.github.mbenincasa.javaexcelutils.samples.convertExcelFileToObjects;`
`2`	`2`
`3`	`3`	`import io.github.mbenincasa.javaexcelutils.annotations.ExcelBodyStyle;`
`4`	`4`	`import io.github.mbenincasa.javaexcelutils.annotations.ExcelField;`