Package ch.tocco.nice2.reporting.api.excel

Interface ExcelBuilder

All Known Implementing Classes:

AbstractExcelBuilder

public interface ExcelBuilder

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)	Deprecated. use addSheet(ExcelSheetData).
String	build()	creates a excel file using the given data from withHeader(List), withData(List) and withFooter(List)
String	build(EntityModel model)	creates a excel file using the given data from withHeader(List), withData(List) and withFooter(List)
com.google.common.io.FileBackedOutputStream	buildOutputStream()	creates an excel and writes it to an output stream using the given data from withHeader(List), withData(List) and withFooter(List)
ExcelBuilder	withData(List<List<Object>> data)	Deprecated. use addSheet(ExcelSheetData).
ExcelBuilder	withFooter(List<Object> footer)	Deprecated. use addSheet(ExcelSheetData).
ExcelBuilder	withHeader(List<Object> header)	Deprecated. use addSheet(ExcelSheetData).
ExcelBuilder	withTitle(List<Object> title)	Deprecated. use addSheet(ExcelSheetData).

Method Details

addSheet

ExcelBuilder addSheet(ExcelSheetData data)

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

Returns:

the builder itself

withTitle

@Deprecated
ExcelBuilder withTitle(List<Object> title)

Deprecated.

use addSheet(ExcelSheetData). It allows a way more flexible sheet creation.

Parameters:

title - the title of the excel sheet

Returns:

the builder itself

withHeader

@Deprecated
ExcelBuilder withHeader(List<Object> header)

Deprecated.

use addSheet(ExcelSheetData). It allows a way more flexible sheet creation.

Parameters:

header - the meta data of the excel sheet

Returns:

the builder itself

withData

@Deprecated
ExcelBuilder withData(List<List<Object>> data)

Deprecated.

use addSheet(ExcelSheetData). It allows a way more flexible sheet creation.

Parameters:

data - the effective data of the sheet

Returns:

the builder itself

withFooter

@Deprecated
ExcelBuilder withFooter(List<Object> footer)

Deprecated.

use addSheet(ExcelSheetData). It allows a way more flexible sheet creation.

Parameters:

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

Returns:

the builder itself

addStyle

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

Deprecated.

use addSheet(ExcelSheetData). It allows a way more flexible sheet creation.

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

String build()
      throws IOException

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

Returns:

the output job id of the created excel file

Throws:

IOException

build

String build(EntityModel model)
      throws IOException

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

Parameters:

model - the EntityModel which will be passed to the OutputJobBuilder

Returns:

the output job id of the created excel file

Throws:

IOException

buildOutputStream

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

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

Returns:

outputStream output stream that contains the generated excel

Throws:

IOException