com.hybris.backoffice.excel.template

Interface ExcelTemplateService

All Known Implementing Classes:

DefaultExcelTemplateService

public interface ExcelTemplateService

Service responsible for operation on excel file.

Method Summary

Modifier and Type	Method and Description
void	addTypeSheet(java.lang.String typeName, Workbook workbook) Adds a new sheet to given workbook.
Row	createEmptyRow(Sheet sheet) Creates an empty row in given sheet.
Sheet	createTypeSheet(java.lang.String typeCode, Workbook workbook) Creates a new type sheet in given workbook.
Workbook	createWorkbook(java.io.InputStream is) Creates workbook object based on inputStream of excel file.
int	findColumnIndex(Sheet typeSystemSheet, Sheet sheet, SelectedAttribute selectedAttribute) Finds column index based on selected attribute.
java.lang.String	findSheetNameForTypeCode(java.lang.String typeCode, Workbook workbook) Finds sheet name for given type code.
java.lang.String	findTypeCodeForSheetName(java.lang.String sheetName, Workbook workbook) Finds type code for given sheet name.
java.lang.String	getAttributeDisplayName(AttributeDescriptorModel attributeDescriptorModel, java.lang.String isoCode) Returns displayed header name based on attribute descriptor
java.lang.String	getCellValue(Cell cell) Returns cell value as a string value.
java.util.List<SelectedAttribute>	getHeaders(Sheet typeSystemSheet, Sheet typeSheet) Returns list of selected attributes for given sheet, based on metainformation from type system sheet.
java.util.List<SelectedAttributeQualifier>	getSelectedAttributesQualifiers(Sheet typeSystemSheet, Sheet typeSheet) Returns qualifiers of attributes which at selected in the typSheet
java.util.List<Sheet>	getSheets(Workbook workbook) Returns all sheets except sheets contains metadata (TypeSystem and TypeTemplate).
java.util.List<java.lang.String>	getSheetsNames(Workbook workbook) Returns all sheets names except sheets contains metadata (TypeSystem and TypeTemplate).
Sheet	getTypeSystemSheet(Workbook workbook) Returns sheet which contains metadata about type system
void	insertAttributeHeader(Sheet sheet, SelectedAttribute selectedAttribute, int columnIndex) Inserts value to the sheet's header (first row)
void	insertAttributesHeader(Sheet sheet, java.util.Collection<SelectedAttribute> selectedAttributes) A shortcut for It is possible to inserts all values to the header at once instead of invoking for every attribute separately
void	insertAttributeValue(Cell cell, java.lang.Object object) Inserts given value to a given cell

Method Detail

createWorkbook

Workbook createWorkbook(java.io.InputStream is)

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

Parameters:

is - Input stream of excel file

Returns:

Workbook object which represents excel file

getTypeSystemSheet

Sheet getTypeSystemSheet(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

getSheetsNames

java.util.List<java.lang.String> getSheetsNames(Workbook workbook)

Returns all sheets names except sheets contains metadata (TypeSystem and TypeTemplate).

Parameters:

workbook - Workbook object which represents excel file

Returns:

list of sheets names

getSheets

java.util.List<Sheet> getSheets(Workbook workbook)

Returns all sheets except sheets contains metadata (TypeSystem and TypeTemplate).

Parameters:

workbook - Workbook object which represents excel file

Returns:

list of sheets

getCellValue

java.lang.String getCellValue(Cell cell)

Returns cell value as a string value. In case when cell contains formula then the formula is evaluated and result of the evaluation is returned.

Parameters:

cell - Cell

Returns:

string value of cell

getHeaders

java.util.List<SelectedAttribute> getHeaders(Sheet typeSystemSheet,
                                             Sheet typeSheet)

Returns list of selected attributes for given sheet, based on metainformation from type system sheet.

Parameters:

typeSystemSheet - Sheet contains metainformation about attributes for each type sheets

typeSheet - Sheet contains data for given sheet

Returns:

list of selected attributes

getSelectedAttributesQualifiers

java.util.List<SelectedAttributeQualifier> getSelectedAttributesQualifiers(Sheet typeSystemSheet,
                                                                           Sheet typeSheet)

Returns qualifiers of attributes which at selected in the typSheet

Parameters:

typeSystemSheet - Sheet contains metainformation about attributes for each type sheets

typeSheet - Sheet contains data for given sheet

Returns:

list of selected attributes.

findColumnIndex

int findColumnIndex(Sheet typeSystemSheet,
                    Sheet sheet,
                    SelectedAttribute selectedAttribute)

Finds column index based on selected attribute. If column doesn't exist then -1 will be returned.

Parameters:

typeSystemSheet - - sheet which contains information about type system

sheet - sheet for current type

selectedAttribute - attribute for which column index should be found.

Returns:

column index for given selected attribute. If column doesn't exist then -1 will be returned.

createTypeSheet

Sheet createTypeSheet(java.lang.String typeCode,
                      Workbook workbook)

Creates a new type sheet in given workbook. If a sheet with given typeCode already exists, it is returned without creating an extra one.

Parameters:

typeCode - a new sheet name. Moreover, an additional sheet called "TypeSystem" is populated by data of this typeCode.

workbook - workbook which will be extended by a new sheet

Returns:

sheet

findTypeCodeForSheetName

java.lang.String findTypeCodeForSheetName(java.lang.String sheetName,
                                          Workbook workbook)

Finds type code for given sheet name.

Parameters:

sheetName - sheet name.

workbook - workbook.

Returns:

found type code.

findSheetNameForTypeCode

java.lang.String findSheetNameForTypeCode(java.lang.String typeCode,
                                          Workbook workbook)

Finds sheet name for given type code.

Parameters:

typeCode - type code

workbook - workbook

Returns:

found type code.

addTypeSheet

void addTypeSheet(java.lang.String typeName,
                  Workbook workbook)

Adds a new sheet to given workbook.

Parameters:

typeName - a new sheet name.

workbook - workbook which will be extended by a new sheet

insertAttributeHeader

void insertAttributeHeader(Sheet sheet,
                           SelectedAttribute selectedAttribute,
                           int columnIndex)

Inserts value to the sheet's header (first row)

Parameters:

sheet - where the value will be inserted

selectedAttribute - a pojo which allows to retrieve value to insert

columnIndex - index of a column for inserted value

insertAttributesHeader

void insertAttributesHeader(Sheet sheet,
                            java.util.Collection<SelectedAttribute> selectedAttributes)

A shortcut for It is possible to inserts all values to the header at once instead of invoking for every attribute separately

Parameters:

sheet - where the value will be inserted

selectedAttributes - a pojo which allows to retrieve value to insert

insertAttributeValue

void insertAttributeValue(Cell cell,
                          java.lang.Object object)

Inserts given value to a given cell

Parameters:

cell - where the value will be inserted

object - a value to insert

createEmptyRow

Row createEmptyRow(Sheet sheet)

Creates an empty row in given sheet.

Parameters:

sheet - where the row will be created

Returns:

row

getAttributeDisplayName

java.lang.String getAttributeDisplayName(AttributeDescriptorModel attributeDescriptorModel,
                                         java.lang.String isoCode)

Returns displayed header name based on attribute descriptor

Parameters:

attributeDescriptorModel - attribute descriptor of selected attribute

isoCode - - isoCode of language

Returns:

displayed header name based on attribute descriptor