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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExcelTableWriter.IterableWriter<T>	Provides Iterable.

Nested classes/interfaces inherited from class jp.ecuacion.util.poi.excel.table.ExcelTable

ExcelTable.ContextContainer

Field Summary

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

ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite, 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
ExcelTableWriter.IterableWriter<T>	getIterable(org.apache.poi.ss.usermodel.Workbook workbook)	Provides an Iterable writer.
protected abstract void	headerCheck(org.apache.poi.ss.usermodel.Workbook workbook)	Obtains header list from the file at templateFilePath.
ExcelTableWriter<T>	ignoresAdditionalColumnsOfHeaderData(boolean value)	Stores the boolean value which indicates whether validateHeaderData ignores additional header columns.
ExcelTableWriter<T>	isVerticalAndHorizontalOpposite(boolean value)	Decides whether header is top (normal table) or left.
void	write(String templateFilePath, String destFilePath, List<List<T>> data)	Writes table data to the specified excel file.
org.apache.poi.ss.usermodel.Workbook	write(String templateFilePath, List<List<T>> data)	Writes table data to the designated excel file.
void	write(org.apache.poi.ss.usermodel.Workbook workbook, 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, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite

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, getNumberOfHeaderLines, getSheetName, getStringValue, ignoresAdditionalColumnsOfHeaderData, isVerticalAndHorizontalOpposite

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(@RequireNonnull
 String templateFilePath,
 @RequireNonnull
 String destFilePath,
 @RequireNonnull
 List<List<T>> data)
           throws Exception

Writes table data to the specified excel file.

data is written to destFilePath, and then workbook is closed.

Parameters:

destFilePath - destFilePath

data - dataList

Throws:

Exception

write

public org.apache.poi.ss.usermodel.Workbook write(@RequireNonnull
 String templateFilePath,
 @RequireNonnull
 List<List<T>> data)
                                           throws Exception

Writes table data to the designated excel file.

data is stored to workbook created from templateFilePath, and the method returns workbook.

Parameters:

templateFilePath - templateFilePath

data - data

Throws:

Exception

write

public void write(@RequireNonnull
 org.apache.poi.ss.usermodel.Workbook workbook,
 @RequireNonnull
 List<List<T>> data)
           throws Exception

Writes table data to the designated excel file.

data is stored to workbook.

Parameters:

workbook - workbook

data - dataList

Throws:

Exception

getIterable

@Nonnull
public ExcelTableWriter.IterableWriter<T> getIterable(@RequireNonnull
 org.apache.poi.ss.usermodel.Workbook workbook)
                                               throws org.apache.poi.EncryptedDocumentException,
jp.ecuacion.lib.core.exception.checked.AppException,
IOException

Provides an Iterable writer.

Parameters:

workbook - workbook

Throws:

org.apache.poi.EncryptedDocumentException

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

IOException

headerCheck

protected abstract void headerCheck(@RequireNonnull
 org.apache.poi.ss.usermodel.Workbook workbook)
                             throws org.apache.poi.EncryptedDocumentException,
jp.ecuacion.lib.core.exception.checked.AppException,
IOException

Obtains header list from the file at templateFilePath.

Parameters:

workbook - workbook.

Throws:

IOException - IOException

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

org.apache.poi.EncryptedDocumentException - EncryptedDocumentException

ignoresAdditionalColumnsOfHeaderData

public ExcelTableWriter<T> ignoresAdditionalColumnsOfHeaderData(boolean value)

Description copied from interface: IfExcelTable

Stores the boolean value which indicates whether validateHeaderData ignores additional header columns.

Specified by:

ignoresAdditionalColumnsOfHeaderData in interface IfExcelTable<T>

Parameters:

value - boolean

isVerticalAndHorizontalOpposite

public ExcelTableWriter<T> isVerticalAndHorizontalOpposite(boolean value)

Description copied from interface: IfExcelTable

Decides whether header is top (normal table) or left. true means headers are at the left.

Specified by:

isVerticalAndHorizontalOpposite in interface IfExcelTable<T>

Parameters:

value - boolean

Returns:

IfExcelTable<T>