Module jp.ecuacion.util.poi

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

Class CellOneLineHeaderExcelTableWriter

java.lang.Object

jp.ecuacion.util.poi.excel.table.ExcelTable<org.apache.poi.ss.usermodel.Cell>

jp.ecuacion.util.poi.excel.table.writer.ExcelTableWriter<org.apache.poi.ss.usermodel.Cell>

jp.ecuacion.util.poi.excel.table.writer.concrete.CellOneLineHeaderExcelTableWriter

All Implemented Interfaces:

IfDataTypeCellExcelTable, IfExcelTable<org.apache.poi.ss.usermodel.Cell>, IfFormatOneLineHeaderExcelTable<org.apache.poi.ss.usermodel.Cell>, IfDataTypeCellExcelTableWriter, IfExcelTableWriter<org.apache.poi.ss.usermodel.Cell>

public class CellOneLineHeaderExcelTableWriter
extends ExcelTableWriter<org.apache.poi.ss.usermodel.Cell>
implements IfDataTypeCellExcelTableWriter, IfFormatOneLineHeaderExcelTable<org.apache.poi.ss.usermodel.Cell>

Reads tables with known number of columns, one line header labels if it has a header line.

Field Summary

Fields inherited from class jp.ecuacion.util.poi.excel.table.ExcelTable

sheetName, tableStartColumnNumber, tableStartRowNumber

Constructor Summary

Constructors

Constructor	Description
CellOneLineHeaderExcelTableWriter(String sheetName, String[] headerLabels, Integer tableStartRowNumber, int tableStartColumnNumber)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected List<List<String>>	getHeaderData(String templateFilePath, int tableColumnSize)	Obtains header list from the file at templateFilePath.
String[]	getHeaderLabels()	Defines the header labels in the excel table.

Methods inherited from class jp.ecuacion.util.poi.excel.table.writer.ExcelTableWriter

write

Methods inherited from class jp.ecuacion.util.poi.excel.table.ExcelTable

getPoiBasisDeterminedTableStartColumnNumber, getPoiBasisDeterminedTableStartRowNumber, getSheetName

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

getStringValue

Methods inherited from interface jp.ecuacion.util.poi.excel.table.writer.IfDataTypeCellExcelTableWriter

writeToCell

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

getSheetName, validateHeaderData

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

getFarLeftAndTopHeaderLabel, getHeaderLabelData, validateHeader

Constructor Details

CellOneLineHeaderExcelTableWriter

public CellOneLineHeaderExcelTableWriter(@RequireNonnull
 String sheetName,
 @RequireNonnull
 String[] headerLabels,
 @Nullable
 Integer tableStartRowNumber,
 int tableStartColumnNumber)

Constructs a new instance.

Parameters:

sheetName - See ExcelTable.sheetName.

tableStartRowNumber - See ExcelTable.tableStartRowNumber.

tableStartColumnNumber - See ExcelTable.tableStartColumnNumber.

Method Details

getHeaderLabels

@Nonnull
public String[] getHeaderLabels()

Description copied from interface: IfFormatOneLineHeaderExcelTable

Defines the header labels in the excel table.

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

Specified by:

getHeaderLabels in interface IfFormatOneLineHeaderExcelTable<org.apache.poi.ss.usermodel.Cell>

getHeaderData

protected List<List<String>> getHeaderData(@Nullable
 String templateFilePath,
 int tableColumnSize)
                                    throws org.apache.poi.EncryptedDocumentException,
jp.ecuacion.lib.core.exception.checked.AppException,
IOException

Description copied from class: ExcelTableWriter

Obtains header list from the file at templateFilePath.

Specified by:

getHeaderData in class ExcelTableWriter<org.apache.poi.ss.usermodel.Cell>

Parameters:

templateFilePath - nullable when the data is written to a new excel file.

tableColumnSize - tableColumnSize

Returns:

the list of String, may be an empty list when templateFilePath is null.

Throws:

org.apache.poi.EncryptedDocumentException - EncryptedDocumentException

jp.ecuacion.lib.core.exception.checked.AppException - AppException

IOException - IOException