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, StringFreeExcelTableReader, StringOneLineHeaderExcelTableReader, StringOneLineHeaderExcelTableToBeanReader
public interface IfExcelTable<T>
Provides the methods the extending interfaces use.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFarLeftHeaderLabel()
    Returns the value of the far left header cell to specify the position of the table.
    String
    getSheetName()
    Returns the excel sheet name the TableReader and the TableWriter access.
    String
    getStringValue(T cellData)
    Is used to get the header label string from the argument cell data.
    void
    validateHeader(List<List<String>> headerData)
    Validates the excel table header.

  • 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

    • getFarLeftHeaderLabel

      @Nonnull String getFarLeftHeaderLabel()
      Returns the value of the far left 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, an exception is thrown if tableStartRowNumber is null.
      So always set non-null tableStartRowNumber value when the table doesn't have a header.

      Returns:
      far left header label

    • validateHeader

      void validateHeader(@RequireNonnull List<List<String>> headerData) throws jp.ecuacion.lib.core.exception.checked.BizLogicAppException
      Validates the excel table header.

      If the table doesn't have a header, nothing needs to be done in this method.

      Parameters:
      headerData - string header data
      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