Added methods to be able to remove a sheet, row or cell. Added methods to be able to retrieve a row or cell based on an index. Fixed the getIndex() method of a sheet not being updated after deleting a sheet.

Author: MBenincasa

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,7 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
+import io.github.mbenincasa.javaexcelutils.exceptions.CellNotFoundException;
+import io.github.mbenincasa.javaexcelutils.exceptions.RowNotFoundException;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -31,6 +33,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 +53,35 @@ 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());
+    }
+
+    /**
+     * 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());
+    }
+
     /**
      * Returns the Sheet to which it belongs
      * @return A ExcelSheet

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

@@ -1,8 +1,10 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
+import io.github.mbenincasa.javaexcelutils.exceptions.RowNotFoundException;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
+import lombok.SneakyThrows;
 import org.apache.poi.ss.usermodel.Cell;
 import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.usermodel.Sheet;
@@ -20,6 +22,17 @@
 @EqualsAndHashCode
 public class ExcelSheet {
 
+    /**
+     * The Sheet index in the Workbook
+     * @return The Sheet index
+     */
+    @SneakyThrows
+    public Integer getIndex() {
+        if (this.sheet == null)
+            return null;
+        return getWorkbook().getWorkbook().getSheetIndex(this.name);
+    }
+
     /**
      * This object refers to the Apache POI Library {@code Sheet}
      */
@@ -43,6 +56,17 @@ public ExcelWorkbook getWorkbook() {
         return new ExcelWorkbook(this.getSheet().getWorkbook());
     }
 
+    /**
+     * Remove the selected Sheet
+     * @since 0.4.1
+     */
+    public void remove() {
+        getWorkbook().removeSheet(getIndex());
+        this.sheet = null;
+        this.name = null;
+        this.index = null;
+    }
+
     /**
      * The list of Rows related to the Sheet
      * @return A list of Rows
@@ -52,10 +76,36 @@ public List<ExcelRow> getRows() {
         for (Row row : this.sheet) {
             excelRows.add(new ExcelRow(row, row.getRowNum()));
         }
-        
+
         return excelRows;
     }
 
+    /**
+     * Retrieve a row by index
+     * @param index The index of the row requested
+     * @return A ExcelRow
+     * @throws RowNotFoundException If the row is not present or has not been created
+     * @since 0.4.1
+     */
+    public ExcelRow getRow(Integer index) throws RowNotFoundException {
+        Row row = this.sheet.getRow(index);
+        if (row == null) {
+            throw new RowNotFoundException("There is not a row in the index: " + index);
+        }
+        return new ExcelRow(row, index);
+    }
+
+    /**
+     * Removes a row by index
+     * @param index The index of the row to remove
+     * @throws RowNotFoundException If the row is not present or has not been created
+     * @since 0.4.1
+     */
+    public void removeRow(Integer index) throws RowNotFoundException {
+        ExcelRow excelRow = getRow(index);
+        this.sheet.removeRow(excelRow.getRow());
+    }
+
     /**
      * Create a new Row in the Sheet
      * @param index The index in the Sheet

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

@@ -96,10 +96,9 @@ public static ExcelWorkbook open(File file) throws ExtensionNotValidException, I
      * @param extension The file's extension
      * @return An ExcelWorkBook that is represented in the Excel file
      * @throws ExtensionNotValidException If the input file extension does not belong to an Excel file
-     * @throws IOException If an I/O error has occurred
      * @throws OpenWorkbookException If an error occurred while opening the workbook
      */
-    public static ExcelWorkbook open(InputStream inputStream, String extension) throws ExtensionNotValidException, IOException, OpenWorkbookException {
+    public static ExcelWorkbook open(InputStream inputStream, String extension) throws ExtensionNotValidException, OpenWorkbookException {
         /* Check the extension */
         if (!ExcelUtility.isValidExcelExtension(extension)) {
             throw new ExtensionNotValidException("Pass a file with the XLS or XLSX extension");
@@ -300,6 +299,15 @@ public ExcelSheet getSheetOrCreate(String sheetName) {
         }
     }
 
+    /**
+     * Remove the Sheet
+     * @param index The index of the Sheet in the workbook that will be removed
+     * @since 0.4.1
+     */
+    public void removeSheet(Integer index) {
+        this.workbook.removeSheetAt(index);
+    }
+
     /**
      * Check if the sheet is present
      * @param sheetName The name of the sheet

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

@@ -1,9 +1,6 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
-import io.github.mbenincasa.javaexcelutils.exceptions.ExtensionNotValidException;
-import io.github.mbenincasa.javaexcelutils.exceptions.OpenWorkbookException;
-import io.github.mbenincasa.javaexcelutils.exceptions.ReadValueException;
-import io.github.mbenincasa.javaexcelutils.exceptions.SheetNotFoundException;
+import io.github.mbenincasa.javaexcelutils.exceptions.*;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -113,4 +110,15 @@ void readValueAsString() throws OpenWorkbookException, ExtensionNotValidExceptio
         Assertions.assertEquals("1/1/21 21:21", excelCell2.readValueAsString());
         Assertions.assertEquals("FALSE", excelCell3.readValueAsString());
     }
+
+    @Test
+    void remove() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException, RowNotFoundException, CellNotFoundException {
+        ExcelWorkbook excelWorkbook = ExcelWorkbook.open(excelFile);
+        ExcelSheet excelSheet = excelWorkbook.getSheet();
+        ExcelRow excelRow = excelSheet.getRow(0);
+        ExcelCell excelCell = excelRow.getCell(0);
+        Assertions.assertDoesNotThrow(excelCell::remove);
+        Assertions.assertNull(excelCell.getCell());
+        Assertions.assertNull(excelCell.getIndex());
+    }
 }

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

@@ -1,8 +1,6 @@
 package io.github.mbenincasa.javaexcelutils.model.excel;
 
-import io.github.mbenincasa.javaexcelutils.exceptions.ExtensionNotValidException;
-import io.github.mbenincasa.javaexcelutils.exceptions.OpenWorkbookException;
-import io.github.mbenincasa.javaexcelutils.exceptions.SheetNotFoundException;
+import io.github.mbenincasa.javaexcelutils.exceptions.*;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -62,4 +60,33 @@ void countAllColumns() throws OpenWorkbookException, ExtensionNotValidException,
         Assertions.assertEquals(4, excelRows.get(0).countAllColumns(false));
         Assertions.assertEquals(3, excelRows.get(1).countAllColumns(true));
     }
+
+    @Test
+    void remove() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException, RowNotFoundException {
+        ExcelWorkbook excelWorkbook = ExcelWorkbook.open(excelFile);
+        ExcelSheet excelSheet = excelWorkbook.getSheet(0);
+        ExcelRow excelRow = excelSheet.getRow(0);
+        Assertions.assertDoesNotThrow(excelRow::remove);
+        Assertions.assertNull(excelRow.getRow());
+        Assertions.assertNull(excelRow.getIndex());
+    }
+
+    @Test
+    void getCell() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException, RowNotFoundException, CellNotFoundException {
+        ExcelWorkbook excelWorkbook = ExcelWorkbook.open(excelFile);
+        ExcelSheet excelSheet = excelWorkbook.getSheet(0);
+        ExcelRow excelRow = excelSheet.getRow(0);
+        ExcelCell excelCell = excelRow.getCell(0);
+        Assertions.assertEquals(0, excelCell.getIndex());
+        Assertions.assertNotNull(excelCell.getCell());
+    }
+
+    @Test
+    void removeCell() throws OpenWorkbookException, ExtensionNotValidException, IOException, SheetNotFoundException, RowNotFoundException {
+        ExcelWorkbook excelWorkbook = ExcelWorkbook.open(excelFile);
+        ExcelSheet excelSheet = excelWorkbook.getSheet(0);
+        ExcelRow excelRow = excelSheet.getRow(0);
+        Assertions.assertDoesNotThrow(() -> excelRow.removeCell(0));
+        Assertions.assertThrows(CellNotFoundException.class, () -> excelRow.getCell(0));
+    }
 }