Merge pull request #3 from spacious-team/develop

Релиз 2021.4

Author: vananiev

.gitignore

@@ -20,6 +20,7 @@ target/
 *.iml
 *.ipr
 !.idea/runConfigurations
+!.idea/codeStyles
 !.idea/copyright
 
 ### NetBeans ###

.idea/codeStyles/Project.xml

@@ -5,15 +5,14 @@
 Предоставляет реализацию `Table Wrapper API` для удобного доступа к табличным данным, сохраненным в файлах формата
 Microsoft Office Excel (xls) и [Office Open XML](https://ru.wikipedia.org/wiki/Office_Open_XML) (xlsx).
 
-Пример создания фабрики таблиц
+Пример создания таблиц с первого листа файла `1.xlsx`
 ```java
 Workbook book = new XSSFWorkbook(Files.newInputStream(Path.of("1.xlsx")));
 ReportPage reportPage = new ExcelSheet(book.getSheetAt(0));
-TableFactory tableFactory = new ExcelTableFactory();
 
-Table table1 = tableFactory.create(reportPage, "Table 1 description", ...);
+Table table1 = reportPage.create("Table 1 description", ...);
 ...
-Table tableN = tableFactory.create(reportPage, "Table N description", ...);
+Table tableN = reportPage.create("Table N description", ...);
 ```
 Объекты `table`...`tableN` используются для удобного доступа к строкам и к значениям ячеек.
 
@@ -24,6 +23,14 @@ Table tableN = tableFactory.create(reportPage, "Table N description", ...);
 например для Apache Maven проекта
 ```xml
 <repositories>
+    <repository>
+        <id>central</id>
+        <name>Central Repository</name>
+        <url>https://repo.maven.apache.org/maven2</url>
+        <snapshots>
+            <enabled>false</enabled>
+        </snapshots>
+    </repository>
     <repository>
         <id>jitpack.io</id>
         <url>https://jitpack.io</url>

.idea/codeStyles/codeStyleConfig.xml

@@ -24,7 +24,7 @@
 
     <groupId>org.spacious-team</groupId>
     <artifactId>table-wrapper-excel-impl</artifactId>
-    <version>2020.12</version>
+    <version>2021.4</version>
     <packaging>jar</packaging>
 
     <name>Table Wrapper API Excel Implementation</name>
@@ -53,6 +53,14 @@
     </properties>
 
     <repositories>
+        <repository>
+            <id>central</id>
+            <name>Central Repository</name>
+            <url>https://repo.maven.apache.org/maven2</url>
+            <snapshots>
+                <enabled>false</enabled>
+            </snapshots>
+        </repository>
         <repository>
             <id>jitpack.io</id>
             <url>https://jitpack.io</url>
@@ -63,7 +71,7 @@
         <dependency>
             <groupId>com.github.spacious-team</groupId>
             <artifactId>table-wrapper-api</artifactId>
-            <version>2020.12</version>
+            <version>2021.4</version>
         </dependency>
         <dependency>
             <groupId>org.apache.poi</groupId>
@@ -83,4 +91,22 @@
             <optional>true</optional>
         </dependency>
     </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.2.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
 </project>

.idea/copyright/GNU_AGPLv3.xml

@@ -0,0 +1,70 @@
+/*
+ * Table Wrapper Excel Impl
+ * Copyright (C) 2021  Vitalii Ananev <an-vitek@ya.ru>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package org.spacious_team.table_wrapper.excel;
+
+import org.apache.poi.ss.usermodel.Cell;
+import org.apache.poi.ss.usermodel.FormulaError;
+import org.spacious_team.table_wrapper.api.CellDataAccessObject;
+
+import java.time.Instant;
+import java.time.LocalDateTime;
+
+public class ExcelCellDataAccessObject implements CellDataAccessObject<Cell, ExcelTableRow> {
+    public static final ExcelCellDataAccessObject INSTANCE = new ExcelCellDataAccessObject();
+
+    @Override
+    public Cell getCell(ExcelTableRow row, Integer cellIndex) {
+        return row.getRow().getCell(cellIndex);
+    }
+
+    @Override
+    public Object getValue(Cell cell) {
+        return switch (cell.getCellType()) {
+            case STRING -> cell.getStringCellValue();
+            case NUMERIC -> cell.getNumericCellValue(); // return double
+            case BLANK -> null;
+            case BOOLEAN -> cell.getBooleanCellValue();
+            case FORMULA -> getCachedFormulaValue(cell);
+            case ERROR -> throw new RuntimeException("Ячейка содержит ошибку вычисления формулы: " +
+                    FormulaError.forInt(cell.getErrorCellValue()));
+            case _NONE -> null;
+        };
+    }
+
+    @Override
+    public Instant getInstantValue(Cell cell) {
+        return cell.getDateCellValue().toInstant();
+    }
+
+    @Override
+    public LocalDateTime getLocalDateTimeValue(Cell cell) {
+        return cell.getLocalDateTimeCellValue();
+    }
+
+    private static Object getCachedFormulaValue(Cell cell) {
+        return switch (cell.getCachedFormulaResultType()) {
+            case BOOLEAN -> cell.getBooleanCellValue();
+            case NUMERIC -> cell.getNumericCellValue();
+            case STRING -> cell.getRichStringCellValue();
+            case ERROR -> throw new RuntimeException("Ячейка не содержит кешированный результат формулы: " +
+                    FormulaError.forInt(cell.getErrorCellValue()));
+            default -> null; //never should occur
+        };
+    }
+}

README.md

@@ -20,16 +20,16 @@
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import org.apache.poi.ss.usermodel.Cell;
 import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.usermodel.Sheet;
-import org.spacious_team.table_wrapper.api.ReportPage;
+import org.spacious_team.table_wrapper.api.AbstractReportPage;
 import org.spacious_team.table_wrapper.api.TableCellAddress;
-import org.spacious_team.table_wrapper.api.TableRow;
 
 import java.util.function.BiPredicate;
 
 @RequiredArgsConstructor
-public class ExcelSheet implements ReportPage {
+public class ExcelSheet extends AbstractReportPage<ExcelTableRow> {
 
     @Getter
     private final Sheet sheet;
@@ -41,7 +41,7 @@ public TableCellAddress find(Object value, int startRow, int endRow, int startCo
     }
 
     @Override
-    public TableRow getRow(int i) {
+    public ExcelTableRow getRow(int i) {
         Row row = sheet.getRow(i);
         return (row == null) ? null : new ExcelTableRow(row);
     }
@@ -50,4 +50,31 @@ public TableRow getRow(int i) {
     public int getLastRowNum() {
         return sheet.getLastRowNum();
     }
+
+    /**
+     * @param startRow first row for check
+     * @return index of first empty row or -1 if not found
+     */
+    @Override
+    public int findEmptyRow(int startRow) {
+        int lastRowNum = startRow;
+        LAST_ROW:
+        for (int n = getLastRowNum(); lastRowNum <= n; lastRowNum++) {
+            Row row = sheet.getRow(lastRowNum);
+            if (row == null || row.getLastCellNum() == -1) {
+                return lastRowNum; // all row cells blank
+            }
+            for (Cell cell : row) {
+                Object value;
+                if (!(cell == null
+                        || ((value = ExcelCellDataAccessObject.INSTANCE.getValue(cell)) == null)
+                        || (value instanceof String) && (value.toString().isEmpty()))) {
+                    // not empty
+                    continue LAST_ROW;
+                }
+            }
+            return lastRowNum; // all row cells blank
+        }
+        return -1;
+    }
 }

pom.xml

@@ -18,59 +18,36 @@
 
 package org.spacious_team.table_wrapper.excel;
 
+import lombok.AccessLevel;
+import lombok.Getter;
 import lombok.ToString;
-import org.apache.poi.ss.usermodel.Cell;
-import org.spacious_team.table_wrapper.api.*;
-
-import java.math.BigDecimal;
-import java.time.LocalDateTime;
-import java.util.Date;
+import org.spacious_team.table_wrapper.api.AbstractReportPage;
+import org.spacious_team.table_wrapper.api.AbstractTable;
+import org.spacious_team.table_wrapper.api.CellDataAccessObject;
+import org.spacious_team.table_wrapper.api.Table;
+import org.spacious_team.table_wrapper.api.TableCellRange;
+import org.spacious_team.table_wrapper.api.TableColumnDescription;
 
 @ToString(callSuper = true)
-public class ExcelTable extends AbstractTable {
+public class ExcelTable extends AbstractTable<ExcelTableRow> {
+
+    @Getter(AccessLevel.PROTECTED)
+    private final CellDataAccessObject<?, ExcelTableRow> cellDataAccessObject = ExcelCellDataAccessObject.INSTANCE;
 
-    ExcelTable(ReportPage reportPage,
+    ExcelTable(AbstractReportPage<ExcelTableRow> reportPage,
                String tableName,
                TableCellRange tableRange,
                Class<? extends TableColumnDescription> headerDescription,
                int headersRowCount) {
         super(reportPage, tableName, tableRange, headerDescription, headersRowCount);
     }
 
-    @Override
-    public Object getCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return ExcelTableHelper.getCellValue(getRawCell(row, columnDescription));
-    }
-
-    @Override
-    public int getIntCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return (int) getLongCellValue(row, columnDescription);
-    }
-
-    @Override
-    public long getLongCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return ExcelTableHelper.getLongCellValue(getRawCell(row, columnDescription));
-    }
-
-    @Override
-    public BigDecimal getCurrencyCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return ExcelTableHelper.getCurrencyCellValue(getRawCell(row, columnDescription));
+    ExcelTable(AbstractTable<ExcelTableRow> table, int appendDataRowsToTop, int appendDataRowsToBottom) {
+        super(table, appendDataRowsToTop, appendDataRowsToBottom);
     }
 
     @Override
-    public String getStringCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return ExcelTableHelper.getStringCellValue(getRawCell(row, columnDescription));
-    }
-
-    public Date getDateCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return getRawCell(row, columnDescription).getDateCellValue();
-    }
-
-    public LocalDateTime getLocalDateTimeCellValue(TableRow row, TableColumnDescription columnDescription) {
-        return getRawCell(row, columnDescription).getLocalDateTimeCellValue();
-    }
-
-    private Cell getRawCell(TableRow row, TableColumnDescription columnDescription) {
-        return ((ExcelTableRow) row).getRow().getCell(columnIndices.get(columnDescription.getColumn()));
+    public Table subTable(int topRows, int bottomRows) {
+        return new ExcelTable(this, topRows, bottomRows);
     }
 }

src/main/java/org/spacious_team/table_wrapper/excel/ExcelCellDataAccessObject.java

@@ -18,29 +18,19 @@
 
 package org.spacious_team.table_wrapper.excel;
 
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
 import org.apache.poi.ss.usermodel.Cell;
-import org.spacious_team.table_wrapper.api.TableCell;
+import org.spacious_team.table_wrapper.api.AbstractTableCell;
 
-@RequiredArgsConstructor
-public class ExcelTableCell implements TableCell {
+import static org.spacious_team.table_wrapper.excel.ExcelCellDataAccessObject.INSTANCE;
 
-    @Getter
-    private final Cell cell;
+public class ExcelTableCell extends AbstractTableCell<Cell> {
 
-    @Override
-    public int getColumnIndex() {
-        return cell.getColumnIndex();
-    }
-
-    @Override
-    public Object getValue() {
-        return ExcelTableHelper.getCellValue(cell);
+    public ExcelTableCell(Cell cell) {
+        super(cell, INSTANCE);
     }
 
     @Override
-    public String getStringCellValue() {
-        return ExcelTableHelper.getStringCellValue(cell);
+    public int getColumnIndex() {
+        return getCell().getColumnIndex();
     }
 }