com.hybris.backoffice.renderer.attributeschooser

Class ClassificationAttributesExportRenderer

java.lang.Object

DefaultCustomViewRenderer

com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

com.hybris.backoffice.renderer.attributeschooser.ClassificationAttributesExportRenderer

public class ClassificationAttributesExportRenderer
extends AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

Renders components that allow to pick a list of classification attributes to be exported to excel for given products.

Displays a list of available classification attributes of given Products, and a second list of selected attributes. Mandatory attributes are selected by default. Current implementation only allows to select classification attributes of all selected products. Params:

• "classificationAttributesFormModelKey" - defines where in model attributes form is AttributeChooserForm - required
• "itemsToExport" - defines spel to get items from model AttributeChooserForm - required
• - defines if include all should be available
• "emptyAttributesMessageKey" - defines message key for label displayed in case there are no attributes to select.
• "retrieveMode" - defines in what way classification classes are retrieved. There are 3 modes:
  • "ITEMS_INTERSECTION" - default value. In this mode displayed classification classes are retrieved from given items and intersected - it means that only common classes are displayed.
  • "ITEMS_UNION" - in this mode displayed classification classes are retrieved from given items - all classification classes from given items are then displayed.
  • "ALL" - in this mode all classification classes from the system are displayed - not only from given items

Available classification attributes can be filtered by setSupportedAttributesPredicate(Predicate)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_ATTRIBUTES_FORM
static java.lang.String	PARAM_EMPTY_ATTRIBUTES_MESSAGE_KEY
static java.lang.String	PARAM_ITEMS_TO_EXPORT
static java.lang.String	PARAM_RETRIEVE_MODE
static java.lang.String	RETRIEVE_MODE_ALL
static java.lang.String	RETRIEVE_MODE_ITEMS_INTERSECTION
static java.lang.String	RETRIEVE_MODE_ITEMS_UNION

Fields inherited from class com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer

attributesChooserRenderer, cockpitLocaleService, notificationService, PARAM_INCLUDE_ALL_SUPPORTED, permissionFacade

Constructor Summary

Constructors

Constructor and Description
ClassificationAttributesExportRenderer()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createAttributeName(ClassAttributeAssignmentModel attrDesc)
protected java.lang.String	createAttributeQualifier(ClassAttributeAssignmentModel attrDesc)
protected AttributesChooserConfig	createAttributesChooserConfig(WidgetInstanceManager wim, java.util.Map<java.lang.String,java.lang.String> params)
protected java.util.Map<ClassificationSystemVersionModel,java.util.List<ClassificationClassModel>>	filterByPermissionCheck(java.util.Map<ClassificationSystemVersionModel,java.util.List<ClassificationClassModel>> map)
protected AttributeChooserForm	getAttributesForm(WidgetInstanceManager wim, java.util.Map<java.lang.String,java.lang.String> parameters)
java.util.function.Predicate<ClassificationSystemModel>	getBlacklistedClassificationPredicate()
protected java.util.Map<ClassificationSystemVersionModel,java.util.List<ClassificationClassModel>>	getCommonClassificationClasses(java.util.Collection<ItemModel> items, java.lang.String retrieveMode)
ExcelClassificationService	getExcelClassificationService()
protected java.util.List<ItemModel>	getItems(WidgetInstanceManager wim, java.util.Map<java.lang.String,java.lang.String> parameters)
LabelService	getLabelService()
protected java.lang.String	getRetrieveMode(java.util.Map<java.lang.String,java.lang.String> params)
java.util.function.Predicate<ClassAttributeAssignmentModel>	getSupportedAttributesPredicate()
protected boolean	isLocalized(ClassAttributeAssignmentModel classificationAttribute)
protected boolean	isSupported(ClassAttributeAssignmentModel classificationAttribute)
protected void	populateAttributesChooserForm(AttributeChooserForm attributesForm, java.util.List<ItemModel> items, java.lang.String retrieveMode)
void	render(Component parent, ViewType customView, java.util.Map<java.lang.String,java.lang.String> params, DataType dataType, WidgetInstanceManager wim)
void	setBlacklistedClassificationPredicate(java.util.function.Predicate<ClassificationSystemModel> blacklistedClassificationPredicate)
void	setExcelClassificationService(ExcelClassificationService excelClassificationService)
void	setLabelService(LabelService labelService)
void	setSupportedAttributesPredicate(java.util.function.Predicate<ClassAttributeAssignmentModel> supportedAttributePredicate)

Methods inherited from class com.hybris.backoffice.renderer.attributeschooser.AbstractAttributesExportRenderer

createAttributeWithLocalizedChildren, getAttributesChooserRenderer, getCockpitLocaleService, getNotificationService, getPermissionFacade, getSupportedLanguages, setAttributesChooserRenderer, setCockpitLocaleService, setNotificationService, setPermissionFacade

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ATTRIBUTES_FORM

public static final java.lang.String PARAM_ATTRIBUTES_FORM

See Also:

Constant Field Values

PARAM_ITEMS_TO_EXPORT

public static final java.lang.String PARAM_ITEMS_TO_EXPORT

See Also:

Constant Field Values

PARAM_EMPTY_ATTRIBUTES_MESSAGE_KEY

public static final java.lang.String PARAM_EMPTY_ATTRIBUTES_MESSAGE_KEY

See Also:

Constant Field Values

PARAM_RETRIEVE_MODE

public static final java.lang.String PARAM_RETRIEVE_MODE

See Also:

Constant Field Values

RETRIEVE_MODE_ITEMS_INTERSECTION

public static final java.lang.String RETRIEVE_MODE_ITEMS_INTERSECTION

See Also:

Constant Field Values

RETRIEVE_MODE_ITEMS_UNION

public static final java.lang.String RETRIEVE_MODE_ITEMS_UNION

See Also:

Constant Field Values

RETRIEVE_MODE_ALL

public static final java.lang.String RETRIEVE_MODE_ALL

See Also:

Constant Field Values

Constructor Detail

ClassificationAttributesExportRenderer

public ClassificationAttributesExportRenderer()

Method Detail

render

public void render(Component parent,
                   ViewType customView,
                   java.util.Map<java.lang.String,java.lang.String> params,
                   DataType dataType,
                   WidgetInstanceManager wim)

populateAttributesChooserForm

protected void populateAttributesChooserForm(AttributeChooserForm attributesForm,
                                             java.util.List<ItemModel> items,
                                             java.lang.String retrieveMode)

filterByPermissionCheck

protected java.util.Map<ClassificationSystemVersionModel,java.util.List<ClassificationClassModel>> filterByPermissionCheck(java.util.Map<ClassificationSystemVersionModel,java.util.List<ClassificationClassModel>> map)

getCommonClassificationClasses

protected java.util.Map<ClassificationSystemVersionModel,java.util.List<ClassificationClassModel>> getCommonClassificationClasses(java.util.Collection<ItemModel> items,
                                                                                                                                  java.lang.String retrieveMode)

getRetrieveMode

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

isSupported

protected boolean isSupported(ClassAttributeAssignmentModel classificationAttribute)

getAttributesForm

protected AttributeChooserForm getAttributesForm(WidgetInstanceManager wim,
                                                 java.util.Map<java.lang.String,java.lang.String> parameters)

getItems

protected java.util.List<ItemModel> getItems(WidgetInstanceManager wim,
                                             java.util.Map<java.lang.String,java.lang.String> parameters)

createAttributeQualifier

protected java.lang.String createAttributeQualifier(ClassAttributeAssignmentModel attrDesc)

Specified by:

createAttributeQualifier in class AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

getSupportedAttributesPredicate

public java.util.function.Predicate<ClassAttributeAssignmentModel> getSupportedAttributesPredicate()

setSupportedAttributesPredicate

public void setSupportedAttributesPredicate(java.util.function.Predicate<ClassAttributeAssignmentModel> supportedAttributePredicate)

createAttributesChooserConfig

protected AttributesChooserConfig createAttributesChooserConfig(WidgetInstanceManager wim,
                                                                java.util.Map<java.lang.String,java.lang.String> params)

Overrides:

createAttributesChooserConfig in class AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

createAttributeName

protected java.lang.String createAttributeName(ClassAttributeAssignmentModel attrDesc)

Specified by:

createAttributeName in class AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

isLocalized

protected boolean isLocalized(ClassAttributeAssignmentModel classificationAttribute)

Specified by:

isLocalized in class AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

getExcelClassificationService

public ExcelClassificationService getExcelClassificationService()

setExcelClassificationService

public void setExcelClassificationService(ExcelClassificationService excelClassificationService)

getLabelService

public LabelService getLabelService()

setLabelService

public void setLabelService(LabelService labelService)

getBlacklistedClassificationPredicate

public java.util.function.Predicate<ClassificationSystemModel> getBlacklistedClassificationPredicate()

setBlacklistedClassificationPredicate

public void setBlacklistedClassificationPredicate(java.util.function.Predicate<ClassificationSystemModel> blacklistedClassificationPredicate)