Package com.hybris.backoffice.excel.exporting

Class DefaultExcelExportService

java.lang.Object

com.hybris.backoffice.excel.exporting.DefaultExcelExportService

All Implemented Interfaces:

ExcelExportService

public class DefaultExcelExportService
extends Object
implements ExcelExportService

Service for exporting data to excel workbook

Constructor Summary

Constructors

Constructor	Description
DefaultExcelExportService()

Method Summary

Modifier and Type	Method	Description
protected void	addHeader(org.apache.poi.ss.usermodel.Sheet sheet, Set<SelectedAttribute> selectedAttributes)
protected void	addValues(Map<String,Set<ItemModel>> itemsByType, String type, Set<SelectedAttribute> selectedAttributes, org.apache.poi.ss.usermodel.Sheet sheet)
protected List<SelectedAttribute>	applyAttributePredicates(List<SelectedAttribute> selectedAttributes)
protected Map<String,Set<ItemModel>>	applyTypePredicates(Map<String,Set<ItemModel>> itemsByType)
org.apache.poi.ss.usermodel.Workbook	exportData(String typeCode, List<SelectedAttribute> selectedAttributes)	Exports data to excel workbook for given type
org.apache.poi.ss.usermodel.Workbook	exportData(List<ItemModel> selectedItems, List<SelectedAttribute> selectedAttributes)	Exports data to excel workbook
protected org.apache.poi.ss.usermodel.Workbook	exportData(Map<String,Set<ItemModel>> itemsByType, List<SelectedAttribute> selectedAttributes)
org.apache.poi.ss.usermodel.Workbook	exportTemplate(String typeCode)	Exports a template excel workbook.
protected List<SelectedAttribute>	filterByPermissions(List<SelectedAttribute> selectedAttributes)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, attribute permission checking is now achieved by injecting into setAttributePredicates(Set) the PermissionCrudAttributePredicate
protected Map<String,Set<ItemModel>>	filterByPermissions(Map<String,Set<ItemModel>> itemsByType)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, type permission checking is now achieved by injecting into setAttributePredicates(Set) the PermissionCrudTypePredicate
Set<ExcelExportAttributePredicate>	getAttributePredicates()
BackofficeVariantsService	getBackofficeVariantsService()
CommonI18NService	getCommonI18NService()
DefaultExcelExportDivider	getDivider()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 please use getExcelExportDivider()
ExcelCellService	getExcelCellService()
ExcelExportDivider	getExcelExportDivider()
ExcelHeaderService	getExcelHeaderService()
ExcelSheetService	getExcelSheetService()
ExcelTemplateService	getExcelTemplateService()	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
ExcelTranslatorRegistry	getExcelTranslatorRegistry()
ExcelWorkbookService	getExcelWorkbookService()
I18NService	getI18NService()
protected Object	getItemAttribute(ItemModel item, SelectedAttribute selectedAttribute)
ModelService	getModelService()
PermissionCRUDService	getPermissionCRUDService()	Deprecated, for removal: This API element is subject to removal in a future version. since 1811 - not used anymore, the logic responsible for permission checking is now extracted to PermissionCrudTypePredicate and PermissionCrudAttributePredicate
SessionService	getSessionService()
String	getTemplatePath()
Set<ExcelExportTypePredicate>	getTypePredicates()
TypeService	getTypeService()
UserService	getUserService()
protected InputStream	loadExcelTemplate()
protected List<ItemModel>	refreshSelectedItems(List<ItemModel> selectedItems)
void	setAttributePredicates(Set<ExcelExportAttributePredicate> attributePredicates)
void	setBackofficeVariantsService(BackofficeVariantsService backofficeVariantsService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setDivider(DefaultExcelExportDivider divider)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.7 please use setExcelExportDivider(ExcelExportDivider)
void	setExcelCellService(ExcelCellService excelCellService)
void	setExcelExportDivider(ExcelExportDivider excelExportDivider)
void	setExcelHeaderService(ExcelHeaderService excelHeaderService)
void	setExcelSheetService(ExcelSheetService excelSheetService)
void	setExcelTemplateService(ExcelTemplateService excelTemplateService)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)
void	setI18NService(I18NService i18NService)
void	setModelService(ModelService modelService)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811 - not used anymore, the logic responsible for permission checking is now extracted to PermissionCrudTypePredicate and PermissionCrudAttributePredicate
void	setSessionService(SessionService sessionService)
void	setTemplatePath(String templatePath)
void	setTypePredicates(Set<ExcelExportTypePredicate> typePredicates)
void	setTypeService(TypeService typeService)
void	setUserService(UserService userService)
protected void	signWorkbookFile(org.apache.poi.ss.usermodel.Workbook workbook)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultExcelExportService

public DefaultExcelExportService()

Method Details

exportTemplate

public org.apache.poi.ss.usermodel.Workbook exportTemplate(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 org.apache.poi.ss.usermodel.Workbook exportData(List<ItemModel> selectedItems,
 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

refreshSelectedItems

protected List<ItemModel> refreshSelectedItems(List<ItemModel> selectedItems)

exportData

public org.apache.poi.ss.usermodel.Workbook exportData(String typeCode,
 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 org.apache.poi.ss.usermodel.Workbook exportData(Map<String,Set<ItemModel>> itemsByType,
 List<SelectedAttribute> selectedAttributes)

applyTypePredicates

protected Map<String,Set<ItemModel>> applyTypePredicates(Map<String,Set<ItemModel>> itemsByType)

applyAttributePredicates

protected List<SelectedAttribute> applyAttributePredicates(List<SelectedAttribute> selectedAttributes)

signWorkbookFile

protected void signWorkbookFile(org.apache.poi.ss.usermodel.Workbook workbook)

filterByPermissions

@Deprecated(since="1811",
            forRemoval=true)
protected List<SelectedAttribute> filterByPermissions(List<SelectedAttribute> selectedAttributes)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, attribute permission checking is now achieved by injecting into setAttributePredicates(Set) the PermissionCrudAttributePredicate

See Also:

• PermissionCrudAttributePredicate

filterByPermissions

@Deprecated(since="1811",
            forRemoval=true)
protected Map<String,Set<ItemModel>> filterByPermissions(Map<String,Set<ItemModel>> itemsByType)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, type permission checking is now achieved by injecting into setAttributePredicates(Set) the PermissionCrudTypePredicate

See Also:

• PermissionCrudTypePredicate

loadExcelTemplate

protected InputStream loadExcelTemplate()

addHeader

protected void addHeader(org.apache.poi.ss.usermodel.Sheet sheet,
 Set<SelectedAttribute> selectedAttributes)

addValues

protected void addValues(Map<String,Set<ItemModel>> itemsByType,
 String type,
 Set<SelectedAttribute> selectedAttributes,
 org.apache.poi.ss.usermodel.Sheet sheet)

getItemAttribute

protected Object getItemAttribute(ItemModel item,
 SelectedAttribute selectedAttribute)

getDivider

@Deprecated(since="6.7",
            forRemoval=true)
public DefaultExcelExportDivider getDivider()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 please use getExcelExportDivider()

setDivider

@Deprecated(since="6.7",
            forRemoval=true)
public void setDivider(DefaultExcelExportDivider divider)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.7 please use setExcelExportDivider(ExcelExportDivider)

getExcelExportDivider

public ExcelExportDivider getExcelExportDivider()

setExcelExportDivider

public void setExcelExportDivider(ExcelExportDivider excelExportDivider)

getTemplatePath

public String getTemplatePath()

setTemplatePath

public void setTemplatePath(String templatePath)

getExcelTranslatorRegistry

public ExcelTranslatorRegistry getExcelTranslatorRegistry()

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

getExcelTemplateService

@Deprecated(since="1808",
            forRemoval=true)
public ExcelTemplateService getExcelTemplateService()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808.

setExcelTemplateService

@Deprecated(since="1808",
            forRemoval=true)
public void setExcelTemplateService(ExcelTemplateService excelTemplateService)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808.

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getPermissionCRUDService

@Deprecated(since="1811",
            forRemoval=true)
public PermissionCRUDService getPermissionCRUDService()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811 - not used anymore, the logic responsible for permission checking is now extracted to PermissionCrudTypePredicate and PermissionCrudAttributePredicate

See Also:

• PermissionCrudTypePredicate
• PermissionCrudAttributePredicate

setPermissionCRUDService

@Deprecated(since="1811",
            forRemoval=true)
public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811 - not used anymore, the logic responsible for permission checking is now extracted to PermissionCrudTypePredicate and PermissionCrudAttributePredicate

See Also:

• PermissionCrudTypePredicate
• PermissionCrudAttributePredicate

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getExcelSheetService

public ExcelSheetService getExcelSheetService()

setExcelSheetService

public void setExcelSheetService(ExcelSheetService excelSheetService)

getExcelWorkbookService

public ExcelWorkbookService getExcelWorkbookService()

setExcelWorkbookService

public void setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)

getExcelCellService

public ExcelCellService getExcelCellService()

setExcelCellService

public void setExcelCellService(ExcelCellService excelCellService)

getExcelHeaderService

public ExcelHeaderService getExcelHeaderService()

setExcelHeaderService

public void setExcelHeaderService(ExcelHeaderService excelHeaderService)

getI18NService

public I18NService getI18NService()

setI18NService

public void setI18NService(I18NService i18NService)

getSessionService

public SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getUserService

public UserService getUserService()

setUserService

public void setUserService(UserService userService)

getBackofficeVariantsService

public BackofficeVariantsService getBackofficeVariantsService()

setBackofficeVariantsService

public void setBackofficeVariantsService(BackofficeVariantsService backofficeVariantsService)

getAttributePredicates

public Set<ExcelExportAttributePredicate> getAttributePredicates()

setAttributePredicates

public void setAttributePredicates(Set<ExcelExportAttributePredicate> attributePredicates)

getTypePredicates

public Set<ExcelExportTypePredicate> getTypePredicates()

setTypePredicates

public void setTypePredicates(Set<ExcelExportTypePredicate> typePredicates)