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

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 StringExcelTableReader
implements IfFormatOneLineHeaderExcelTableReader<String>

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.

Nested Class Summary

Nested classes/interfaces inherited from class ExcelTableReader

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

Nested classes/interfaces inherited from class ExcelTable

ExcelTable.ContextContainer

Field Summary

Fields inherited from class StringExcelTableReader

columnDateTimeFormatMap, dateTimeFormat

Fields inherited from class ExcelTableReader

tableColumnSizeGivenByConstructor, tableRowSizeGivenByConstructor

Fields inherited from class ExcelTable

ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, 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
StringOneLineHeaderExcelTableReader	columnDateTimeFormat(int columnNumber, DateTimeFormatter dateTimeFormat)	Sets dateTimeFormat for specific column.
StringOneLineHeaderExcelTableReader	defaultDateTimeFormat(DateTimeFormatter dateTimeFormat)	Sets defaultDateTimeFormat.
String[]	getHeaderLabels()	Defines the header labels in the excel table.
NoDataString	getNoDataString()	Gets NoDataString.

Methods inherited from class StringExcelTableReader

getDateTimeFormat

Methods inherited from class ExcelTableReader

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

Methods inherited from class ExcelTable

getPoiBasisDeterminedTableStartColumnNumber, getPoiBasisDeterminedTableStartRowNumber, getSheetName, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite

Methods inherited from class Object

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

Methods inherited from interface IfDataTypeStringExcelTable

getStringValue

Methods inherited from interface IfDataTypeStringExcelTableReader

getCellData, isCellDataEmpty

Methods inherited from interface IfExcelTable

getSheetName, ignoresAdditionalColumnsOfHeaderData, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, isVerticalAndHorizontalOpposite

Methods inherited from interface IfExcelTableReader

validateHeaderData

Methods inherited from interface IfFormatOneLineHeaderExcelTable

getFarLeftAndTopHeaderLabel, getHeaderLabelData, getNumberOfHeaderLines

Methods inherited from interface IfFormatOneLineHeaderExcelTableReader

updateAndGetHeaderData

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

defaultDateTimeFormat

public StringOneLineHeaderExcelTableReader defaultDateTimeFormat(DateTimeFormatter dateTimeFormat)

Description copied from class: StringExcelTableReader

Sets defaultDateTimeFormat.

Overrides:

defaultDateTimeFormat in class StringExcelTableReader

Parameters:

dateTimeFormat - dateTimeFormat string for DateTimeFormatter.

Returns:

StringExcelTableReader (for method chain)

columnDateTimeFormat

public StringOneLineHeaderExcelTableReader columnDateTimeFormat(int columnNumber,
 DateTimeFormatter dateTimeFormat)

Description copied from class: StringExcelTableReader

Sets dateTimeFormat for specific column.

Overrides:

columnDateTimeFormat in class StringExcelTableReader

Parameters:

columnNumber - the column number data is obtained from, starting with 1 and column A is equal to columnNumber 1. When the far left column of a table is 2 and you want to speciries the far left column, the columnNumber is 2.

dateTimeFormat - dateTimeFormat string for DateTimeFormatter.

Returns:

StringExcelTableReader (for method chain)