de.hybris.platform.sap.productconfig.facades.impl

Class ClassificationSystemCPQAttributesProviderImpl

java.lang.Object

de.hybris.platform.sap.productconfig.facades.impl.ClassificationSystemCPQAttributesProviderImpl

All Implemented Interfaces:

ClassificationSystemCPQAttributesProvider

public class ClassificationSystemCPQAttributesProviderImpl
extends Object
implements ClassificationSystemCPQAttributesProvider

Default implementation of the ClassificationSystemCPQAttributesProvider.

Constructor Summary

Constructors

Constructor and Description
ClassificationSystemCPQAttributesProviderImpl()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Collection<MediaModel>>	addMediaEntries(Collection<ClassificationAttributeValueModel> attrValues)
protected List<ImageData>	convertMediaToImages(Collection<MediaModel> media, Map<String,CPQImageType> cpqMediaFormatQualifiers)
protected void	determineAvailableClassificationSystems(List<CatalogModel> catalogs, List<ClassificationSystemModel> availableClassificationSystems, List<ClassificationSystemModel> availableClassificationSystemsMatchingPattern)
protected Collection<MediaModel>	extractCsticMediaFromAttributeModel(ClassificationAttributeModel attr)
protected Map<String,Collection<MediaModel>>	extractCsticValueMediaFromAttributeModel(Collection<ClassificationAttributeValueModel> attrValues)
protected Map<String,String>	extractValueNamesFromAttributeModel(Collection<ClassificationAttributeValueModel> attrValues)
protected Collection<ClassificationAttributeModel>	findClassificationAttributesByCode(ClassificationSystemVersionModel systemVersion, String code)
protected Collection<ClassificationAttributeValueModel>	findClassificationAttributeValuesByCodePrefix(ClassificationSystemVersionModel systemVersion, String code)
protected BaseStoreModel	getBaseStore()
protected ClassificationAttributeModel	getClassificationAttribute(String name, ClassificationSystemVersionModel systemVersion) Retrieves the hybris classification attribute for a characteristic name (which is part of a CPQ configuraton model).
protected String	getClassificationSystemSubString() Returns substring we search for in the available classification systems.
ClassificationSystemCPQAttributesContainer	getCPQAttributes(String name, Map<String,ClassificationSystemCPQAttributesContainer> nameMap) Get CPQ related attributes for the given cstic from the hybris classification system.
protected CPQImageFormatMapping	getCpqCsticImageFormatMapping()
protected CPQImageFormatMapping	getCpqCsticValueImageFormatMapping()
List<ImageData>	getCsticMedia(ClassificationSystemCPQAttributesContainer cpqAttributes) extracts all media assigned to this cstic from the CPQ hybris attribute container.
List<ImageData>	getCsticValueMedia(String csticValueKey, ClassificationSystemCPQAttributesContainer cpqAttributes) extracts all media assigned to this cstic value from the CPQ hybris attribute container.
String	getDisplayName(CsticModel csticModel, ClassificationSystemCPQAttributesContainer cpqAttributes, boolean isDebugEnabled) returns the display name for the cstic.
String	getDisplayValueName(CsticValueModel valueModel, CsticModel csticModel, ClassificationSystemCPQAttributesContainer cpqAttributes, boolean isDebugEnabled) returns the display name for the cstic value.
protected FlexibleSearchService	getFlexibleSearchService()
protected ImagePopulator	getImagePopulator()
String	getLongText(CsticModel model, ClassificationSystemCPQAttributesContainer cpqAttributes, boolean isDebugEnabled) returns the long text for the cstic.
protected ClassificationSystemCPQAttributesContainer	getNameFromAttribute(ClassificationAttributeModel attr, ClassificationSystemVersionModel systemVersion)
String	getOverviewValueName(CsticValueModel valueModel, CsticModel csticModel, ClassificationSystemCPQAttributesContainer cpqAttributes, boolean isDebugEnabled) returns the display name for the cstic value in context of the overview page.
protected ClassificationSystemVersionModel	getSystemVersion() Determines the classification system we use for retrieving the hybris classification attributes for CPQ characteristics.
protected UiTypeFinder	getUiTypeFinder()
protected ValueFormatTranslator	getValueFormatTranslator()
protected String	getValueName(CsticValueModel valueModel, CsticModel csticModel, ClassificationSystemCPQAttributesContainer cpqAttributes, boolean isDebugEnabled)
boolean	isDebugEnabled()
protected void	logValue(String className, String nameType, String name, String targetType, String sourceType, String value, boolean isDebugEnabled)
void	setBaseStoreService(BaseStoreService baseStoreService)
void	setClassificationService(ClassificationSystemService classificationService)
void	setCpqCsticImageFormatMapping(CPQImageFormatMapping cpqCsticImageFormatMapping)
void	setCpqCsticValueImageFormatMapping(CPQImageFormatMapping cpqCsticValueImageFormatMapping)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setImagePopulator(ImagePopulator imagePopulator)
void	setUiTypeFinder(UiTypeFinder uiTypeFinder)
void	setValueFormatTranslator(ValueFormatTranslator valueFormatTranslator)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassificationSystemCPQAttributesProviderImpl

public ClassificationSystemCPQAttributesProviderImpl()

Method Detail

getCPQAttributes

public ClassificationSystemCPQAttributesContainer getCPQAttributes(String name,
                                                                   Map<String,ClassificationSystemCPQAttributesContainer> nameMap)

Description copied from interface: ClassificationSystemCPQAttributesProvider

Get CPQ related attributes for the given cstic from the hybris classification system. It is recommended to provide a nameMap, which should be cached at least on session level, so that the results can be cached in the map and so that there is no need to query CPQ attributes on each invocation.

Specified by:

getCPQAttributes in interface ClassificationSystemCPQAttributesProvider

Parameters:

name - cstic name

nameMap - to cache results

Returns:

CPQ attribute container

getNameFromAttribute

protected ClassificationSystemCPQAttributesContainer getNameFromAttribute(ClassificationAttributeModel attr,
                                                                          ClassificationSystemVersionModel systemVersion)

extractCsticValueMediaFromAttributeModel

protected Map<String,Collection<MediaModel>> extractCsticValueMediaFromAttributeModel(Collection<ClassificationAttributeValueModel> attrValues)

addMediaEntries

protected final Map<String,Collection<MediaModel>> addMediaEntries(Collection<ClassificationAttributeValueModel> attrValues)

extractCsticMediaFromAttributeModel

protected Collection<MediaModel> extractCsticMediaFromAttributeModel(ClassificationAttributeModel attr)

extractValueNamesFromAttributeModel

protected Map<String,String> extractValueNamesFromAttributeModel(Collection<ClassificationAttributeValueModel> attrValues)

getCsticMedia

public List<ImageData> getCsticMedia(ClassificationSystemCPQAttributesContainer cpqAttributes)

Description copied from interface: ClassificationSystemCPQAttributesProvider

extracts all media assigned to this cstic from the CPQ hybris attribute container. The configuration engine model does not contain any media mappings, so this can only be maintained in hybris.

Specified by:

getCsticMedia in interface ClassificationSystemCPQAttributesProvider

Parameters:

cpqAttributes - CPQ attribute container with hybris media

Returns:

list of medias

getCsticValueMedia

public List<ImageData> getCsticValueMedia(String csticValueKey,
                                          ClassificationSystemCPQAttributesContainer cpqAttributes)

Description copied from interface: ClassificationSystemCPQAttributesProvider

extracts all media assigned to this cstic value from the CPQ hybris attribute container. The configuration engine model does not contain any media mappings, so this can only be maintained in hybris.

Specified by:

getCsticValueMedia in interface ClassificationSystemCPQAttributesProvider

Parameters:

csticValueKey - key of the cstic value

cpqAttributes - CPQ attribute container with hybris media

Returns:

list of medias

convertMediaToImages

protected List<ImageData> convertMediaToImages(Collection<MediaModel> media,
                                               Map<String,CPQImageType> cpqMediaFormatQualifiers)

getLongText

public String getLongText(CsticModel model,
                          ClassificationSystemCPQAttributesContainer cpqAttributes,
                          boolean isDebugEnabled)

Description copied from interface: ClassificationSystemCPQAttributesProvider

returns the long text for the cstic. In case a long text is present in the CPQ attribute container it will be returned, otherwise the long text is extracted from the cstic model.

Specified by:

getLongText in interface ClassificationSystemCPQAttributesProvider

Parameters:

model - model of the cstic

cpqAttributes - CPQ attribute container with hybris long text

isDebugEnabled - only if true, debug logs will be written

Returns:

cstic name to be displayed

logValue

protected void logValue(String className,
                        String nameType,
                        String name,
                        String targetType,
                        String sourceType,
                        String value,
                        boolean isDebugEnabled)

getDisplayName

public String getDisplayName(CsticModel csticModel,
                             ClassificationSystemCPQAttributesContainer cpqAttributes,
                             boolean isDebugEnabled)

Description copied from interface: ClassificationSystemCPQAttributesProvider

returns the display name for the cstic. In case a display name is present in the CPQ attribute container it will be returned, otherwise the display name is extracted from the cstic model.

Specified by:

getDisplayName in interface ClassificationSystemCPQAttributesProvider

Parameters:

csticModel - model of the cstic

cpqAttributes - CPQ attribute container with hybris cstic name

isDebugEnabled - only if true, debug logs will be written

Returns:

cstic name to be displayed

getClassificationAttribute

protected ClassificationAttributeModel getClassificationAttribute(String name,
                                                                  ClassificationSystemVersionModel systemVersion)

Retrieves the hybris classification attribute for a characteristic name (which is part of a CPQ configuraton model).

Parameters:

name - Language independent name of characteristic

systemVersion -

Returns:

Classification attribute

getDisplayValueName

public String getDisplayValueName(CsticValueModel valueModel,
                                  CsticModel csticModel,
                                  ClassificationSystemCPQAttributesContainer cpqAttributes,
                                  boolean isDebugEnabled)

Description copied from interface: ClassificationSystemCPQAttributesProvider

returns the display name for the cstic value. In case a display name is present in the CPQ attribute container it will be returned, otherwise the display name is extracted from the cstic value model.

Specified by:

getDisplayValueName in interface ClassificationSystemCPQAttributesProvider

Parameters:

valueModel - value model of the cstic value

csticModel - model of the cstic

cpqAttributes - CPQ attribute container with hybris cstic value name

isDebugEnabled - only if true, debug logs will be written

Returns:

cstic name to be displayed

getOverviewValueName

public String getOverviewValueName(CsticValueModel valueModel,
                                   CsticModel csticModel,
                                   ClassificationSystemCPQAttributesContainer cpqAttributes,
                                   boolean isDebugEnabled)

Description copied from interface: ClassificationSystemCPQAttributesProvider

returns the display name for the cstic value in context of the overview page. In case a display name is present in the CPQ attribute container it will be returned, otherwise the display name is extracted from the cstic value model.

Specified by:

getOverviewValueName in interface ClassificationSystemCPQAttributesProvider

Parameters:

valueModel - value model of the cstic value

csticModel - model of the cstic

cpqAttributes - CPQ attribute container with hybris cstic value name

isDebugEnabled - only if true, debug logs will be written

Returns:

cstic name to be displayed on the overview page

getValueName

protected String getValueName(CsticValueModel valueModel,
                              CsticModel csticModel,
                              ClassificationSystemCPQAttributesContainer cpqAttributes,
                              boolean isDebugEnabled)

getSystemVersion

protected ClassificationSystemVersionModel getSystemVersion()

Determines the classification system we use for retrieving the hybris classification attributes for CPQ characteristics. Checks the classification systems that are attached to a base store.

If no system is available, null is returned.

If at least one system is available: Returns the first one which contains '300' as part of its name, as this matches the customizing proposal for SAP Integration. '300' stands for class type 300 in ERP, which is typically used for product configuration.

If no system contains '300', the first one found is returned.

NOTE The pattern '300' can also be replaced, in this case override method getClassificationSystemPattern

Returns:

classification system Version model

determineAvailableClassificationSystems

protected void determineAvailableClassificationSystems(List<CatalogModel> catalogs,
                                                       List<ClassificationSystemModel> availableClassificationSystems,
                                                       List<ClassificationSystemModel> availableClassificationSystemsMatchingPattern)

getClassificationSystemSubString

protected String getClassificationSystemSubString()

Returns substring we search for in the available classification systems. The first system which contains this substring will be used to determine hybris attributes for CPQ characteristics names

Returns:

"300"

getBaseStore

protected BaseStoreModel getBaseStore()

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface ClassificationSystemCPQAttributesProvider

Returns:

true only if debug log is enabled for the attribute container

setClassificationService

public void setClassificationService(ClassificationSystemService classificationService)

Parameters:

classificationService - injects the classification service, required to access the hybris classification system

setBaseStoreService

public void setBaseStoreService(BaseStoreService baseStoreService)

Parameters:

baseStoreService - injects the base store service, required to access the hybris classification system

getUiTypeFinder

protected UiTypeFinder getUiTypeFinder()

setUiTypeFinder

public void setUiTypeFinder(UiTypeFinder uiTypeFinder)

Parameters:

uiTypeFinder - characteristic UI type finder

getValueFormatTranslator

protected ValueFormatTranslator getValueFormatTranslator()

setValueFormatTranslator

public void setValueFormatTranslator(ValueFormatTranslator valueFormatTranslator)

Parameters:

valueFormatTranslator - value format translator

getCpqCsticImageFormatMapping

protected CPQImageFormatMapping getCpqCsticImageFormatMapping()

setCpqCsticImageFormatMapping

public void setCpqCsticImageFormatMapping(CPQImageFormatMapping cpqCsticImageFormatMapping)

Parameters:

cpqCsticImageFormatMapping - the cpqCsticImageFormatMapping to set

getCpqCsticValueImageFormatMapping

protected CPQImageFormatMapping getCpqCsticValueImageFormatMapping()

setCpqCsticValueImageFormatMapping

public void setCpqCsticValueImageFormatMapping(CPQImageFormatMapping cpqCsticValueImageFormatMapping)

Parameters:

cpqCsticValueImageFormatMapping - the cpqCsticValueImageFormatMapping to set

getImagePopulator

protected ImagePopulator getImagePopulator()

setImagePopulator

public void setImagePopulator(ImagePopulator imagePopulator)

Parameters:

imagePopulator - the imagePopulator to set

getFlexibleSearchService

protected FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

Parameters:

flexibleSearchService - the flexibleSearchService to set

findClassificationAttributesByCode

protected Collection<ClassificationAttributeModel> findClassificationAttributesByCode(ClassificationSystemVersionModel systemVersion,
                                                                                      String code)

findClassificationAttributeValuesByCodePrefix

protected Collection<ClassificationAttributeValueModel> findClassificationAttributeValuesByCodePrefix(ClassificationSystemVersionModel systemVersion,
                                                                                                      String code)