Module jp.ecuacion.util.poi

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

Class StringOneLineHeaderExcelTableReader

java.lang.Object

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

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

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

All Implemented Interfaces:

IfDataTypeStringExcelTable, IfExcelTable<String>, IfFormatOneLineHeaderExcelTable<String>, IfDataTypeStringExcelTableReader, IfExcelTableReader<String>, IfFormatOneLineHeaderExcelTableReader<String>

Direct Known Subclasses:

StringOneLineHeaderExcelTableToBeanReader

public class StringOneLineHeaderExcelTableReader
extends ExcelTableReader<String>
implements IfFormatOneLineHeaderExcelTableReader<String>, IfDataTypeStringExcelTableReader

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

It obtains cell values as String.

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.

Field Summary

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

tableColumnSize, tableRowSize

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

sheetName, tableStartColumnNumber, tableStartRowNumber

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String[]	getHeaderLabels()	Defines the header labels in the excel table.
NoDataString	getNoDataString()	Gets NoDataString.

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

getExcelReadUtil, getTableColumnSize, getTableRowSize, read, setTableColumnSize

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

getStringValue

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

getCellData, isCellDataEmpty

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

getSheetName

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

getExcelReadUtil

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

getFarLeftHeaderLabel, validateHeader

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

updateAndGetHeaderList

Constructor Details

StringOneLineHeaderExcelTableReader

public StringOneLineHeaderExcelTableReader(@RequireNonnull
 String sheetName,
 @RequireNonnull
 String[] headerLabels,
 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).

StringOneLineHeaderExcelTableReader

public StringOneLineHeaderExcelTableReader(@RequireNonnull
 String sheetName,
 @RequireNonnull
 String[] headerLabels,
 @Nullable
 Integer tableStartRowNumber,
 int tableStartColumnNumber,
 @Nullable
 Integer tableRowSize,
 @Nonnull
 NoDataString noDataString)

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

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

Parameters:

sheetName - the sheet name of the excel file

tableStartRowNumber - tableStartRowNumber

tableStartColumnNumber - tableStartColumnNumber

tableRowSize - tableRowSize

noDataString - the obtained value from an empty cell. null or "".

Method Details

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<String>

getNoDataString

public NoDataString getNoDataString()

Description copied from interface: IfDataTypeStringExcelTableReader

Gets NoDataString.

Specified by:

getNoDataString in interface IfDataTypeStringExcelTableReader

Returns:

NoDataString