Module jp.ecuacion.util.poi

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

Class CellOneLineHeaderExcelTableReader

java.lang.Object

jp.ecuacion.util.poi.excel.table.ExcelTable<org.apache.poi.ss.usermodel.Cell>

jp.ecuacion.util.poi.excel.table.reader.ExcelTableReader<org.apache.poi.ss.usermodel.Cell>

jp.ecuacion.util.poi.excel.table.reader.concrete.CellOneLineHeaderExcelTableReader

All Implemented Interfaces:

IfDataTypeCellExcelTable, IfExcelTable<org.apache.poi.ss.usermodel.Cell>, IfFormatOneLineHeaderExcelTable<org.apache.poi.ss.usermodel.Cell>, IfDataTypeCellExcelTableReader, IfExcelTableReader<org.apache.poi.ss.usermodel.Cell>, IfFormatOneLineHeaderExcelTableReader<org.apache.poi.ss.usermodel.Cell>

public class CellOneLineHeaderExcelTableReader
extends ExcelTableReader<org.apache.poi.ss.usermodel.Cell>
implements IfFormatOneLineHeaderExcelTableReader<org.apache.poi.ss.usermodel.Cell>, IfDataTypeCellExcelTableReader

Reads tables with known number of columns, known header labels and known start position of the table.

It obtains cell values as Cell object.

The header line is required. This class reads the table at the designated position and designated lines and columns.
Finish reading if all the columns are empty in a line.

Nested Class Summary

Nested classes/interfaces inherited from class jp.ecuacion.util.poi.excel.table.reader.ExcelTableReader

ExcelTableReader.IterableReader<T>, ExcelTableReader.IteratorReader<T>

Nested classes/interfaces inherited from class jp.ecuacion.util.poi.excel.table.ExcelTable

ExcelTable.ContextContainer

Field Summary

Fields inherited from class jp.ecuacion.util.poi.excel.table.reader.ExcelTableReader

tableColumnSizeGivenByConstructor, tableRowSizeGivenByConstructor

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

ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, sheetName, tableStartColumnNumber, tableStartRowNumber

Constructor Summary

Constructors

Constructor	Description
CellOneLineHeaderExcelTableReader(String sheetName, String[] headerLabels, Integer tableStartRowNumber, int tableStartColumnNumber, Integer tableRowSize)	Constructs a new instance. the obtained value from an empty cell is null.

Method Summary

Modifier and Type	Method	Description
String	getFarLeftAndTopHeaderLabel()	Returns the value of the far left and top header cell to specify the position of the table.
String[]	getHeaderLabels()	Defines the header labels in the excel table.

Methods inherited from class jp.ecuacion.util.poi.excel.table.reader.ExcelTableReader

getIterable, getReadyToReadTableData, getTableColumnSize, getTableRowSize, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, read, read, setTableColumnSize

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

getPoiBasisDeterminedTableStartColumnNumber, getPoiBasisDeterminedTableStartRowNumber, getSheetName, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite

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.IfDataTypeCellExcelTable

getStringValue

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

getCellData, isCellDataEmpty

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

getSheetName, ignoresAdditionalColumnsOfHeaderData, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, isVerticalAndHorizontalOpposite

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

validateHeaderData

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

getHeaderLabelData, getNumberOfHeaderLines

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

updateAndGetHeaderData

Constructor Details

CellOneLineHeaderExcelTableReader

public CellOneLineHeaderExcelTableReader(@RequireNonnull
 String sheetName,
 @RequireNonnull
 String[] headerLabels,
 @Nullable
 Integer tableStartRowNumber,
 int tableStartColumnNumber,
 @Nullable
 Integer tableRowSize)

Constructs a new instance. the obtained value from an empty cell is null.

tableColumnSize is not designated because tableColumnSize of the table is obviously equal to the length of the header array.

About the params sheetName, tableStartRowNumber, tableStartColumnNumber, tableRowSize and tableColumnSize, see ExcelTableReader(String, Integer, int, Integer, Integer).

Method Details

getFarLeftAndTopHeaderLabel

@Nonnull
public String getFarLeftAndTopHeaderLabel()

Description copied from interface: IfExcelTable

Returns the value of the far left and top header cell to specify the position of the table.

The method is called when tableStartRowNumber is null.
See ExcelTable.tableStartRowNumber

When the table doesn't have a header and tableStartRowNumber is null, an exception is thrown.
So always set non-null tableStartRowNumber value when the table doesn't have a header.

Specified by:

getFarLeftAndTopHeaderLabel in interface IfExcelTable<org.apache.poi.ss.usermodel.Cell>

Specified by:

getFarLeftAndTopHeaderLabel in interface IfFormatOneLineHeaderExcelTable<org.apache.poi.ss.usermodel.Cell>

Returns:

far left and top header label
"top" means the upper side of the header line when the table has multiple header lines.

getHeaderLabels

@Nonnull
public String[] getHeaderLabels()

Description copied from interface: IfFormatOneLineHeaderExcelTable

Defines the header labels in the excel table.

It can be like new String[] {"first name", "last name", "age"}.

Specified by:

getHeaderLabels in interface IfFormatOneLineHeaderExcelTable<org.apache.poi.ss.usermodel.Cell>