Merge pull request #12 from MBenincasa/develop

Develop

Author: MBenincasa

CHANGELOG.MD

@@ -1,3 +1,14 @@
+# v0.4.1
+### Features
+* There are getOrCreate methods for a Row or a Cell
+* There are methods to remove a Sheet, a Row or a Cell
+* There are methods to retrieve a Row or a Cell based on an index
+* There are methods for writing and reading a list of values from a Row
+### Fixes
+* ExcelSheet's getIndex() method did not return the correct index after deleting a Sheet
+### Changes
+* The static method that opens an ExcelWorkbook via InputStream no longer takes the extension as input and is no longer checked if it is correct
+
 # v0.4.0
 ### Deprecations
 * All methods of the Converter class up to version 0.2.1 have been deprecated

README.md

@@ -78,7 +78,7 @@ Java 17 or above.
 ## Dependencies
 - org.apache.poi:poi:jar:5.2.3
 - org.apache.poi:poi-ooxml:jar:5.2.3
-- org.projectlombok:lombok:jar:1.18.24
+- org.projectlombok:lombok:jar:1.18.26
 - 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
@@ -91,7 +91,7 @@ Java 17 or above.
 <dependency>
   <groupId>io.github.mbenincasa</groupId>
   <artifactId>java-excel-utils</artifactId>
-  <version>0.4.0</version>
+  <version>0.4.1</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.mbenincasa</groupId>
     <artifactId>java-excel-utils</artifactId>
-    <version>0.4.0</version>
+    <version>0.4.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/io/github/mbenincasa/javaexcelutils/exceptions/CellNotFoundException.java

@@ -0,0 +1,49 @@
+package io.github.mbenincasa.javaexcelutils.exceptions;
+
+/**
+ * This exception signals that the Excel cell was not found
+ * @author Mirko Benincasa
+ * @since 0.4.1
+ */
+public class CellNotFoundException extends Exception {
+
+    /**
+     * Constructs an {@code CellNotFoundException} with {@code null}
+     * as its error detail message.
+     */
+    public CellNotFoundException() {
+        super();
+    }
+
+    /**
+     * Constructs an {@code CellNotFoundException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
+    public CellNotFoundException(String message) {
+        super(message);
+    }
+
+    /**
+     * Constructs an {@code CellNotFoundException} with the specified detail message
+     * and cause.
+     *
+     * <p> Note that the detail message associated with {@code cause} is
+     * <i>not</i> automatically incorporated into this exception's detail
+     * message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     *
+     * @param cause
+     *        The cause (which is saved for later retrieval by the
+     *        {@link #getCause()} method).  (A null value is permitted,
+     *        and indicates that the cause is nonexistent or unknown.)
+     */
+    public CellNotFoundException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

src/main/java/io/github/mbenincasa/javaexcelutils/exceptions/RowNotFoundException.java

@@ -0,0 +1,49 @@
+package io.github.mbenincasa.javaexcelutils.exceptions;
+
+/**
+ * This exception signals that the Excel row was not found
+ * @author Mirko Benincasa
+ * @since 0.4.1
+ */
+public class RowNotFoundException extends Exception {
+
+    /**
+     * Constructs an {@code RowNotFoundException} with {@code null}
+     * as its error detail message.
+     */
+    public RowNotFoundException() {
+        super();
+    }
+
+    /**
+     * Constructs an {@code RowNotFoundException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
+    public RowNotFoundException(String message) {
+        super(message);
+    }
+
+    /**
+     * Constructs an {@code RowNotFoundException} with the specified detail message
+     * and cause.
+     *
+     * <p> Note that the detail message associated with {@code cause} is
+     * <i>not</i> automatically incorporated into this exception's detail
+     * message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     *
+     * @param cause
+     *        The cause (which is saved for later retrieval by the
+     *        {@link #getCause()} method).  (A null value is permitted,
+     *        and indicates that the cause is nonexistent or unknown.)
+     */
+    public RowNotFoundException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

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

@@ -1,5 +1,6 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
+import io.github.mbenincasa.javaexcelutils.exceptions.CellNotFoundException;
 import io.github.mbenincasa.javaexcelutils.exceptions.ReadValueException;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
@@ -30,6 +31,17 @@ public class ExcelCell {
      */
     private Integer index;
 
+    /**
+     * Remove the selected Cell
+     * @throws CellNotFoundException If the cell is not present or has not been created
+     * @since 0.4.1
+     */
+    public void remove() throws CellNotFoundException {
+        getRow().removeCell(this.index);
+        this.cell = null;
+        this.index = null;
+    }
+
     /**
      * Returns the Row to which it belongs
      * @return A ExcelRow

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

@@ -1,5 +1,8 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
+import io.github.mbenincasa.javaexcelutils.exceptions.CellNotFoundException;
+import io.github.mbenincasa.javaexcelutils.exceptions.ReadValueException;
+import io.github.mbenincasa.javaexcelutils.exceptions.RowNotFoundException;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -31,6 +34,17 @@ public class ExcelRow {
      */
     private Integer index;
 
+    /**
+     * Remove the selected Row
+     * @throws RowNotFoundException If the row is not present or has not been created
+     * @since 0.4.1
+     */
+    public void remove() throws RowNotFoundException {
+        getSheet().removeRow(this.index);
+        this.row = null;
+        this.index = null;
+    }
+
     /**
      * The list of Cells related to the Row
      * @return A list of Cells
@@ -40,10 +54,109 @@ public List<ExcelCell> getCells() {
         for (Cell cell : this.row) {
             excelCells.add(new ExcelCell(cell, cell.getColumnIndex()));
         }
-
         return excelCells;
     }
 
+    /**
+     * Retrieve a cell by index
+     * @param index The index of the cell requested
+     * @return A ExcelCell
+     * @throws CellNotFoundException If the cell is not present or has not been created
+     * @since 0.4.1
+     */
+    public ExcelCell getCell(Integer index) throws CellNotFoundException {
+        Cell cell = this.row.getCell(index);
+        if (cell == null) {
+            throw new CellNotFoundException("There is not a cell in the index: " + index);
+        }
+        return new ExcelCell(cell, cell.getColumnIndex());
+    }
+
+    /**
+     * Retrieve or create a cell by index
+     * @param index The index of the cell requested
+     * @return A ExcelCell
+     * @since 0.4.1
+     */
+    public ExcelCell getOrCreateCell(Integer index) {
+        Cell cell = this.row.getCell(index);
+        if (cell == null) {
+            return  createCell(index);
+        }
+        return new ExcelCell(cell, cell.getColumnIndex());
+    }
+
+    /**
+     * Removes a cell by index
+     * @param index The index of the row to remove
+     * @throws CellNotFoundException If the cell is not present or has not been created
+     * @since 0.4.1
+     */
+    public void removeCell(Integer index) throws CellNotFoundException {
+        ExcelCell excelCell = getCell(index);
+        this.row.removeCell(excelCell.getCell());
+    }
+
+    /**
+     * Write the values in the cells of the row
+     * @param values The values to write in the cells of the row
+     * @since 0.4.1
+     */
+    public void writeValues(List<?> values) {
+        for (int i = 0; i < values.size(); i++) {
+            ExcelCell excelCell = getOrCreateCell(i);
+            excelCell.writeValue(values.get(i));
+        }
+    }
+
+    /**
+     * Reads the values of all cells in the row
+     * @return The list of values written in the cells
+     * @throws ReadValueException If an error occurs while reading
+     * @since 0.4.1
+     */
+    public List<?> readValues() throws ReadValueException {
+        List<Object> values = new LinkedList<>();
+        for (ExcelCell excelCell : getCells()) {
+            values.add(excelCell.readValue());
+        }
+        return values;
+    }
+
+    /**
+     * Reads the values of all cells in the row
+     * @param classes A list of Classes that is used to cast the results read
+     * @return The list of values written in the cells
+     * @throws ReadValueException If an error occurs while reading
+     * @since 0.4.1
+     */
+    public List<?> readValues(List<Class<?>> classes) throws ReadValueException {
+        List<ExcelCell> excelCells = getCells();
+        if(excelCells.size() != classes.size()) {
+            throw new IllegalArgumentException("There are " + excelCells.size() + " items in the row and classlist has " + classes.size() + " values.");
+        }
+
+        List<Object> values = new LinkedList<>();
+        for (int i = 0; i < excelCells.size(); i++) {
+            values.add(excelCells.get(i).readValue(classes.get(i)));
+        }
+
+        return values;
+    }
+
+    /**
+     * Reads the values of all cells in the row as a String
+     * @return The list of values, such as String, written in the cells
+     * @since 0.4.1
+     */
+    public List<String> readValuesAsString() {
+        List<String> values = new LinkedList<>();
+        for (ExcelCell excelCell : getCells()) {
+            values.add(excelCell.readValueAsString());
+        }
+        return values;
+    }
+
     /**
      * Returns the Sheet to which it belongs
      * @return A ExcelSheet