Module jp.ecuacion.util.poi

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

Class ExcelTableWriter<T>

java.lang.Object

jp.ecuacion.util.poi.excel.table.ExcelTable<T>

jp.ecuacion.util.poi.excel.table.writer.ExcelTableWriter<T>

Type Parameters:

T - See IfExcelTable.

All Implemented Interfaces:

IfExcelTable<T>, IfExcelTableWriter<T>

Direct Known Subclasses:

CellFreeExcelTableWriter, CellOneLineHeaderExcelTableWriter

public abstract class ExcelTableWriter<T>
extends ExcelTable<T>
implements IfExcelTableWriter<T>

Is a parent of excel table writer classes.

Field Summary

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

sheetName, tableStartColumnNumber, tableStartRowNumber

Constructor Summary

Constructors

Constructor	Description
ExcelTableWriter(String sheetName, Integer tableStartRowNumber, int tableStartColumnNumber)	Constructs a new instance with the sheet name, the position of the excel table.

Method Summary

Modifier and Type	Method	Description
protected abstract List<List<String>>	getHeaderData(String templateFilePath, int tableColumnSize)	Obtains header list from the file at templateFilePath.
void	write(String templateFilePath, String destFilePath, List<List<T>> data)	Writes table data to the designated excel file.

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

getFarLeftAndTopHeaderLabel, getHeaderLabelData, getSheetName, getStringValue, validateHeaderData

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

writeToCell

Constructor Details

ExcelTableWriter

public ExcelTableWriter(@RequireNonnull
 String sheetName,
 @Nullable
 Integer tableStartRowNumber,
 int tableStartColumnNumber)

Constructs a new instance with the sheet name, the position of the excel table.

Parameters:

sheetName - See ExcelTable.sheetName.

tableStartRowNumber - See ExcelTable.tableStartRowNumber.

tableStartColumnNumber - See ExcelTable.tableStartColumnNumber.

Method Details

write

public void write(@Nullable
 String templateFilePath,
 @RequireNonnull
 String destFilePath,
 @RequireNonnull
 List<List<T>> data)
           throws Exception

Writes table data to the designated excel file.

Parameters:

destFilePath - destFilePath

data - dataList

Throws:

Exception

getHeaderData

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

Obtains header list from the file at templateFilePath.

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:

IOException - IOException

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

org.apache.poi.EncryptedDocumentException - EncryptedDocumentException