Package com.hybris.backoffice.excel.template.header

Class DefaultExcelHeaderService

java.lang.Object

com.hybris.backoffice.excel.template.header.DefaultExcelHeaderService

All Implemented Interfaces:

ExcelHeaderService

public class DefaultExcelHeaderService
extends java.lang.Object
implements ExcelHeaderService

Default implementation of ExcelHeaderService

Constructor Summary

Constructors

Constructor	Description
DefaultExcelHeaderService()

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<org.apache.poi.ss.usermodel.Row>	findTypeSystemRowForGivenHeader(org.apache.poi.ss.usermodel.Sheet metaInformationSheet, java.lang.String typeCode, java.lang.String header)
java.util.Collection<java.lang.String>	getHeaderDisplayNames(org.apache.poi.ss.usermodel.Sheet sheet)	Returns list of attribute display names, that is: the contents of the display name row: ExcelTemplateConstants.Header.DISPLAY_NAME
java.util.Collection<SelectedAttribute>	getHeaders(org.apache.poi.ss.usermodel.Sheet metaInformationSheet, org.apache.poi.ss.usermodel.Sheet typeSheet)	Returns list of selected attributes for given sheet, based on metainformation from type system sheet.
java.util.Collection<SelectedAttributeQualifier>	getSelectedAttributesQualifiers(org.apache.poi.ss.usermodel.Sheet metaInformationSheet, org.apache.poi.ss.usermodel.Sheet typeSheet)	Returns qualifiers of attributes which at selected in the typSheet
void	insertAttributeHeader(org.apache.poi.ss.usermodel.Sheet sheet, ExcelAttribute excelAttribute, int columnIndex)	Inserts value to the sheet's header
void	insertAttributesHeader(org.apache.poi.ss.usermodel.Sheet sheet, java.util.Collection<? extends ExcelAttribute> excelAttributes)	A shortcut for ExcelHeaderService.insertAttributeHeader(Sheet, ExcelAttribute, int) It is possible to inserts all values to the header at once instead of invoking ExcelHeaderService.insertAttributeHeader(Sheet, ExcelAttribute, int) for every attribute separately
protected AttributeDescriptorModel	loadAttributeDescriptor(org.apache.poi.ss.usermodel.Row row, java.lang.String typeCode)
protected java.lang.String	loadIsoCode(org.apache.poi.ss.usermodel.Row row, java.lang.String header)
void	setAttributeNameFormatter(AttributeNameFormatter<ExcelAttributeDescriptorAttribute> attributeNameFormatter)
void	setCollectionFormatter(CollectionFormatter collectionFormatter)
void	setDefaultValueIndex(ExcelTemplateConstants.Header defaultValueIndex)
void	setExcelCellService(ExcelCellService excelCellService)
void	setExcelSheetService(ExcelSheetService excelSheetService)
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setHeaderRowIndex(ExcelTemplateConstants.Header headerRowIndex)
void	setReferencePatternRowIndex(ExcelTemplateConstants.Header referencePatternRowIndex)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.backoffice.excel.template.header.ExcelHeaderService

getHeaderValueWithoutSpecialMarks

Constructor Detail

DefaultExcelHeaderService

public DefaultExcelHeaderService()

Method Detail

getHeaders

public java.util.Collection<SelectedAttribute> getHeaders(org.apache.poi.ss.usermodel.Sheet metaInformationSheet,
                                                          org.apache.poi.ss.usermodel.Sheet typeSheet)

Description copied from interface: ExcelHeaderService

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

Specified by:

getHeaders in interface ExcelHeaderService

Parameters:

metaInformationSheet - Sheet contains metaInformation about attributes for each type sheets

typeSheet - Sheet contains data for given sheet

Returns:

collection of selected attributes

getHeaderDisplayNames

public java.util.Collection<java.lang.String> getHeaderDisplayNames(org.apache.poi.ss.usermodel.Sheet sheet)

Description copied from interface: ExcelHeaderService

Returns list of attribute display names, that is: the contents of the display name row: ExcelTemplateConstants.Header.DISPLAY_NAME

Specified by:

getHeaderDisplayNames in interface ExcelHeaderService

Parameters:

sheet - The Sheet from which the display names should be taken

Returns:

List of display names for each attribute in the sheet

getSelectedAttributesQualifiers

public java.util.Collection<SelectedAttributeQualifier> getSelectedAttributesQualifiers(org.apache.poi.ss.usermodel.Sheet metaInformationSheet,
                                                                                        org.apache.poi.ss.usermodel.Sheet typeSheet)

Description copied from interface: ExcelHeaderService

Returns qualifiers of attributes which at selected in the typSheet

Specified by:

getSelectedAttributesQualifiers in interface ExcelHeaderService

Parameters:

metaInformationSheet - Sheet contains metaInformation about attributes for each type sheets

typeSheet - Sheet contains data for given sheet

Returns:

collection of selected attributes.

insertAttributeHeader

public void insertAttributeHeader(org.apache.poi.ss.usermodel.Sheet sheet,
                                  ExcelAttribute excelAttribute,
                                  int columnIndex)

Description copied from interface: ExcelHeaderService

Inserts value to the sheet's header

Specified by:

insertAttributeHeader in interface ExcelHeaderService

Parameters:

sheet - where the value will be inserted

excelAttribute - a pojo which allows to retrieve value to insert

columnIndex - index of a column for inserted value

insertAttributesHeader

public void insertAttributesHeader(org.apache.poi.ss.usermodel.Sheet sheet,
                                   java.util.Collection<? extends ExcelAttribute> excelAttributes)

Description copied from interface: ExcelHeaderService

A shortcut for ExcelHeaderService.insertAttributeHeader(Sheet, ExcelAttribute, int) It is possible to inserts all values to the header at once instead of invoking ExcelHeaderService.insertAttributeHeader(Sheet, ExcelAttribute, int) for every attribute separately

Specified by:

insertAttributesHeader in interface ExcelHeaderService

Parameters:

sheet - where the value will be inserted

excelAttributes - a collection of pojos which allows to retrieve value to insert

findTypeSystemRowForGivenHeader

protected java.util.Optional<org.apache.poi.ss.usermodel.Row> findTypeSystemRowForGivenHeader(org.apache.poi.ss.usermodel.Sheet metaInformationSheet,
                                                                                              java.lang.String typeCode,
                                                                                              java.lang.String header)

loadIsoCode

protected java.lang.String loadIsoCode(org.apache.poi.ss.usermodel.Row row,
                                       java.lang.String header)

loadAttributeDescriptor

protected AttributeDescriptorModel loadAttributeDescriptor(org.apache.poi.ss.usermodel.Row row,
                                                           java.lang.String typeCode)

setAttributeNameFormatter

public void setAttributeNameFormatter(AttributeNameFormatter<ExcelAttributeDescriptorAttribute> attributeNameFormatter)

setTypeService

public void setTypeService(TypeService typeService)

setCollectionFormatter

public void setCollectionFormatter(CollectionFormatter collectionFormatter)

setExcelSheetService

public void setExcelSheetService(ExcelSheetService excelSheetService)

setExcelCellService

public void setExcelCellService(ExcelCellService excelCellService)

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

setHeaderRowIndex

public void setHeaderRowIndex(ExcelTemplateConstants.Header headerRowIndex)

setReferencePatternRowIndex

public void setReferencePatternRowIndex(ExcelTemplateConstants.Header referencePatternRowIndex)

setDefaultValueIndex

public void setDefaultValueIndex(ExcelTemplateConstants.Header defaultValueIndex)