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

Interface IfFormatOneLineHeaderExcelTable<T>

Type Parameters:
T - See IfExcelTable.
All Superinterfaces:
IfExcelTable<T>
All Known Subinterfaces:
IfFormatOneLineHeaderExcelTableReader<T>
All Known Implementing Classes:
CellOneLineHeaderExcelTableReader, CellOneLineHeaderExcelTableWriter, StringOneLineHeaderExcelTableReader, StringOneLineHeaderExcelTableToBeanReader
public interface IfFormatOneLineHeaderExcelTable<T> extends IfExcelTable<T>
Is a reader interface which treats one line header format tables.

  • Method Details

    • getNumberOfHeaderLines

      default int getNumberOfHeaderLines()
      Description copied from interface: IfExcelTable
      Returns the number of header lines.
      Specified by:
      getNumberOfHeaderLines in interface IfExcelTable<T>
      Returns:
      the number of header lines

    • getHeaderLabels

      @Nonnull String[] getHeaderLabels()
      Defines the header labels in the excel table.

      It can be like new String[] {"first name", "last name", "age"}.

    • getHeaderLabelData

      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.