Package com.hybris.backoffice.excel.export.wizard

Class ExcelExportHandler

java.lang.Object

com.hybris.backoffice.excel.export.wizard.ExcelExportHandler

All Implemented Interfaces:

com.hybris.cockpitng.widgets.configurableflow.FlowActionHandler

public class ExcelExportHandler
extends java.lang.Object
implements com.hybris.cockpitng.widgets.configurableflow.FlowActionHandler

Exports selected attributes to excel file.

• "excelExportFormModelKey" - defines where in model excel export form is ExcelExportWizardForm - required
• "excelIncludeClassification" - "true" or "false". Defines whether include classification attributes to the file or not. Default value is "true"

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PARAM_EXCEL_EXPORT_FORM_MODEL_KEY
static java.lang.String	PARAM_EXCEL_INCLUDE_CLASSIFICATION

Constructor Summary

Constructors

Constructor	Description
ExcelExportHandler()

Method Summary

Modifier and Type	Method	Description
protected int	comparingExcelAttribute(ExcelAttribute a, ExcelAttribute b)
protected int	comparingSelectedAttributes(SelectedAttribute a, SelectedAttribute b)
protected org.apache.poi.ss.usermodel.Workbook	exportData(ExcelExportWizardForm form, java.util.List<ItemModel> itemsToExport, java.util.List<SelectedAttribute> selectedAttributes)
protected java.util.List<com.hybris.backoffice.attributechooser.Attribute>	extractLeafs(java.util.Set<com.hybris.backoffice.attributechooser.Attribute> attributes)
protected java.util.List<ExcelAttribute>	getAdditionalAttributes(ExcelExportWizardForm excelForm)
protected java.util.List<ExcelAttribute>	getAvailableAdditionalAttributes(ExcelExportWizardForm excelForm)
protected ClassAttributeAssignmentModel	getClassAttributeAssignmentModel(com.hybris.backoffice.attributechooser.Attribute attribute)
protected ExcelExportWizardForm	getExcelExportForm(com.hybris.cockpitng.engine.WidgetInstanceManager wim, java.util.Map<java.lang.String,java.lang.String> parameters)
ExcelExportWorkbookPostProcessor	getExcelExportWorkbookPostProcessor()
protected int	getExportAttributesMaxCount()
ExcelExportService	getExportService()
protected java.lang.String	getFilename(ExcelExportWizardForm form)
LocalizationService	getLocalizationService()
com.hybris.backoffice.widgets.notificationarea.NotificationService	getNotificationService()
com.hybris.cockpitng.dataaccess.facades.object.ObjectFacade	getObjectFacade()
protected java.util.List<SelectedAttribute>	getSelectedAttributes(ExcelExportWizardForm excelForm)
TypeService	getTypeService()
void	perform(com.hybris.cockpitng.config.jaxb.wizard.CustomType customType, com.hybris.cockpitng.widgets.configurableflow.FlowActionHandlerAdapter adapter, java.util.Map<java.lang.String,java.lang.String> params)
void	setExcelClassificationAttributeFactory(ExcelClassificationAttributeFactory excelClassificationAttributeFactory)
void	setExcelExportPreProcessor(ExcelExportPreProcessor excelExportPreProcessor)
void	setExcelExportWorkbookPostProcessor(ExcelExportWorkbookPostProcessor excelExportWorkbookPostProcessor)
void	setExportService(ExcelExportService exportService)
void	setLocalizationService(LocalizationService localizationService)
void	setNotificationService(com.hybris.backoffice.widgets.notificationarea.NotificationService notificationService)
void	setObjectFacade(com.hybris.cockpitng.dataaccess.facades.object.ObjectFacade objectFacade)
void	setTypeService(TypeService typeService)
protected ExcelAttribute	toClassificationAttribute(com.hybris.backoffice.attributechooser.Attribute attribute, ClassAttributeAssignmentModel descriptor, java.util.Map<java.lang.String,java.lang.String> langTagToLanguageIsoCodeCache)
protected java.util.List<ExcelAttribute>	toClassificationAttributes(java.util.Set<com.hybris.backoffice.attributechooser.Attribute> attributes)
protected boolean	toIncludeClassification(java.util.Map<java.lang.String,java.lang.String> params)
protected java.util.List<SelectedAttribute>	toSelectedAttributes(com.hybris.backoffice.attributechooser.Attribute attribute, AttributeDescriptorModel descriptor, java.util.Map<java.lang.String,java.lang.String> langTagToLanguageIsoCodeCache)
protected java.util.List<SelectedAttribute>	toSelectedAttributes(java.lang.String typeCode, java.util.Set<com.hybris.backoffice.attributechooser.Attribute> selectedAttributes)
protected void	triggerDownloading(org.apache.poi.ss.usermodel.Workbook template, java.lang.String filename)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_EXCEL_EXPORT_FORM_MODEL_KEY

public static final java.lang.String PARAM_EXCEL_EXPORT_FORM_MODEL_KEY

See Also:

Constant Field Values

PARAM_EXCEL_INCLUDE_CLASSIFICATION

public static final java.lang.String PARAM_EXCEL_INCLUDE_CLASSIFICATION

See Also:

Constant Field Values

Constructor Detail

ExcelExportHandler

public ExcelExportHandler()

Method Detail

perform

public void perform(com.hybris.cockpitng.config.jaxb.wizard.CustomType customType,
                    com.hybris.cockpitng.widgets.configurableflow.FlowActionHandlerAdapter adapter,
                    java.util.Map<java.lang.String,java.lang.String> params)

Specified by:

perform in interface com.hybris.cockpitng.widgets.configurableflow.FlowActionHandler

getSelectedAttributes

protected java.util.List<SelectedAttribute> getSelectedAttributes(ExcelExportWizardForm excelForm)

exportData

protected org.apache.poi.ss.usermodel.Workbook exportData(ExcelExportWizardForm form,
                                                          java.util.List<ItemModel> itemsToExport,
                                                          java.util.List<SelectedAttribute> selectedAttributes)

getAdditionalAttributes

protected final java.util.List<ExcelAttribute> getAdditionalAttributes(ExcelExportWizardForm excelForm)

getAvailableAdditionalAttributes

protected final java.util.List<ExcelAttribute> getAvailableAdditionalAttributes(ExcelExportWizardForm excelForm)

toSelectedAttributes

protected java.util.List<SelectedAttribute> toSelectedAttributes(java.lang.String typeCode,
                                                                 java.util.Set<com.hybris.backoffice.attributechooser.Attribute> selectedAttributes)

toSelectedAttributes

protected java.util.List<SelectedAttribute> toSelectedAttributes(com.hybris.backoffice.attributechooser.Attribute attribute,
                                                                 AttributeDescriptorModel descriptor,
                                                                 java.util.Map<java.lang.String,java.lang.String> langTagToLanguageIsoCodeCache)

toClassificationAttributes

protected java.util.List<ExcelAttribute> toClassificationAttributes(java.util.Set<com.hybris.backoffice.attributechooser.Attribute> attributes)

extractLeafs

protected java.util.List<com.hybris.backoffice.attributechooser.Attribute> extractLeafs(java.util.Set<com.hybris.backoffice.attributechooser.Attribute> attributes)

getClassAttributeAssignmentModel

protected ClassAttributeAssignmentModel getClassAttributeAssignmentModel(com.hybris.backoffice.attributechooser.Attribute attribute)

toClassificationAttribute

protected ExcelAttribute toClassificationAttribute(com.hybris.backoffice.attributechooser.Attribute attribute,
                                                   ClassAttributeAssignmentModel descriptor,
                                                   java.util.Map<java.lang.String,java.lang.String> langTagToLanguageIsoCodeCache)

comparingSelectedAttributes

protected int comparingSelectedAttributes(SelectedAttribute a,
                                          SelectedAttribute b)

comparingExcelAttribute

protected int comparingExcelAttribute(ExcelAttribute a,
                                      ExcelAttribute b)

getFilename

protected java.lang.String getFilename(ExcelExportWizardForm form)

triggerDownloading

protected void triggerDownloading(org.apache.poi.ss.usermodel.Workbook template,
                                  java.lang.String filename)

getExportAttributesMaxCount

protected int getExportAttributesMaxCount()

getExcelExportForm

protected ExcelExportWizardForm getExcelExportForm(com.hybris.cockpitng.engine.WidgetInstanceManager wim,
                                                   java.util.Map<java.lang.String,java.lang.String> parameters)

toIncludeClassification

protected boolean toIncludeClassification(java.util.Map<java.lang.String,java.lang.String> params)

getExportService

public ExcelExportService getExportService()

setExportService

public void setExportService(ExcelExportService exportService)

getNotificationService

public com.hybris.backoffice.widgets.notificationarea.NotificationService getNotificationService()

setNotificationService

public void setNotificationService(com.hybris.backoffice.widgets.notificationarea.NotificationService notificationService)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getLocalizationService

public LocalizationService getLocalizationService()

setLocalizationService

public void setLocalizationService(LocalizationService localizationService)

getExcelExportWorkbookPostProcessor

public ExcelExportWorkbookPostProcessor getExcelExportWorkbookPostProcessor()

setExcelExportWorkbookPostProcessor

public void setExcelExportWorkbookPostProcessor(ExcelExportWorkbookPostProcessor excelExportWorkbookPostProcessor)

getObjectFacade

public com.hybris.cockpitng.dataaccess.facades.object.ObjectFacade getObjectFacade()

setObjectFacade

public void setObjectFacade(com.hybris.cockpitng.dataaccess.facades.object.ObjectFacade objectFacade)

setExcelClassificationAttributeFactory

public void setExcelClassificationAttributeFactory(ExcelClassificationAttributeFactory excelClassificationAttributeFactory)

setExcelExportPreProcessor

public void setExcelExportPreProcessor(ExcelExportPreProcessor excelExportPreProcessor)