Module jp.ecuacion.util.poi

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

Class StringFreeExcelTableReader

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

All Implemented Interfaces:

IfDataTypeStringExcelTable, IfExcelTable<String>, IfFormatFreeExcelTable<String>, IfDataTypeStringExcelTableReader, IfExcelTableReader<String>, IfFormatFreeExcelTableReader<String>

public class StringFreeExcelTableReader
extends StringExcelTableReader
implements IfFormatFreeExcelTableReader<String>

Reads tables with unknown number of columns, unknown whether it have a header line, unknown header labels if it has a header line.

It obtains cell values as String.

The header line is not necessary. This class reads the table at the designated position and designated lines and columns.
Finish reading if all the columns are empty in one 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.concrete.StringExcelTableReader

columnDateTimeFormatMap, dateTimeFormat

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
StringFreeExcelTableReader(String sheetName, Integer tableStartRowNumber, int tableStartColumnNumber, Integer tableRowSize, Integer tableColumnSize)	Constructs a new instance.
StringFreeExcelTableReader(String sheetName, Integer tableStartRowNumber, int tableStartColumnNumber, Integer tableRowSize, Integer tableColumnSize, NoDataString noDataString)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
StringFreeExcelTableReader	columnDateTimeFormat(int columnNumber, DateTimeFormatter dateTimeFormat)	Sets dateTimeFormat for specific column.
StringFreeExcelTableReader	defaultDateTimeFormat(DateTimeFormatter dateTimeFormat)	Sets defaultDateTimeFormat.
NoDataString	getNoDataString()	Gets NoDataString.

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

getDateTimeFormat

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.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, ignoresAdditionalColumnsOfHeaderData, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, isVerticalAndHorizontalOpposite

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

getFarLeftAndTopHeaderLabel, getHeaderLabelData, getNumberOfHeaderLines

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

updateAndGetHeaderData, validateHeaderData

Constructor Details

StringFreeExcelTableReader

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

Constructs a new instance.

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

StringFreeExcelTableReader

public StringFreeExcelTableReader(@RequireNonnull
 String sheetName,
 @Nullable
 Integer tableStartRowNumber,
 int tableStartColumnNumber,
 @Nullable
 Integer tableRowSize,
 @Nullable
 Integer tableColumnSize,
 @Nonnull
 NoDataString noDataString)

Constructs a new instance.

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

Parameters:

noDataString - noDataString

Method Details

getNoDataString

public NoDataString getNoDataString()

Description copied from interface: IfDataTypeStringExcelTableReader

Gets NoDataString.

Specified by:

getNoDataString in interface IfDataTypeStringExcelTableReader

Returns:

NoDataString

defaultDateTimeFormat

public StringFreeExcelTableReader 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 StringFreeExcelTableReader 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)