com.hybris.backoffice.excel.exporting

Class DefaultExcelExportService

java.lang.Object

com.hybris.backoffice.excel.exporting.DefaultExcelExportService

All Implemented Interfaces:

ExcelExportService

public class DefaultExcelExportService
extends java.lang.Object
implements ExcelExportService

Service for exporting data to excel workbook

Constructor Summary

Constructors

Constructor and Description
DefaultExcelExportService()

Method Summary

Modifier and Type	Method and Description
protected void	addHeader(Sheet sheet, java.util.Set<SelectedAttribute> selectedAttributes)
protected void	addValues(java.util.Map<java.lang.String,java.util.Set<ItemModel>> itemsByType, java.lang.String type, java.util.Set<SelectedAttribute> selectedAttributes, Sheet sheet)
Workbook	exportData(java.util.List<ItemModel> selectedItems, java.util.List<SelectedAttribute> selectedAttributes) Exports data to excel workbook
protected Workbook	exportData(java.util.Map<java.lang.String,java.util.Set<ItemModel>> itemsByType, java.util.List<SelectedAttribute> selectedAttributes)
Workbook	exportData(java.lang.String typeCode, java.util.List<SelectedAttribute> selectedAttributes) Exports data to excel workbook for given type
Workbook	exportTemplate(java.lang.String typeCode) Exports a template excel workbook.
protected java.util.List<SelectedAttribute>	filterByPermissions(java.util.List<SelectedAttribute> selectedAttributes)
protected java.util.Map<java.lang.String,java.util.Set<ItemModel>>	filterByPermissions(java.util.Map<java.lang.String,java.util.Set<ItemModel>> itemsByType)
CommonI18NService	getCommonI18NService()
DefaultExcelExportDivider	getDivider() Deprecated. since 6.7 please use getExcelExportDivider()
ExcelExportDivider	getExcelExportDivider()
ExcelTemplateService	getExcelTemplateService()
ExcelTranslatorRegistry	getExcelTranslatorRegistry()
protected java.lang.Object	getItemAttribute(ItemModel item, SelectedAttribute selectedAttribute)
ModelService	getModelService()
PermissionCRUDService	getPermissionCRUDService()
java.lang.String	getTemplatePath()
TypeService	getTypeService()
protected java.io.InputStream	loadExcelTemplate()
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setDivider(DefaultExcelExportDivider divider) Deprecated. since 6.7 please use setExcelExportDivider(ExcelExportDivider)
void	setExcelExportDivider(ExcelExportDivider excelExportDivider)
void	setExcelTemplateService(ExcelTemplateService excelTemplateService)
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setModelService(ModelService modelService)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
void	setTemplatePath(java.lang.String templatePath)
void	setTypeService(TypeService typeService)
protected void	signWorkbookFile(Workbook workbook)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExcelExportService

public DefaultExcelExportService()

Method Detail

exportTemplate

public Workbook exportTemplate(java.lang.String typeCode)

Description copied from interface: ExcelExportService

Exports a template excel workbook. Its purpose is to provide an empty excel file that a user can fill with data, and then re-import. The template contains sheets for the typeCode and all of it's non-abstract sub-types, with all the metadata (like the available attributes).

Specified by:

exportTemplate in interface ExcelExportService

Parameters:

typeCode - the type for which the template workbook will be created

Returns:

the template workbook

exportData

public Workbook exportData(java.util.List<ItemModel> selectedItems,
                           java.util.List<SelectedAttribute> selectedAttributes)

Description copied from interface: ExcelExportService

Exports data to excel workbook

Specified by:

exportData in interface ExcelExportService

Parameters:

selectedItems - list of items which will be exported

selectedAttributes - list of selected attributes which have metadata necessary for reimporting the data

Returns:

sheet

exportData

public Workbook exportData(java.lang.String typeCode,
                           java.util.List<SelectedAttribute> selectedAttributes)

Description copied from interface: ExcelExportService

Exports data to excel workbook for given type

Specified by:

exportData in interface ExcelExportService

Parameters:

typeCode - type to export

selectedAttributes - list of selected attributes which have metadata necessary for reimporting the data

Returns:

sheet

exportData

protected Workbook exportData(java.util.Map<java.lang.String,java.util.Set<ItemModel>> itemsByType,
                              java.util.List<SelectedAttribute> selectedAttributes)

signWorkbookFile

protected void signWorkbookFile(Workbook workbook)

filterByPermissions

protected java.util.List<SelectedAttribute> filterByPermissions(java.util.List<SelectedAttribute> selectedAttributes)

filterByPermissions

protected java.util.Map<java.lang.String,java.util.Set<ItemModel>> filterByPermissions(java.util.Map<java.lang.String,java.util.Set<ItemModel>> itemsByType)

loadExcelTemplate

protected java.io.InputStream loadExcelTemplate()

addHeader

protected void addHeader(Sheet sheet,
                         java.util.Set<SelectedAttribute> selectedAttributes)

addValues

protected void addValues(java.util.Map<java.lang.String,java.util.Set<ItemModel>> itemsByType,
                         java.lang.String type,
                         java.util.Set<SelectedAttribute> selectedAttributes,
                         Sheet sheet)

getItemAttribute

protected java.lang.Object getItemAttribute(ItemModel item,
                                            SelectedAttribute selectedAttribute)

getDivider

@Deprecated
public DefaultExcelExportDivider getDivider()

Deprecated. since 6.7 please use getExcelExportDivider()

setDivider

@Deprecated
public void setDivider(DefaultExcelExportDivider divider)

Deprecated. since 6.7 please use setExcelExportDivider(ExcelExportDivider)

getExcelExportDivider

public ExcelExportDivider getExcelExportDivider()

setExcelExportDivider

public void setExcelExportDivider(ExcelExportDivider excelExportDivider)

getTemplatePath

public java.lang.String getTemplatePath()

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

getExcelTranslatorRegistry

public ExcelTranslatorRegistry getExcelTranslatorRegistry()

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

getExcelTemplateService

public ExcelTemplateService getExcelTemplateService()

setExcelTemplateService

public void setExcelTemplateService(ExcelTemplateService excelTemplateService)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getPermissionCRUDService

public PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)