Module jp.ecuacion.util.poi

Package jp.ecuacion.util.poi.excel.table.reader

Class ExcelTableReader<T>

java.lang.Object

jp.ecuacion.util.poi.excel.table.ExcelTable<T>

jp.ecuacion.util.poi.excel.table.reader.ExcelTableReader<T>

Type Parameters:

T - See IfExcelTable.

All Implemented Interfaces:

IfExcelTable<T>, IfExcelTableReader<T>

Direct Known Subclasses:

CellFreeExcelTableReader, CellOneLineHeaderExcelTableReader, StringExcelTableReader

public abstract class ExcelTableReader<T>
extends ExcelTable<T>
implements IfExcelTableReader<T>

Is a parent of excel table reader classes.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Min(1L) Integer	tableColumnSize	Is the column size of the table.
protected @Min(1L) Integer	tableRowSize	Is the row size of the table.

Fields inherited from class jp.ecuacion.util.poi.excel.table.ExcelTable

sheetName, tableStartColumnNumber, tableStartRowNumber

Constructor Summary

Constructors

Constructor	Description
ExcelTableReader(String sheetName, Integer tableStartRowNumber, int tableStartColumnNumber, Integer tableRowSize, Integer tableColumnSize)	Constructs a new instance with the sheet name, the position and the size of the excel table.

Method Summary

Modifier and Type	Method	Description
ExcelReadUtil	getExcelReadUtil()	Returns an instance of ExcelReadUtil.
protected Integer	getTableColumnSize(org.apache.poi.ss.usermodel.Sheet sheet, int poiBasisDeterminedTableStartRowNumber, int poiBasisDeterminedTableStartColumnNumber)	Returns tableColumnSize, may be null.
protected Integer	getTableRowSize()	Returns tableRowSize, may be null.
List<List<T>>	read(String excelPath)	Reads a table data in an excel file at excelPath and Return it in the form of List<List<String>>.
void	setTableColumnSize(int tableColumnSize)	sets tableColumnSize.

Methods inherited from class jp.ecuacion.util.poi.excel.table.ExcelTable

getPoiBasisDeterminedTableStartColumnNumber, getPoiBasisDeterminedTableStartRowNumber, getSheetName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jp.ecuacion.util.poi.excel.table.IfExcelTable

getFarLeftAndTopHeaderLabel, getHeaderLabelData, getSheetName, getStringValue, validateHeaderData

Methods inherited from interface jp.ecuacion.util.poi.excel.table.reader.IfExcelTableReader

getCellData, isCellDataEmpty, updateAndGetHeaderData

Field Details

tableRowSize

@Min(1L)
protected @Min(1L) Integer tableRowSize

Is the row size of the table.

It's equal to or greater than 1.
0 or the number smaller than that is not acceptable.
null is acceptable, which means tableRowSize is decided for the program to find an empty row.
When the table has a header, the row size includes the header line,

tableColumnSize

@Min(1L)
protected @Min(1L) Integer tableColumnSize

Is the column size of the table.

It's equal to or greater than 1.
0 or the number smaller than that is not acceptable.
null is acceptable, which means tableColumnSize is decided by the length of the header. Empty header cell means it's the end of the header.
When the table has a header, the row size includes the header line,

Constructor Details

ExcelTableReader

public ExcelTableReader(@RequireNonnull
 String sheetName,
 @Nullable
 Integer tableStartRowNumber,
 int tableStartColumnNumber,
 @Nullable
 Integer tableRowSize,
 @Nullable
 Integer tableColumnSize)

Constructs a new instance with the sheet name, the position and the size of the excel table.

Parameters:

sheetName - See ExcelTable.sheetName.

tableStartRowNumber - See ExcelTable.tableStartRowNumber.

tableStartColumnNumber - See ExcelTable.tableStartColumnNumber.

tableRowSize - See tableRowSize.

tableColumnSize - See tableColumnSize.

Method Details

read

@Nonnull
public List<List<T>> read(@RequireNonnull
 String excelPath)
                   throws org.apache.poi.EncryptedDocumentException,
jp.ecuacion.lib.core.exception.checked.AppException,
IOException

Reads a table data in an excel file at excelPath and Return it in the form of List<List<String>>.

The internal List<String> stores data in one line.
The external List stores lines of List<String>.

Throws:

IOException - IOException

jp.ecuacion.lib.core.exception.checked.AppException - AppException

org.apache.poi.EncryptedDocumentException - EncryptedDocumentException

getTableRowSize

@Nullable
protected Integer getTableRowSize()

Returns tableRowSize, may be null.

getTableColumnSize

@Nonnull
protected Integer getTableColumnSize(@RequireNonnull
 org.apache.poi.ss.usermodel.Sheet sheet,
 int poiBasisDeterminedTableStartRowNumber,
 int poiBasisDeterminedTableStartColumnNumber)
                              throws jp.ecuacion.lib.core.exception.checked.BizLogicAppException

Returns tableColumnSize, may be null.

Parameters:

sheet - sheet

poiBasisDeterminedTableStartRowNumber - poiBasisDeterminedTableStartRowNumber

poiBasisDeterminedTableStartColumnNumber - poiBasisDeterminedTableStartRowNumber

Throws:

jp.ecuacion.lib.core.exception.checked.BizLogicAppException - BizLogicAppException

setTableColumnSize

public void setTableColumnSize(int tableColumnSize)

sets tableColumnSize.

tableColumnSize can be set by the header length, but the instance method cannot be called from constructors so the setter is needed.

This method set the final value of the column size, so the argument is not Integer, but primitive int.

Parameters:

tableColumnSize - tableColumnSize.

getExcelReadUtil

public ExcelReadUtil getExcelReadUtil()

Description copied from interface: IfExcelTableReader

Returns an instance of ExcelReadUtil.

Specified by:

getExcelReadUtil in interface IfExcelTableReader<T>

Returns:

ExcelReadUtil instance