com.hybris.backoffice.excel.template

Class DefaultExcelTemplateService

java.lang.Object

com.hybris.backoffice.excel.template.DefaultExcelTemplateService

All Implemented Interfaces:

ExcelTemplateService

public class DefaultExcelTemplateService
extends java.lang.Object
implements ExcelTemplateService

Service responsible for operation on excel file.

Constructor Summary

Constructors

Constructor and Description
DefaultExcelTemplateService()

Method Summary

Modifier and Type	Method and Description
protected void	activateFirstNonUtilitySheet(Workbook workbook)
protected void	addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor, Sheet sheet)
protected void	addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor, Sheet sheet, java.lang.String langIsoCode)
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.
protected java.lang.String	createSheetName(java.lang.String typeCode, Workbook workbook)
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.
protected java.lang.String	findAttributeDisplayNameInTypeSystemSheet(Sheet typeSystemSheet, SelectedAttribute selectedAttribute)
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.
protected java.util.Optional<Row>	findTypeSystemRowForGivenHeader(Sheet typeSystemSheet, java.lang.String typeCode, java.lang.String header)
protected java.lang.String	getAttributeDescriptorName(AttributeDescriptorModel attributeDescriptor)
java.lang.String	getAttributeDisplayName(AttributeDescriptorModel attributeDescriptor, java.lang.String langIsoCode) Returns displayed header name based on attribute descriptor
java.lang.String	getCellValue(Cell cell) Returns cell value as a string value.
CommonI18NService	getCommonI18NService()
ExcelDateUtils	getExcelDateUtils()
ExcelSheetNamingStrategy	getExcelSheetNamingStrategy()
ExcelTranslatorRegistry	getExcelTranslatorRegistry()
java.util.List<SelectedAttribute>	getHeaders(Sheet typeSystemSheet, Sheet typeSheet) Returns list of selected attributes for given sheet, based on metainformation from type system sheet.
protected java.lang.String	getHeaderValueWithoutMetadata(java.lang.String headerValue)
protected java.lang.String	getNumericCellValue(Cell cell)
PermissionCRUDService	getPermissionCRUDService()
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).
protected java.util.TimeZone	getTimeZone()
TypeService	getTypeService()
Sheet	getTypeSystemSheet(Workbook workbook) Returns sheet which contains metadata about type system
protected int	getUtilitySheetHiddenLevel()
protected void	hideUtilitySheet(Workbook workbook, java.lang.String sheetName)
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 value) Inserts given value to a given cell
protected boolean	isMandatory(AttributeDescriptorModel attributeDescriptor, java.lang.String langIsoCode)
protected AttributeDescriptorModel	loadAttributeDescriptor(Row row)
protected java.lang.String	loadIsoCode(Row row)
protected void	persistSheetNameInProperties(java.lang.String typeCode, java.lang.String sheetName, Workbook workbook)
protected void	populateTypeSystemSheet(ComposedTypeModel composedType, Workbook workbook)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setExcelDateUtils(ExcelDateUtils excelDateUtils)
void	setExcelSheetNamingStrategy(ExcelSheetNamingStrategy excelSheetNamingStrategy)
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExcelTemplateService

public DefaultExcelTemplateService()

Method Detail

createWorkbook

public 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.

Specified by:

createWorkbook in interface ExcelTemplateService

Parameters:

is - Input stream of excel file

Returns:

Workbook object which represents excel file

getTypeSystemSheet

public Sheet getTypeSystemSheet(Workbook workbook)

Returns sheet which contains metadata about type system

Specified by:

getTypeSystemSheet in interface ExcelTemplateService

Parameters:

workbook - Workbook object which represents excel file

Returns:

Sheet which contains information about type system

getSheetsNames

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

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

Specified by:

getSheetsNames in interface ExcelTemplateService

Parameters:

workbook - Workbook object which represents excel file

Returns:

list of sheets names

getSheets

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

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

Specified by:

getSheets in interface ExcelTemplateService

Parameters:

workbook - Workbook object which represents excel file

Returns:

list of sheets

getCellValue

public 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. If cell is null then empty string will be returned.

Specified by:

getCellValue in interface ExcelTemplateService

Parameters:

cell - Cell

Returns:

string value of cell

getNumericCellValue

protected java.lang.String getNumericCellValue(Cell cell)

getTimeZone

protected java.util.TimeZone getTimeZone()

getHeaders

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

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

Specified by:

getHeaders in interface ExcelTemplateService

Parameters:

typeSystemSheet - Sheet contains metainformation about attributes for each type sheets

typeSheet - Sheet contains data for given sheet

Returns:

list of selected attributes

getSelectedAttributesQualifiers

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

Description copied from interface: ExcelTemplateService

Returns qualifiers of attributes which at selected in the typSheet

Specified by:

getSelectedAttributesQualifiers in interface ExcelTemplateService

Parameters:

typeSystemSheet - Sheet contains metainformation about attributes for each type sheets

typeSheet - Sheet contains data for given sheet

Returns:

list of selected attributes.

getHeaderValueWithoutMetadata

protected java.lang.String getHeaderValueWithoutMetadata(java.lang.String headerValue)

findTypeSystemRowForGivenHeader

protected java.util.Optional<Row> findTypeSystemRowForGivenHeader(Sheet typeSystemSheet,
                                                                  java.lang.String typeCode,
                                                                  java.lang.String header)

loadAttributeDescriptor

protected AttributeDescriptorModel loadAttributeDescriptor(Row row)

loadIsoCode

protected java.lang.String loadIsoCode(Row row)

findColumnIndex

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

Description copied from interface: ExcelTemplateService

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

Specified by:

findColumnIndex in interface ExcelTemplateService

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.

findAttributeDisplayNameInTypeSystemSheet

protected java.lang.String findAttributeDisplayNameInTypeSystemSheet(Sheet typeSystemSheet,
                                                                     SelectedAttribute selectedAttribute)

createTypeSheet

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

Description copied from interface: ExcelTemplateService

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

Specified by:

createTypeSheet in interface ExcelTemplateService

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

createSheetName

protected java.lang.String createSheetName(java.lang.String typeCode,
                                           Workbook workbook)

persistSheetNameInProperties

protected void persistSheetNameInProperties(java.lang.String typeCode,
                                            java.lang.String sheetName,
                                            Workbook workbook)

findTypeCodeForSheetName

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

Description copied from interface: ExcelTemplateService

Finds type code for given sheet name.

Specified by:

findTypeCodeForSheetName in interface ExcelTemplateService

Parameters:

sheetName - sheet name.

workbook - workbook.

Returns:

found type code.

findSheetNameForTypeCode

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

Description copied from interface: ExcelTemplateService

Finds sheet name for given type code.

Specified by:

findSheetNameForTypeCode in interface ExcelTemplateService

Parameters:

typeCode - type code

workbook - workbook

Returns:

found type code.

addTypeSheet

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

Description copied from interface: ExcelTemplateService

Adds a new sheet to given workbook.

Specified by:

addTypeSheet in interface ExcelTemplateService

Parameters:

typeName - a new sheet name.

workbook - workbook which will be extended by a new sheet

insertAttributeHeader

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

Description copied from interface: ExcelTemplateService

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

Specified by:

insertAttributeHeader in interface ExcelTemplateService

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

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

Description copied from interface: ExcelTemplateService

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

Specified by:

insertAttributesHeader in interface ExcelTemplateService

Parameters:

sheet - where the value will be inserted

selectedAttributes - a pojo which allows to retrieve value to insert

insertAttributeValue

public void insertAttributeValue(Cell cell,
                                 java.lang.Object value)

Description copied from interface: ExcelTemplateService

Inserts given value to a given cell

Specified by:

insertAttributeValue in interface ExcelTemplateService

Parameters:

cell - where the value will be inserted

value - a value to insert

createEmptyRow

public Row createEmptyRow(Sheet sheet)

Description copied from interface: ExcelTemplateService

Creates an empty row in given sheet.

Specified by:

createEmptyRow in interface ExcelTemplateService

Parameters:

sheet - where the row will be created

Returns:

row

hideUtilitySheet

protected void hideUtilitySheet(Workbook workbook,
                                java.lang.String sheetName)

getUtilitySheetHiddenLevel

protected int getUtilitySheetHiddenLevel()

activateFirstNonUtilitySheet

protected void activateFirstNonUtilitySheet(Workbook workbook)

populateTypeSystemSheet

protected void populateTypeSystemSheet(ComposedTypeModel composedType,
                                       Workbook workbook)

addAttributeToExcelTypeSystemSheet

protected void addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor,
                                                  Sheet sheet)

addAttributeToExcelTypeSystemSheet

protected void addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor,
                                                  Sheet sheet,
                                                  java.lang.String langIsoCode)

getAttributeDisplayName

public java.lang.String getAttributeDisplayName(AttributeDescriptorModel attributeDescriptor,
                                                java.lang.String langIsoCode)

Description copied from interface: ExcelTemplateService

Returns displayed header name based on attribute descriptor

Specified by:

getAttributeDisplayName in interface ExcelTemplateService

Parameters:

attributeDescriptor - attribute descriptor of selected attribute

langIsoCode - - isoCode of language

Returns:

displayed header name based on attribute descriptor

isMandatory

protected boolean isMandatory(AttributeDescriptorModel attributeDescriptor,
                              java.lang.String langIsoCode)

getAttributeDescriptorName

protected java.lang.String getAttributeDescriptorName(AttributeDescriptorModel attributeDescriptor)

setTypeService

public void setTypeService(TypeService typeService)

getTypeService

public TypeService getTypeService()

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getExcelTranslatorRegistry

public ExcelTranslatorRegistry getExcelTranslatorRegistry()

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

getPermissionCRUDService

public PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)

getExcelDateUtils

public ExcelDateUtils getExcelDateUtils()

setExcelDateUtils

public void setExcelDateUtils(ExcelDateUtils excelDateUtils)

getExcelSheetNamingStrategy

public ExcelSheetNamingStrategy getExcelSheetNamingStrategy()

setExcelSheetNamingStrategy

public void setExcelSheetNamingStrategy(ExcelSheetNamingStrategy excelSheetNamingStrategy)