Package ch.tocco.nice2.reporting.impl.excel

Class AbstractExcelBuilder

java.lang.Object

ch.tocco.nice2.reporting.impl.excel.AbstractExcelBuilder

All Implemented Interfaces:

ExcelBuilder

public abstract class AbstractExcelBuilder
extends Object
implements ExcelBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final OutputCenterService	outputCenterService

Constructor Summary

Constructors

Constructor	Description
AbstractExcelBuilder(String filename, OutputCenterService outputCenterService)

Method Summary

Modifier and Type	Method	Description
ExcelBuilder	addSheet(ExcelSheetData data)	creates a new sheet in the excel Document.
ExcelBuilder	addStyle(Function<SheetLocation,Optional<org.apache.poi.ss.usermodel.CellStyle>> function)
String	build()	creates a excel file using the given data from ExcelBuilder.withHeader(List), ExcelBuilder.withData(List) and ExcelBuilder.withFooter(List)
String	build(@Nullable EntityModel model)	creates a excel file using the given data from ExcelBuilder.withHeader(List), ExcelBuilder.withData(List) and ExcelBuilder.withFooter(List)
com.google.common.io.FileBackedOutputStream	buildOutputStream()	creates an excel and writes it to an output stream using the given data from ExcelBuilder.withHeader(List), ExcelBuilder.withData(List) and ExcelBuilder.withFooter(List)
protected abstract org.apache.poi.ss.usermodel.Workbook	createWorkbook(String filename)
protected abstract OutputCenterInputSupplier.MimeType	getOutputCenterMimeType()
ExcelBuilder	withData(List<List<Object>> data)
ExcelBuilder	withFooter(List<Object> footer)
ExcelBuilder	withHeader(List<Object> header)
ExcelBuilder	withTitle(List<Object> title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

outputCenterService

protected final OutputCenterService outputCenterService

Constructor Details

AbstractExcelBuilder

public AbstractExcelBuilder(String filename,
 OutputCenterService outputCenterService)

Method Details

createWorkbook

protected abstract org.apache.poi.ss.usermodel.Workbook createWorkbook(String filename)

getOutputCenterMimeType

protected abstract OutputCenterInputSupplier.MimeType getOutputCenterMimeType()

addSheet

public ExcelBuilder addSheet(ExcelSheetData data)

Description copied from interface: ExcelBuilder

creates a new sheet in the excel Document. The sheets are ordered in the way they are added by using this method

Specified by:

addSheet in interface ExcelBuilder

Returns:

the builder itself

withTitle

public ExcelBuilder withTitle(List<Object> title)

Specified by:

withTitle in interface ExcelBuilder

Parameters:

title - the title of the excel sheet

Returns:

the builder itself

withHeader

public ExcelBuilder withHeader(List<Object> header)

Specified by:

withHeader in interface ExcelBuilder

Parameters:

header - the meta data of the excel sheet

Returns:

the builder itself

withData

public ExcelBuilder withData(List<List<Object>> data)

Specified by:

withData in interface ExcelBuilder

Parameters:

data - the effective data of the sheet

Returns:

the builder itself

withFooter

public ExcelBuilder withFooter(List<Object> footer)

Specified by:

withFooter in interface ExcelBuilder

Parameters:

footer - the footer of the excel sheet (e.g. the total of data)

Returns:

the builder itself

addStyle

public ExcelBuilder addStyle(Function<SheetLocation,Optional<org.apache.poi.ss.usermodel.CellStyle>> function)

Specified by:

addStyle in interface ExcelBuilder

Parameters:

function - a function which is applied to any cell in the excel. If it returns a cellStyle it will be applied to the cell

Returns:

the builder itself

build

public String build()
             throws IOException

Description copied from interface: ExcelBuilder

creates a excel file using the given data from ExcelBuilder.withHeader(List), ExcelBuilder.withData(List) and ExcelBuilder.withFooter(List)

Specified by:

build in interface ExcelBuilder

Returns:

the output job id of the created excel file

Throws:

IOException

build

public String build(@Nullable
 @Nullable EntityModel model)
             throws IOException

Description copied from interface: ExcelBuilder

creates a excel file using the given data from ExcelBuilder.withHeader(List), ExcelBuilder.withData(List) and ExcelBuilder.withFooter(List)

Specified by:

build in interface ExcelBuilder

Parameters:

model - the EntityModel which will be passed to the OutputJobBuilder

Returns:

the output job id of the created excel file

Throws:

IOException

buildOutputStream

public com.google.common.io.FileBackedOutputStream buildOutputStream()
                                                              throws IOException

Description copied from interface: ExcelBuilder

creates an excel and writes it to an output stream using the given data from ExcelBuilder.withHeader(List), ExcelBuilder.withData(List) and ExcelBuilder.withFooter(List)

Specified by:

buildOutputStream in interface ExcelBuilder

Returns:

outputStream output stream that contains the generated excel

Throws:

IOException