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

Interface IfExcelTable<T>

Type Parameters:
T - The data type obtained from the excel table. For example it would be String if you want String data from each cell in the table.
All Known Subinterfaces:
IfDataTypeCellExcelTable, IfDataTypeCellExcelTableReader, IfDataTypeCellExcelTableWriter, IfDataTypeStringExcelTable, IfDataTypeStringExcelTableReader, IfExcelTableReader<T>, IfExcelTableWriter<T>, IfFormatFreeExcelTable<T>, IfFormatFreeExcelTableReader<T>, IfFormatOneLineHeaderExcelTable<T>, IfFormatOneLineHeaderExcelTableReader<T>
All Known Implementing Classes:
CellFreeExcelTableReader, CellFreeExcelTableWriter, CellOneLineHeaderExcelTableReader, CellOneLineHeaderExcelTableWriter, ExcelTable, ExcelTableReader, ExcelTableWriter, StringExcelTableReader, StringFreeExcelTableReader, StringOneLineHeaderExcelTableReader, StringOneLineHeaderExcelTableToBeanReader
public interface IfExcelTable<T>
Provides the methods the extending interfaces use.

  • Method Details

    • getSheetName

      @Nonnull String getSheetName()
      Returns the excel sheet name the TableReader and the TableWriter access.
      Returns:
      the sheet name of the excel file

    • getNumberOfHeaderLines

      int getNumberOfHeaderLines()
      Returns the number of header lines.
      Returns:
      the number of header lines

    • getFarLeftAndTopHeaderLabel

      @Nonnull String getFarLeftAndTopHeaderLabel()
      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.

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

    • getHeaderLabelData

      @Nonnull String[][] getHeaderLabelData()
      Returns an array of header label strings.

      The data type of the return is String[][] because table header can be multiple lines.

      Returns:
      table header label strings

    • validateHeaderData

      default void validateHeaderData(@RequireNonnull List<List<String>> headerData) throws jp.ecuacion.lib.core.exception.checked.BizLogicAppException
      Validates the excel table header.
      Parameters:
      headerData - string header data
      The data type is List<List<String>> headerData because the header with multiple lines may exist.
      Pass a list with `size() == 0` when it's a table with no header or nothing to validate.
      Throws:
      jp.ecuacion.lib.core.exception.checked.BizLogicAppException - BizLogicAppException

    • getStringValue

      @Nullable String getStringValue(@Nullable T cellData)
      Is used to get the header label string from the argument cell data.
      Parameters:
      cellData - data obtained from the cell
      Returns:
      String value obtained from the cellData