com.hybris.backoffice.excel.template

Class DefaultExcelTemplateService

java.lang.Object

com.hybris.backoffice.excel.template.DefaultExcelTemplateService

All Implemented Interfaces:

ExcelTemplateService

Deprecated.

since 1808.

@Deprecated
public class DefaultExcelTemplateService
extends java.lang.Object
implements ExcelTemplateService

Constructor Summary

Constructors

Constructor and Description
DefaultExcelTemplateService() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	activateFirstNonUtilitySheet(Workbook workbook) Deprecated. since 1808. Process of hiding sheets was moved to HideUtilitySheetsDecorator
protected void	addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor, Sheet sheet) Deprecated. since 1808, please use TypeSystemSheetPopulator.populate(ExcelExportResult) instead. The typeSystem sheet is now being populated in ExcelExportWorkbookPostProcessor via ExcelExportWorkbookDecorator
protected void	addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor, Sheet sheet, java.lang.String langIsoCode) Deprecated. since 1808, please use TypeSystemSheetPopulator.populate(ExcelExportResult) instead. The typeSystem sheet is now being populated in ExcelExportWorkbookPostProcessor via ExcelExportWorkbookDecorator
void	addTypeSheet(java.lang.String typeName, Workbook workbook) Deprecated. Adds a new sheet to given workbook.
Row	createEmptyRow(Sheet sheet) Deprecated. Creates an empty row in given sheet.
Sheet	createTypeSheet(java.lang.String typeCode, Workbook workbook) Deprecated. Creates a new type sheet in given workbook.
Workbook	createWorkbook(java.io.InputStream is) Deprecated. Creates workbook object based on inputStream of excel file.
int	findColumnIndex(Sheet typeSystemSheet, Sheet sheet, SelectedAttribute selectedAttribute) Deprecated. Finds column index based on selected attribute.
java.lang.String	findSheetNameForTypeCode(java.lang.String typeCode, Workbook workbook) Deprecated. Finds sheet name for given type code.
java.lang.String	findTypeCodeForSheetName(java.lang.String sheetName, Workbook workbook) Deprecated. Finds type code for given sheet name.
protected java.lang.String	getAttributeDescriptorName(AttributeDescriptorModel attributeDescriptor) Deprecated. since 1808. Logic was moved to DisplayNameAttributeNameFormatter
java.lang.String	getAttributeDisplayName(AttributeDescriptorModel attributeDescriptorModel, java.lang.String isoCode) Deprecated. Returns displayed header name based on attribute descriptor
java.lang.String	getCellValue(Cell cell) Deprecated. Returns cell value as a string value.
CommonI18NService	getCommonI18NService() Deprecated. since 1808.
ExcelDateUtils	getExcelDateUtils() Deprecated. since 1808.
ExcelSheetNamingStrategy	getExcelSheetNamingStrategy() Deprecated. since 1808.
ExcelTranslatorRegistry	getExcelTranslatorRegistry() Deprecated. since 1808.
java.util.List<SelectedAttribute>	getHeaders(Sheet typeSystemSheet, Sheet typeSheet) Deprecated. Returns list of selected attributes for given sheet, based on metainformation from type system sheet.
PermissionCRUDService	getPermissionCRUDService() Deprecated. since 1808.
java.util.List<SelectedAttributeQualifier>	getSelectedAttributesQualifiers(Sheet typeSystemSheet, Sheet typeSheet) Deprecated. Returns qualifiers of attributes which at selected in the typSheet
java.util.List<Sheet>	getSheets(Workbook workbook) Deprecated. Returns all sheets except utility sheets.
java.util.List<java.lang.String>	getSheetsNames(Workbook workbook) Deprecated. Returns all sheets names except utility sheets.
TypeService	getTypeService() Deprecated.
Sheet	getTypeSystemSheet(Workbook workbook) Deprecated. Returns sheet which contains metadata about type system
protected int	getUtilitySheetHiddenLevel() Deprecated. since 1808. Process of hiding sheets was moved to HideUtilitySheetsDecorator
protected void	hideUtilitySheet(Workbook workbook, java.lang.String sheetName) Deprecated. since 1808. Process of hiding sheets was moved to HideUtilitySheetsDecorator
void	insertAttributeHeader(Sheet sheet, SelectedAttribute selectedAttribute, int columnIndex) Deprecated. Inserts value to the sheet's header (first row)
void	insertAttributesHeader(Sheet sheet, java.util.Collection<SelectedAttribute> selectedAttributes) Deprecated. A shortcut for ExcelTemplateService.insertAttributeHeader(Sheet, SelectedAttribute, int) It is possible to inserts all values to the header at once instead of invoking ExcelTemplateService.insertAttributeHeader(Sheet, SelectedAttribute, int) for every attribute separately
void	insertAttributeValue(Cell cell, java.lang.Object object) Deprecated. Inserts given value to a given cell
protected boolean	isMandatory(AttributeDescriptorModel attributeDescriptor, java.lang.String langIsoCode) Deprecated. since 1808. Logic was moved to DisplayNameAttributeNameFormatter
protected void	populateTypeSystemSheet(ComposedTypeModel composedType, Workbook workbook) Deprecated. since 1808, please use TypeSystemSheetPopulator.populate(ExcelExportResult) instead. The typeSystem sheet is now being populated in ExcelExportWorkbookPostProcessor via ExcelExportWorkbookDecorator
void	setAttributeNameFormatter(AttributeNameFormatter<ExcelAttributeDescriptorAttribute> attributeNameFormatter) Deprecated.
void	setCellService(ExcelCellService cellService) Deprecated.
void	setCommonI18NService(CommonI18NService commonI18NService) Deprecated. since 1808.
void	setExcelDateUtils(ExcelDateUtils excelDateUtils) Deprecated. since 1808.
void	setExcelSheetNamingStrategy(ExcelSheetNamingStrategy excelSheetNamingStrategy) Deprecated. since 1808.
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry) Deprecated. since 1808.
void	setHeaderService(ExcelHeaderService headerService) Deprecated.
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService) Deprecated. since 1808.
void	setSheetService(ExcelSheetService sheetService) Deprecated.
void	setTypeService(TypeService typeService) Deprecated.
void	setWorkbookService(ExcelWorkbookService workbookService) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExcelTemplateService

public DefaultExcelTemplateService()

Deprecated.

Method Detail

createWorkbook

public Workbook createWorkbook(java.io.InputStream is)

Deprecated.

Description copied from interface: ExcelTemplateService

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)

Deprecated.

Description copied from interface: ExcelTemplateService

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)

Deprecated.

Description copied from interface: ExcelTemplateService

Returns all sheets names except utility sheets.

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)

Deprecated.

Description copied from interface: ExcelTemplateService

Returns all sheets except utility sheets.

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)

Deprecated.

Description copied from interface: ExcelTemplateService

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.

Specified by:

getCellValue in interface ExcelTemplateService

Parameters:

cell - Cell

Returns:

string value of cell

getHeaders

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

Deprecated.

Description copied from interface: ExcelTemplateService

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)

Deprecated.

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.

findColumnIndex

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

Deprecated.

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.

createTypeSheet

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

Deprecated.

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

workbook - workbook which will be extended by a new sheet

Returns:

sheet

findTypeCodeForSheetName

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

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

Description copied from interface: ExcelTemplateService

A shortcut for ExcelTemplateService.insertAttributeHeader(Sheet, SelectedAttribute, int) It is possible to inserts all values to the header at once instead of invoking ExcelTemplateService.insertAttributeHeader(Sheet, SelectedAttribute, int) 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 object)

Deprecated.

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

object - a value to insert

createEmptyRow

public Row createEmptyRow(Sheet sheet)

Deprecated.

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

getAttributeDisplayName

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

Deprecated.

Description copied from interface: ExcelTemplateService

Returns displayed header name based on attribute descriptor

Specified by:

getAttributeDisplayName in interface ExcelTemplateService

Parameters:

attributeDescriptorModel - attribute descriptor of selected attribute

isoCode - - isoCode of language

Returns:

displayed header name based on attribute descriptor

hideUtilitySheet

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

Deprecated. since 1808. Process of hiding sheets was moved to HideUtilitySheetsDecorator

getUtilitySheetHiddenLevel

@Deprecated
protected int getUtilitySheetHiddenLevel()

Deprecated. since 1808. Process of hiding sheets was moved to HideUtilitySheetsDecorator

activateFirstNonUtilitySheet

@Deprecated
protected void activateFirstNonUtilitySheet(Workbook workbook)

Deprecated. since 1808. Process of hiding sheets was moved to HideUtilitySheetsDecorator

populateTypeSystemSheet

@Deprecated
protected void populateTypeSystemSheet(ComposedTypeModel composedType,
                                                   Workbook workbook)

Deprecated. since 1808, please use TypeSystemSheetPopulator.populate(ExcelExportResult) instead. The typeSystem sheet is now being populated in ExcelExportWorkbookPostProcessor via ExcelExportWorkbookDecorator

addAttributeToExcelTypeSystemSheet

@Deprecated
protected void addAttributeToExcelTypeSystemSheet(AttributeDescriptorModel attributeDescriptor,
                                                              Sheet sheet)

Deprecated. since 1808, please use TypeSystemSheetPopulator.populate(ExcelExportResult) instead. The typeSystem sheet is now being populated in ExcelExportWorkbookPostProcessor via ExcelExportWorkbookDecorator

addAttributeToExcelTypeSystemSheet

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

Deprecated. since 1808, please use TypeSystemSheetPopulator.populate(ExcelExportResult) instead. The typeSystem sheet is now being populated in ExcelExportWorkbookPostProcessor via ExcelExportWorkbookDecorator

isMandatory

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

Deprecated. since 1808. Logic was moved to DisplayNameAttributeNameFormatter

getAttributeDescriptorName

@Deprecated
protected java.lang.String getAttributeDescriptorName(AttributeDescriptorModel attributeDescriptor)

Deprecated. since 1808. Logic was moved to DisplayNameAttributeNameFormatter

setCellService

public void setCellService(ExcelCellService cellService)

Deprecated.

setHeaderService

public void setHeaderService(ExcelHeaderService headerService)

Deprecated.

setSheetService

public void setSheetService(ExcelSheetService sheetService)

Deprecated.

setWorkbookService

public void setWorkbookService(ExcelWorkbookService workbookService)

Deprecated.

setAttributeNameFormatter

public void setAttributeNameFormatter(AttributeNameFormatter<ExcelAttributeDescriptorAttribute> attributeNameFormatter)

Deprecated.

getTypeService

public TypeService getTypeService()

Deprecated.

setTypeService

public void setTypeService(TypeService typeService)

Deprecated.

getCommonI18NService

@Deprecated
public CommonI18NService getCommonI18NService()

Deprecated. since 1808.

setCommonI18NService

@Deprecated
public void setCommonI18NService(CommonI18NService commonI18NService)

Deprecated. since 1808.

getExcelTranslatorRegistry

@Deprecated
public ExcelTranslatorRegistry getExcelTranslatorRegistry()

Deprecated. since 1808.

setExcelTranslatorRegistry

@Deprecated
public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

Deprecated. since 1808.

getPermissionCRUDService

@Deprecated
public PermissionCRUDService getPermissionCRUDService()

Deprecated. since 1808.

setPermissionCRUDService

@Deprecated
public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)

Deprecated. since 1808.

getExcelDateUtils

@Deprecated
public ExcelDateUtils getExcelDateUtils()

Deprecated. since 1808.

setExcelDateUtils

@Deprecated
public void setExcelDateUtils(ExcelDateUtils excelDateUtils)

Deprecated. since 1808.

getExcelSheetNamingStrategy

@Deprecated
public ExcelSheetNamingStrategy getExcelSheetNamingStrategy()

Deprecated. since 1808.

setExcelSheetNamingStrategy

@Deprecated
public void setExcelSheetNamingStrategy(ExcelSheetNamingStrategy excelSheetNamingStrategy)

Deprecated. since 1808.