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

Author: MBenincasa

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

@@ -4,7 +4,9 @@
 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.Direction;
 import io.github.mbenincasa.javaexcelutils.model.parser.ExcelCellParser;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelListParserMapping;
 import io.github.mbenincasa.javaexcelutils.tools.ExcelUtility;
 import lombok.*;
 import org.apache.poi.ss.usermodel.Cell;
@@ -294,6 +296,44 @@ public <T> T parseToObject(Class<T> clazz, String startingCell) throws NoSuchMet
         return obj;
     }
 
+    /**
+     * @param clazz The class of the object to return
+     * @param mapping The rules to retrieve the list of objects
+     * @param <T> The class parameter of the object
+     * @return The object list parsed
+     * @throws ReadValueException If an error occurs while reading a cell
+     * @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 If an error occurs while instantiating a new object
+     * @throws IllegalAccessException If a field or fields of the {@code clazz} could not be accessed
+     */
+    public <T> List<T> parseToList(Class<T> clazz, ExcelListParserMapping mapping) throws ReadValueException, InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException {
+        List<T> objectList = new LinkedList<>();
+        int[] cellIndexes = ExcelUtility.getCellIndexes(mapping.getStartingCell());
+        int startingRow = cellIndexes[0];
+        int startingCol = cellIndexes[1];
+
+        if (mapping.getDirection() == Direction.HORIZONTAL) {
+            int maxCol = getOrCreateRow(startingRow).getLastColumnIndex();
+            while (startingCol <= maxCol) {
+                String currentCell = ExcelUtility.getCellName(startingRow, startingCol);
+                T obj = parseToObject(clazz, currentCell);
+                objectList.add(obj);
+                startingCol += mapping.getJumpCells();
+            }
+        } else if (mapping.getDirection() == Direction.VERTICAL) {
+            int maxRow = getLastRowIndex();
+            while (startingRow <= maxRow) {
+                String currentCell = ExcelUtility.getCellName(startingRow, startingCol);
+                T obj = parseToObject(clazz, currentCell);
+                objectList.add(obj);
+                startingRow += mapping.getJumpCells();
+            }
+        }
+
+        return objectList;
+    }
+
     private void writeOrAppendCells(Stream<Object[]> data, AtomicInteger rowIndex, int colIndex) {
         data.forEach(rowData -> {
             ExcelRow excelRow = getOrCreateRow(rowIndex.get());

src/main/java/io/github/mbenincasa/javaexcelutils/model/parser/Direction.java

@@ -0,0 +1,19 @@
+package io.github.mbenincasa.javaexcelutils.model.parser;
+
+/**
+ * This enum defines the direction of the list in an Excel sheet which is used in the parseToList() method in the ExcelSheet
+ * @author Mirko Benincasa
+ * @since 0.5.0
+ */
+public enum Direction {
+
+    /**
+     * Horizontal direction
+     */
+    HORIZONTAL,
+
+    /**
+     * Vertical direction
+     */
+    VERTICAL
+}

src/main/java/io/github/mbenincasa/javaexcelutils/model/parser/ExcelListParserMapping.java

@@ -0,0 +1,29 @@
+package io.github.mbenincasa.javaexcelutils.model.parser;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+/**
+ * Class used to define the rules to be applied for a Sheet in a list of objects
+ * @author Mirko Benincasa
+ * @since 0.5.0
+ */
+@AllArgsConstructor
+@Getter
+public class ExcelListParserMapping {
+
+    /**
+     * Source cell name
+     */
+    private String startingCell;
+
+    /**
+     * List direction
+     */
+    private Direction direction;
+
+    /**
+     * The distance, according to the line of direction, between two adjacent sources
+     */
+    private Integer jumpCells;
+}

src/main/java/io/github/mbenincasa/javaexcelutils/samples/parseSheetToExcel/Main.java

@@ -2,8 +2,11 @@
 
 import io.github.mbenincasa.javaexcelutils.model.excel.ExcelSheet;
 import io.github.mbenincasa.javaexcelutils.model.excel.ExcelWorkbook;
+import io.github.mbenincasa.javaexcelutils.model.parser.Direction;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelListParserMapping;
 
 import java.io.File;
+import java.util.List;
 
 public class Main {
 
@@ -16,7 +19,11 @@ public static void main(String[] args) {
             System.out.println("Start the parsing...");
             Employee employee = excelSheet.parseToObject(Employee.class, "A1");
             System.out.println("...completed");
-            System.out.println("Data: " + employee.toString());
+            ExcelSheet excelSheet1 = excelWorkbook.getSheet("DATA_2");
+            ExcelListParserMapping mapping = new ExcelListParserMapping("A1", Direction.VERTICAL, 8);
+            List<Employee> employees = excelSheet1.parseToList(Employee.class, mapping);
+            System.out.println("Data single object: " + employee.toString());
+            System.out.println("Data multi objects: " + employees.toString());
         } catch (Exception e) {
             System.err.println("There was an error. Check the console");
             throw new RuntimeException(e);

src/test/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelSheetTest.java

@@ -1,6 +1,8 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
 import io.github.mbenincasa.javaexcelutils.exceptions.*;
+import io.github.mbenincasa.javaexcelutils.model.parser.Direction;
+import io.github.mbenincasa.javaexcelutils.model.parser.ExcelListParserMapping;
 import io.github.mbenincasa.javaexcelutils.tools.utils.ParsableEmployee;
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.usermodel.Workbook;
@@ -179,4 +181,28 @@ void parseToObject() throws OpenWorkbookException, ExtensionNotValidException, I
         Assertions.assertEquals("Nocera Inferiore", employee.getAddress().getCity());
         Assertions.assertEquals("84014", employee.getAddress().getCap());
     }
+
+    @Test
+    void parseToList() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException, ReadValueException, InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException {
+        ExcelWorkbook excelWorkbook = ExcelWorkbook.open(excelFileToParse);
+        ExcelSheet excelSheet = excelWorkbook.getSheet("DATA_2");
+        ExcelListParserMapping mapping = new ExcelListParserMapping("A1", Direction.VERTICAL, 8);
+        List<ParsableEmployee> employees = excelSheet.parseToList(ParsableEmployee.class, mapping);
+        ParsableEmployee parsableEmployee = employees.get(0);
+        Assertions.assertEquals("Mario", parsableEmployee.getName());
+        Assertions.assertEquals("Rossi", parsableEmployee.getLastName());
+        Assertions.assertEquals(25, parsableEmployee.getAge());
+        Assertions.assertEquals(LocalDate.of(2022, 1 , 12), parsableEmployee.getHireDate());
+        Assertions.assertEquals(LocalDate.of(2022, 2 , 12), parsableEmployee.getTerminationDate());
+        Assertions.assertEquals("Nocera Inferiore", parsableEmployee.getAddress().getCity());
+        Assertions.assertEquals("84014", parsableEmployee.getAddress().getCap());
+        parsableEmployee = employees.get(1);
+        Assertions.assertEquals("Antonio", parsableEmployee.getName());
+        Assertions.assertEquals("Bianchi", parsableEmployee.getLastName());
+        Assertions.assertEquals(30, parsableEmployee.getAge());
+        Assertions.assertEquals(LocalDate.of(2022, 1 , 12), parsableEmployee.getHireDate());
+        Assertions.assertEquals(LocalDate.of(2023, 1 , 12), parsableEmployee.getTerminationDate());
+        Assertions.assertEquals("Pero", parsableEmployee.getAddress().getCity());
+        Assertions.assertEquals("20016", parsableEmployee.getAddress().getCap());
+    }
 }