Package com.hybris.backoffice.renderer.attributeschooser

Class ClassificationAttributesExportRenderer

java.lang.Object

com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer<org.zkoss.zk.ui.Component,com.hybris.cockpitng.config.jaxb.wizard.ViewType,Map<String,String>>

com.hybris.cockpitng.widgets.configurableflow.renderer.DefaultCustomViewRenderer

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

com.hybris.backoffice.renderer.attributeschooser.ClassificationAttributesExportRenderer

All Implemented Interfaces:

com.hybris.cockpitng.widgets.common.NotifyingWidgetComponentRenderer<org.zkoss.zk.ui.Component,com.hybris.cockpitng.config.jaxb.wizard.ViewType,Map<String,String>>, com.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component,com.hybris.cockpitng.config.jaxb.wizard.ViewType,Map<String,String>>

Direct Known Subclasses:

ClassificationAttributesWithoutLocalizationRenderer

public class ClassificationAttributesExportRenderer
extends AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

Renders components that allow to pick a list of classification attributes 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
• "includeAllSupported" - defines if include all should be available
• "excludeLocalizedNodes" - defines if language nodes should be available. For example: if set to true then localized node will be visible, but the node will not have any children
• "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	Description
static final String	DEFAULT_PARAM_ATTRIBUTES_FORM
static final String	PARAM_ATTRIBUTES_FORM
static final String	PARAM_EMPTY_ATTRIBUTES_MESSAGE_KEY
static final String	PARAM_EXCLUDE_LOCALIZED_NODES
static final String	PARAM_ITEMS_TO_EXPORT
static final String	PARAM_RETRIEVE_MODE
static final String	RETRIEVE_MODE_ALL
static final String	RETRIEVE_MODE_ITEMS_INTERSECTION
static final 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	Description
ClassificationAttributesExportRenderer()

Method Summary

Modifier and Type	Method	Description
protected String	createAttributeName(ClassAttributeAssignmentModel attrDesc)
protected String	createAttributeQualifier(ClassAttributeAssignmentModel attrDesc)
protected com.hybris.backoffice.attributechooser.AttributesChooserConfig	createAttributesChooserConfig(com.hybris.cockpitng.engine.WidgetInstanceManager wim, Map<String,String> params)
protected Map<ClassificationSystemVersionModel,List<ClassificationClassModel>>	filterByPermissionCheck(Map<ClassificationSystemVersionModel,List<ClassificationClassModel>> map)
protected com.hybris.backoffice.attributechooser.AttributeChooserForm	getAttributesForm(com.hybris.cockpitng.engine.WidgetInstanceManager wim, Map<String,String> parameters)
Predicate<ClassificationSystemModel>	getBlacklistedClassificationPredicate()
protected Map<ClassificationSystemVersionModel,List<ClassificationClassModel>>	getCommonClassificationClasses(Collection<ItemModel> items, String retrieveMode)
ExcelClassificationService	getExcelClassificationService()
protected List<ItemModel>	getItems(com.hybris.cockpitng.engine.WidgetInstanceManager wim, Map<String,String> parameters)
com.hybris.cockpitng.labels.LabelService	getLabelService()
protected String	getRetrieveMode(Map<String,String> params)
Predicate<ClassAttributeAssignmentModel>	getSupportedAttributesPredicate()
protected boolean	isLocalized(ClassAttributeAssignmentModel classificationAttribute)
protected boolean	isSupported(ClassAttributeAssignmentModel classificationAttribute)
protected void	populateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm attributesForm, List<ItemModel> items, String retrieveMode)	Deprecated, for removal: This API element is subject to removal in a future version. since 2005.
protected void	populateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm attributesForm, List<ItemModel> items, String retrieveMode, Map<String,String> params)
void	render(org.zkoss.zk.ui.Component parent, com.hybris.cockpitng.config.jaxb.wizard.ViewType customView, Map<String,String> params, com.hybris.cockpitng.dataaccess.facades.type.DataType dataType, com.hybris.cockpitng.engine.WidgetInstanceManager wim)
void	setBlacklistedClassificationPredicate(Predicate<ClassificationSystemModel> blacklistedClassificationPredicate)
void	setExcelClassificationService(ExcelClassificationService excelClassificationService)
void	setLabelService(com.hybris.cockpitng.labels.LabelService labelService)
void	setSupportedAttributesPredicate(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 com.hybris.cockpitng.widgets.common.AbstractWidgetComponentRenderer

addRendererListener, fireComponentRendered, fireComponentRendered, fireComponentRendered, removeRendererListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hybris.cockpitng.widgets.common.WidgetComponentRenderer

render

Field Details

PARAM_ATTRIBUTES_FORM

public static final String PARAM_ATTRIBUTES_FORM

See Also:

• Constant Field Values

PARAM_ITEMS_TO_EXPORT

public static final String PARAM_ITEMS_TO_EXPORT

See Also:

• Constant Field Values

PARAM_EMPTY_ATTRIBUTES_MESSAGE_KEY

public static final String PARAM_EMPTY_ATTRIBUTES_MESSAGE_KEY

See Also:

• Constant Field Values

PARAM_RETRIEVE_MODE

public static final String PARAM_RETRIEVE_MODE

See Also:

• Constant Field Values

PARAM_EXCLUDE_LOCALIZED_NODES

public static final String PARAM_EXCLUDE_LOCALIZED_NODES

See Also:

• Constant Field Values

RETRIEVE_MODE_ITEMS_INTERSECTION

public static final String RETRIEVE_MODE_ITEMS_INTERSECTION

See Also:

• Constant Field Values

RETRIEVE_MODE_ITEMS_UNION

public static final String RETRIEVE_MODE_ITEMS_UNION

See Also:

• Constant Field Values

RETRIEVE_MODE_ALL

public static final String RETRIEVE_MODE_ALL

See Also:

• Constant Field Values

DEFAULT_PARAM_ATTRIBUTES_FORM

public static final String DEFAULT_PARAM_ATTRIBUTES_FORM

See Also:

• Constant Field Values

Constructor Details

ClassificationAttributesExportRenderer

public ClassificationAttributesExportRenderer()

Method Details

render

public void render(org.zkoss.zk.ui.Component parent,
 com.hybris.cockpitng.config.jaxb.wizard.ViewType customView,
 Map<String,String> params,
 com.hybris.cockpitng.dataaccess.facades.type.DataType dataType,
 com.hybris.cockpitng.engine.WidgetInstanceManager wim)

Specified by:

render in interface com.hybris.cockpitng.widgets.common.WidgetComponentRenderer<org.zkoss.zk.ui.Component,com.hybris.cockpitng.config.jaxb.wizard.ViewType,Map<String,String>>

Specified by:

render in class com.hybris.cockpitng.widgets.configurableflow.renderer.DefaultCustomViewRenderer

populateAttributesChooserForm

@Deprecated(since="2005",
            forRemoval=true)
protected void populateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm attributesForm,
 List<ItemModel> items,
 String retrieveMode)

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

since 2005. Use populateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm, java.util.List, java.lang.String, java.util.Map) instead

populateAttributesChooserForm

protected void populateAttributesChooserForm(com.hybris.backoffice.attributechooser.AttributeChooserForm attributesForm,
 List<ItemModel> items,
 String retrieveMode,
 Map<String,String> params)

filterByPermissionCheck

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

getCommonClassificationClasses

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

getRetrieveMode

protected String getRetrieveMode(Map<String,String> params)

isSupported

protected boolean isSupported(ClassAttributeAssignmentModel classificationAttribute)

getAttributesForm

protected com.hybris.backoffice.attributechooser.AttributeChooserForm getAttributesForm(com.hybris.cockpitng.engine.WidgetInstanceManager wim,
 Map<String,String> parameters)

getItems

protected List<ItemModel> getItems(com.hybris.cockpitng.engine.WidgetInstanceManager wim,
 Map<String,String> parameters)

createAttributeQualifier

protected String createAttributeQualifier(ClassAttributeAssignmentModel attrDesc)

Specified by:

createAttributeQualifier in class AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

getSupportedAttributesPredicate

public Predicate<ClassAttributeAssignmentModel> getSupportedAttributesPredicate()

setSupportedAttributesPredicate

public void setSupportedAttributesPredicate(Predicate<ClassAttributeAssignmentModel> supportedAttributePredicate)

createAttributesChooserConfig

protected com.hybris.backoffice.attributechooser.AttributesChooserConfig createAttributesChooserConfig(com.hybris.cockpitng.engine.WidgetInstanceManager wim,
 Map<String,String> params)

Overrides:

createAttributesChooserConfig in class AbstractAttributesExportRenderer<ClassAttributeAssignmentModel>

createAttributeName

protected 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 com.hybris.cockpitng.labels.LabelService getLabelService()

setLabelService

public void setLabelService(com.hybris.cockpitng.labels.LabelService labelService)

getBlacklistedClassificationPredicate

public Predicate<ClassificationSystemModel> getBlacklistedClassificationPredicate()

setBlacklistedClassificationPredicate

public void setBlacklistedClassificationPredicate(Predicate<ClassificationSystemModel> blacklistedClassificationPredicate)