de.hybris.platform.cms2.version.converter.impl

Class DefaultCMSVersionToDataConverter

java.lang.Object

de.hybris.platform.cms2.version.converter.impl.DefaultCMSVersionToDataConverter

All Implemented Interfaces:

Converter<ItemModel,java.lang.String>

public class DefaultCMSVersionToDataConverter
extends java.lang.Object
implements Converter<ItemModel,java.lang.String>

Default implementation of ItemModel to String converter for versioning.

Constructor Summary

Constructors

Constructor and Description
DefaultCMSVersionToDataConverter()

Method Summary

Modifier and Type	Method and Description
protected VersionAttributeDescriptor	buildVersionAttributeDescriptor(TypeModel typeModel, AttributeDescriptorModel attribute)
java.lang.String	convert(ItemModel itemModel) Uses the source S object and produces an new instance of T.
protected java.lang.Object	convertAttributeValue(VersionAttributeDescriptor attribute, java.lang.Object attributeValue) Converts an attribute value to a format supported by PayloadSerializer.
protected java.util.Collection<java.lang.Object>	convertCollection(VersionAttributeDescriptor versionAttributeDescriptor, java.util.Collection<java.lang.Object> collection) Converts collection of Object elements.
protected java.util.Map<LanguageModel,java.lang.Object>	convertLocalizedValue(ItemModel itemModel, AttributeDescriptorModel attribute, java.util.function.Function<java.lang.Object,java.lang.Object> converter) Converts the localized attribute value.
protected java.util.function.Function<AttributeDescriptorModel,java.util.Optional<java.lang.Object>>	getAttributeRelatedData(java.util.function.Supplier<java.lang.Object> localizedCollectionGetter, java.util.function.Supplier<java.lang.Object> localizedGetter, java.util.function.Supplier<java.lang.Object> collectionGetter, java.util.function.Supplier<java.lang.Object> simpleGetter) Returns a Function aimed at converting any value described by a AttributeDescriptorModel.
protected java.util.Optional<java.lang.Object>	getAttributeValueFromItem(ItemModel itemModel, AttributeDescriptorModel attribute) Extracts the value from itemModel based on attribute qualifier.
protected java.util.Optional<java.lang.Object>	getAttributeValueFromItem(ItemModel itemModel, AttributeDescriptorModel attribute, java.util.Locale locale) Extracts the value from itemModel based on attribute qualifier and locale.
protected java.util.function.Function<AttributeDescriptorModel,java.util.Optional<java.lang.Object>>	getAttributeValueMapperForItem(ItemModel itemModel) Returns a function that accepts AttributeDescriptorModel and converts attribute value to a format supported by PayloadSerializer.
protected CMSVersionHelper	getCmsVersionHelper()
protected CollectionHelper	getCollectionHelper()
protected CommonI18NService	getCommonI18NService()
protected java.util.Map<java.lang.String,java.lang.Object>	getConvertedAttributeValues(ItemModel itemModel) Returns converted values for ItemModel attributes.
protected AttributeStrategyConverterProvider<VersionAttributeDescriptor>	getConverterProvider()
protected java.util.Map<java.lang.String,java.lang.Object>	getCustomConvertedAttributeValues(ItemModel itemModel) Returns converted values for custom attributes.
protected CustomAttributeStrategyConverterProvider	getCustomConverterProvider()
protected java.util.function.Predicate<AttributeDescriptorModel>	getIsCollectionPredicate()
protected java.util.Map<LanguageModel,java.lang.Object>	getMapOfLanguages(ItemModel itemModel, AttributeDescriptorModel attribute) Method generates the Map of the LanguageModel and the Object that represents the value for the language.
protected ModelService	getModelService()
protected PayloadSerializer	getPayloadSerializer()
protected VersionAttributeDescriptor	getVersionAttribute(AttributeDescriptorModel attribute) Returns VersionAttributeDescriptor based on AttributeDescriptorModel.
protected LocalizedAttributesList	prepareLocalizedValueForSerialization(AttributeDescriptorModel attribute, java.util.Map<LanguageModel,java.lang.Object> localizedValues) Packs the converted localized value inside a class supported by PayloadSerializer.
protected SLDDataContainer.AttributeValue	prepareSimpleValueForSerialization(AttributeDescriptorModel attribute, java.lang.Object convertedValue) Packs the converted value inside a class supported by PayloadSerializer.
void	setCmsVersionHelper(CMSVersionHelper cmsVersionHelper)
void	setCollectionHelper(CollectionHelper collectionHelper)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setConverterProvider(AttributeStrategyConverterProvider<VersionAttributeDescriptor> converterProvider)
void	setCustomConverterProvider(CustomAttributeStrategyConverterProvider customConverterProvider)
void	setIsCollectionPredicate(java.util.function.Predicate<AttributeDescriptorModel> isCollectionPredicate)
void	setModelService(ModelService modelService)
void	setPayloadSerializer(PayloadSerializer payloadSerializer)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCMSVersionToDataConverter

public DefaultCMSVersionToDataConverter()

Method Detail

convert

public java.lang.String convert(ItemModel itemModel)

Description copied from interface: Converter

Uses the source S object and produces an new instance of T.

Specified by:

convert in interface Converter<ItemModel,java.lang.String>

Parameters:

itemModel - the input to be converted.

Returns:

an instance of T, converted from the input source.

getConvertedAttributeValues

protected java.util.Map<java.lang.String,java.lang.Object> getConvertedAttributeValues(ItemModel itemModel)

Returns converted values for ItemModel attributes.

Parameters:

itemModel - the ItemModel to get the list of attributes and values from.

Returns:

the Map of qualifier and a converted value.

getCustomConvertedAttributeValues

protected java.util.Map<java.lang.String,java.lang.Object> getCustomConvertedAttributeValues(ItemModel itemModel)

Returns converted values for custom attributes.

Parameters:

itemModel - the ItemModel to get the custom attribute from.

Returns:

the Map of qualifier and a converted value.

getAttributeRelatedData

protected java.util.function.Function<AttributeDescriptorModel,java.util.Optional<java.lang.Object>> getAttributeRelatedData(java.util.function.Supplier<java.lang.Object> localizedCollectionGetter,
                                                                                                                             java.util.function.Supplier<java.lang.Object> localizedGetter,
                                                                                                                             java.util.function.Supplier<java.lang.Object> collectionGetter,
                                                                                                                             java.util.function.Supplier<java.lang.Object> simpleGetter)

Returns a Function aimed at converting any value described by a AttributeDescriptorModel. This function will execute one of the provided suppliers depending on whether the attribute is localized and/or a collection

Parameters:

localizedCollectionGetter - a Supplier invoked if the attribute is both localized and a collection

localizedGetter - a Supplier invoked if the attribute is localized and not a collection

collectionGetter - a Supplier invoked if the attribute is a collection and not localized

simpleGetter - a Supplier invoked if the attribute is neither localized nor a collection

Returns:

a Function to convert a value

getAttributeValueMapperForItem

protected java.util.function.Function<AttributeDescriptorModel,java.util.Optional<java.lang.Object>> getAttributeValueMapperForItem(ItemModel itemModel)

Returns a function that accepts AttributeDescriptorModel and converts attribute value to a format supported by PayloadSerializer.

Parameters:

itemModel - the ItemModel that contains the value for an attribute.

Returns:

the Function that accepts AttributeDescriptorModel as a parameter and returns converted value wrapped inside a class supported by PayloadSerializer. Can be null.

prepareLocalizedValueForSerialization

protected LocalizedAttributesList prepareLocalizedValueForSerialization(AttributeDescriptorModel attribute,
                                                                        java.util.Map<LanguageModel,java.lang.Object> localizedValues)

Packs the converted localized value inside a class supported by PayloadSerializer.

Parameters:

attribute - the AttributeDescriptorModel describing the metadata of the property.

localizedValues - the Map that contains converted localized value.

Returns:

the LocalizedAttributesList.

prepareSimpleValueForSerialization

protected SLDDataContainer.AttributeValue prepareSimpleValueForSerialization(AttributeDescriptorModel attribute,
                                                                             java.lang.Object convertedValue)

Packs the converted value inside a class supported by PayloadSerializer.

Parameters:

attribute - the AttributeDescriptorModel describing the metadata of the property.

convertedValue - the converted value

Returns:

the SLDDataContainer.AttributeValue.

getVersionAttribute

protected VersionAttributeDescriptor getVersionAttribute(AttributeDescriptorModel attribute)

Returns VersionAttributeDescriptor based on AttributeDescriptorModel. The VersionAttributeDescriptor contains the type of an element that have to be converted. If the AttributeDescriptorModel represents localized collection then the VersionAttributeDescriptor contains the metadata of the localized collection element. If the AttributeDescriptorModel represents localized value then the VersionAttributeDescriptor contains the metadata of the localized value. If the AttributeDescriptorModel represents collection then the VersionAttributeDescriptor contains the metadata of the collection element. If the AttributeDescriptorModel represents simple value then the VersionAttributeDescriptor contains the metadata of the simple value.

Parameters:

attribute - the AttributeDescriptorModel describing the metadata of the property.

Returns:

the VersionAttributeDescriptor describing the metadata of the element represented by AttributeDescriptorModel. Can be null.

buildVersionAttributeDescriptor

protected VersionAttributeDescriptor buildVersionAttributeDescriptor(TypeModel typeModel,
                                                                     AttributeDescriptorModel attribute)

getMapOfLanguages

protected java.util.Map<LanguageModel,java.lang.Object> getMapOfLanguages(ItemModel itemModel,
                                                                          AttributeDescriptorModel attribute)

Method generates the Map of the LanguageModel and the Object that represents the value for the language.

Parameters:

itemModel - the ItemModel to retrieve the localized value from.

attribute - the AttributeDescriptorModel describing the metadata of the property.

Returns:

the Map of the LanguageModel and the Object.

getAttributeValueFromItem

protected java.util.Optional<java.lang.Object> getAttributeValueFromItem(ItemModel itemModel,
                                                                         AttributeDescriptorModel attribute,
                                                                         java.util.Locale locale)

Extracts the value from itemModel based on attribute qualifier and locale.

Parameters:

itemModel - the ItemModel to retrieve the value from.

attribute - the AttributeDescriptorModel describing the metadata of the property.

locale - the Locale

Returns:

the Optional value

getAttributeValueFromItem

protected java.util.Optional<java.lang.Object> getAttributeValueFromItem(ItemModel itemModel,
                                                                         AttributeDescriptorModel attribute)

Extracts the value from itemModel based on attribute qualifier.

Parameters:

itemModel - the ItemModel to retrieve the value from.

attribute - the AttributeDescriptorModel describing the metadata of the property.

Returns:

the Optional value

convertLocalizedValue

protected java.util.Map<LanguageModel,java.lang.Object> convertLocalizedValue(ItemModel itemModel,
                                                                              AttributeDescriptorModel attribute,
                                                                              java.util.function.Function<java.lang.Object,java.lang.Object> converter)

Converts the localized attribute value.

Parameters:

itemModel - the ItemModel to retrieve the localized value from.

attribute - the AttributeDescriptorModel describing the metadata of the property.

converter - the conversion Function that will be applied on each element of the localized value.

Returns:

the Map of LanguageModel and Object where the Object represents the value.

convertCollection

protected java.util.Collection<java.lang.Object> convertCollection(VersionAttributeDescriptor versionAttributeDescriptor,
                                                                   java.util.Collection<java.lang.Object> collection)

Converts collection of Object elements.

Parameters:

versionAttributeDescriptor - the VersionAttributeDescriptor describing the metadata of the collection element.

collection - the Collection that will be converted.

Returns:

Collection of converted elements.

convertAttributeValue

protected java.lang.Object convertAttributeValue(VersionAttributeDescriptor attribute,
                                                 java.lang.Object attributeValue)

Converts an attribute value to a format supported by PayloadSerializer.

Parameters:

attribute - attribute the AttributeDescriptorModel describing the metadata of the property.

attributeValue - the Object representing the value

Returns:

converted value supported by PayloadSerializer.

getPayloadSerializer

protected PayloadSerializer getPayloadSerializer()

setPayloadSerializer

public void setPayloadSerializer(PayloadSerializer payloadSerializer)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getConverterProvider

protected AttributeStrategyConverterProvider<VersionAttributeDescriptor> getConverterProvider()

setConverterProvider

public void setConverterProvider(AttributeStrategyConverterProvider<VersionAttributeDescriptor> converterProvider)

getCustomConverterProvider

protected CustomAttributeStrategyConverterProvider getCustomConverterProvider()

setCustomConverterProvider

public void setCustomConverterProvider(CustomAttributeStrategyConverterProvider customConverterProvider)

getCollectionHelper

protected CollectionHelper getCollectionHelper()

setCollectionHelper

public void setCollectionHelper(CollectionHelper collectionHelper)

getCmsVersionHelper

protected CMSVersionHelper getCmsVersionHelper()

setCmsVersionHelper

public void setCmsVersionHelper(CMSVersionHelper cmsVersionHelper)

getIsCollectionPredicate

protected java.util.function.Predicate<AttributeDescriptorModel> getIsCollectionPredicate()

setIsCollectionPredicate

public void setIsCollectionPredicate(java.util.function.Predicate<AttributeDescriptorModel> isCollectionPredicate)