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

Interface IfFormatFreeExcelTable<T>

Type Parameters:
T - See IfExcelTable.
All Superinterfaces:
IfExcelTable<T>
All Known Subinterfaces:
IfFormatFreeExcelTableReader<T>
All Known Implementing Classes:
CellFreeExcelTableReader, CellFreeExcelTableWriter, StringFreeExcelTableReader
public interface IfFormatFreeExcelTable<T> extends IfExcelTable<T>
Is a reader interface which treats free format tables.

  • Method Details

    • validateHeaderData

      default void validateHeaderData(@Nullable List<List<String>> headerData)
      Description copied from interface: IfExcelTable
      Validates the excel table header.
      Specified by:
      validateHeaderData in interface IfExcelTable<T>
      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.

    • getHeaderLabelData

      @Nonnull default String[][] getHeaderLabelData()
      Description copied from interface: IfExcelTable
      Returns an array of header label strings.

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

      Specified by:
      getHeaderLabelData in interface IfExcelTable<T>
      Returns:
      table header label strings

    • getFarLeftAndTopHeaderLabel

      @Nonnull default String getFarLeftAndTopHeaderLabel()
      Description copied from interface: IfExcelTable
      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.

      Specified by:
      getFarLeftAndTopHeaderLabel in interface IfExcelTable<T>
      Returns:
      far left and top header label
      "top" means the upper side of the header line when the table has multiple header lines.