com.hybris.backoffice.excel.template.workbook

Interface ExcelWorkbookService

All Known Implementing Classes:

DefaultExcelWorkbookService

public interface ExcelWorkbookService

Service responsible for operation on excel's workbook object.

Method Summary

Modifier and Type	Method and Description
void	addProperty(Workbook workbook, java.lang.String key, java.lang.String value) Adds property to given workbook
Workbook	createWorkbook(java.io.InputStream inputStream) Creates workbook object based on inputStream of excel file.
Sheet	getMetaInformationSheet(Workbook workbook) Returns sheet which contains metadata about type system
java.util.Optional<java.lang.String>	getProperty(Workbook worbook, java.lang.String key) Retrieves property from given workbook
java.util.Collection<CTProperty>	getUnderlyingProperties(Workbook workbook) Retrieves underlying properties

Method Detail

createWorkbook

Workbook createWorkbook(java.io.InputStream inputStream)

Creates workbook object based on inputStream of excel file. If inputStream doesn't contains excel file then new empty Workbook will be returned.

Parameters:

inputStream - Input stream of excel file

Returns:

Workbook object which represents excel file

getMetaInformationSheet

Sheet getMetaInformationSheet(Workbook workbook)

Returns sheet which contains metadata about type system

Parameters:

workbook - Workbook object which represents excel file

Returns:

Sheet which contains information about type system

addProperty

void addProperty(Workbook workbook,
                 java.lang.String key,
                 java.lang.String value)

Adds property to given workbook

Parameters:

workbook - workbook which should be decorated by property

key - key of property

value - value of property

getProperty

java.util.Optional<java.lang.String> getProperty(Workbook worbook,
                                                 java.lang.String key)

Retrieves property from given workbook

Parameters:

worbook - the source of the properties

key - key of the property

Returns:

value of searching property

getUnderlyingProperties

java.util.Collection<CTProperty> getUnderlyingProperties(Workbook workbook)

Retrieves underlying properties

Parameters:

workbook - the source of the properties

Returns:

collection of underlying properties