io.sphere.sdk.products.attributes

Class DefaultProductAttributeFormatter

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.products.attributes.ProductAttributeConverterBase<String>

io.sphere.sdk.products.attributes.DefaultProductAttributeFormatter

All Implemented Interfaces:

ProductAttributeConverter<String>

public class DefaultProductAttributeFormatter
extends ProductAttributeConverterBase<String>
implements ProductAttributeConverter<String>

Constructor Summary

Constructors

Constructor and Description
DefaultProductAttributeFormatter(Collection<ProductType> productTypes, List<Locale> locales)
DefaultProductAttributeFormatter(ProductTypeLocalRepository productTypes, List<Locale> locales)

Method Summary

Modifier and Type	Method and Description
String	convert(Attribute attribute, Referenceable<ProductType> productType) Formats a product attribute as String.
protected String	convertBoolean(Boolean booleanValue, Attribute attribute, ProductType productType)
protected String	convertBooleanSet(Set<Boolean> booleanSet, Attribute attribute, ProductType productType)
protected String	convertCategoryReference(Reference<Category> categoryReference, Attribute attribute, ProductType productType)
protected String	convertCategoryReferenceSet(Set<Reference<Category>> categoryReferenceSet, Attribute attribute, ProductType productType)
protected String	convertChannelReference(Reference<Channel> channelReference, Attribute attribute, ProductType productType)
protected String	convertChannelReferenceSet(Set<Reference<Channel>> channelReferenceSet, Attribute attribute, ProductType productType)
protected String	convertDate(LocalDate dateValue, Attribute attribute, ProductType productType)
protected String	convertDateSet(Set<LocalDate> dateSet, Attribute attribute, ProductType productType)
protected String	convertDateTime(ZonedDateTime dateTimeValue, Attribute attribute, ProductType productType)
protected String	convertDateTimeSet(Set<ZonedDateTime> zonedDateTimeSet, Attribute attribute, ProductType productType)
protected String	convertDouble(Double doubleValue, Attribute attribute, ProductType productType)
protected String	convertDoubleSet(Set<Double> doubleSet, Attribute attribute, ProductType productType)
protected String	convertEnumValue(EnumValue enumValue, Attribute attribute, ProductType productType)
protected String	convertEnumValueSet(Set<EnumValue> enumValueSet, Attribute attribute, ProductType productType)
protected String	convertInteger(Integer integer, Attribute attribute, ProductType productType)
protected String	convertIntegerSet(Set<Integer> integerSet, Attribute attribute, ProductType productType)
protected String	convertLocalizedEnumValue(LocalizedEnumValue localizedEnumValue, Attribute attribute, ProductType productType)
protected String	convertLocalizedEnumValueSet(Set<LocalizedEnumValue> localizedEnumValueSet, Attribute attribute, ProductType productType)
protected String	convertLocalizedString(LocalizedString localizedString, Attribute attribute, ProductType productType)
protected String	convertLocalizedStringSet(Set<LocalizedString> localizedStringSet, Attribute attribute, ProductType productType)
protected String	convertLong(Long longValue, Attribute attribute, ProductType productType)
protected String	convertLongSet(Set<Long> longSet, Attribute attribute, ProductType productType)
protected String	convertMoney(javax.money.MonetaryAmount moneyValue, Attribute attribute, ProductType productType)
protected String	convertMoneySet(Set<javax.money.MonetaryAmount> monetaryAmountSet, Attribute attribute, ProductType productType)
protected String	convertProductReference(Reference<Product> productReference, Attribute attribute, ProductType productType)
protected String	convertProductReferenceSet(Set<Reference<Product>> referenceSet, Attribute attribute, ProductType productType)
protected String	convertProductTypeReference(Reference<ProductType> productTypeReference, Attribute attribute, ProductType productType)
protected String	convertProductTypeReferenceSet(Set<Reference<ProductType>> productTypeReferenceSet, Attribute attribute, ProductType productType)
protected <X> String	convertReference(Reference<X> reference, ProductType productType)
protected <X> String	convertReferenceSet(Set<Reference<X>> referenceSet, ProductType productType)
protected String	convertString(String stringValue, Attribute attribute, ProductType productType)
protected String	convertStringSet(Set<String> stringSet, Attribute attribute, ProductType productType)
protected String	convertTime(LocalTime time, Attribute attribute, ProductType productType)
protected String	convertTimeSet(Set<LocalTime> timeSet, Attribute attribute, ProductType productType)
Map.Entry<String,String>	createAttributeEntry(Attribute attribute, Referenceable<ProductType> productTypeRef) Creates an entry for a single attribute with translated and formatted label and value by requiring a reference to the product type.
List<Map.Entry<String,String>>	createAttributeEntryList(ProductVariant variant, Reference<ProductType> productType, List<String> attrNamesToShow) Creates a list of attribute translated and formatted labels and values.
String	format(Attribute attribute, Referenceable<ProductType> productType) Formats a product attribute as String, alias of convert(Attribute, Referenceable).
protected List<Locale>	getLocales()
protected Locale	locale()

Methods inherited from class io.sphere.sdk.products.attributes.ProductAttributeConverterBase

convertWithProductType, findProductType, integerAttributes, integerSetAttributes, isInteger, isIntegerSet, isLong, isLongSet, longAttributes, longSetAttributes

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultProductAttributeFormatter

public DefaultProductAttributeFormatter(ProductTypeLocalRepository productTypes,
                                        List<Locale> locales)

DefaultProductAttributeFormatter

public DefaultProductAttributeFormatter(Collection<ProductType> productTypes,
                                        List<Locale> locales)

Method Detail

convert

@Nullable
public String convert(Attribute attribute,
                                Referenceable<ProductType> productType)

Formats a product attribute as String. The product type reference is typically extracted using ProductLike.getProductType() or ProductLike.getProductType().

Specified by:

convert in interface ProductAttributeConverter<String>

Overrides:

convert in class ProductAttributeConverterBase<String>

Parameters:

attribute - the attribute which should be formatted

productType - the reference of the product type of this attribute, it is not necessary to expand the reference

Returns:

formatted attribute or null

format

@Nullable
public String format(Attribute attribute,
                               Referenceable<ProductType> productType)

Formats a product attribute as String, alias of convert(Attribute, Referenceable). The product type reference is typically extracted using ProductLike.getProductType() or ProductLike.getProductType().

Parameters:

attribute - the attribute which should be formatted

productType - the reference of the product type of this attribute, it is not necessary to expand the reference

Returns:

formatted attribute or null

createAttributeEntryList

public List<Map.Entry<String,String>> createAttributeEntryList(ProductVariant variant,
                                                               Reference<ProductType> productType,
                                                               List<String> attrNamesToShow)

Creates a list of attribute translated and formatted labels and values.

Parameters:

variant - the product variant which holds attributes

productType - the product type belonging to the product variant

attrNamesToShow - a list containing the attribute names (the name is used as key) which clafies which attributes are allowed to displayed and also give an order to display them

Returns:

a list of pairs where the key corresponds to a translated label and the value to the formatted value

createAttributeEntry

@Nullable
public Map.Entry<String,String> createAttributeEntry(Attribute attribute,
                                                               Referenceable<ProductType> productTypeRef)

Creates an entry for a single attribute with translated and formatted label and value by requiring a reference to the product type.

Parameters:

attribute - the attribute as data source

productTypeRef - the product type belonging to product containing the attributes

Returns:

row data

locale

protected Locale locale()

getLocales

protected List<Locale> getLocales()

convertReference

@Nullable
protected <X> String convertReference(Reference<X> reference,
                                                ProductType productType)

convertReferenceSet

@Nullable
protected <X> String convertReferenceSet(Set<Reference<X>> referenceSet,
                                                   ProductType productType)

convertStringSet

protected String convertStringSet(Set<String> stringSet,
                                  Attribute attribute,
                                  ProductType productType)

Specified by:

convertStringSet in class ProductAttributeConverterBase<String>

convertProductTypeReferenceSet

protected String convertProductTypeReferenceSet(Set<Reference<ProductType>> productTypeReferenceSet,
                                                Attribute attribute,
                                                ProductType productType)

Specified by:

convertProductTypeReferenceSet in class ProductAttributeConverterBase<String>

convertProductTypeReference

protected String convertProductTypeReference(Reference<ProductType> productTypeReference,
                                             Attribute attribute,
                                             ProductType productType)

Specified by:

convertProductTypeReference in class ProductAttributeConverterBase<String>

convertProductReferenceSet

protected String convertProductReferenceSet(Set<Reference<Product>> referenceSet,
                                            Attribute attribute,
                                            ProductType productType)

Specified by:

convertProductReferenceSet in class ProductAttributeConverterBase<String>

convertProductReference

protected String convertProductReference(Reference<Product> productReference,
                                         Attribute attribute,
                                         ProductType productType)

Specified by:

convertProductReference in class ProductAttributeConverterBase<String>

convertMoneySet

protected String convertMoneySet(Set<javax.money.MonetaryAmount> monetaryAmountSet,
                                 Attribute attribute,
                                 ProductType productType)

Specified by:

convertMoneySet in class ProductAttributeConverterBase<String>

convertLongSet

protected String convertLongSet(Set<Long> longSet,
                                Attribute attribute,
                                ProductType productType)

Specified by:

convertLongSet in class ProductAttributeConverterBase<String>

convertLong

protected String convertLong(Long longValue,
                             Attribute attribute,
                             ProductType productType)

Specified by:

convertLong in class ProductAttributeConverterBase<String>

convertTimeSet

protected String convertTimeSet(Set<LocalTime> timeSet,
                                Attribute attribute,
                                ProductType productType)

Specified by:

convertTimeSet in class ProductAttributeConverterBase<String>

convertTime

protected String convertTime(LocalTime time,
                             Attribute attribute,
                             ProductType productType)

Specified by:

convertTime in class ProductAttributeConverterBase<String>

convertLocalizedStringSet

protected String convertLocalizedStringSet(Set<LocalizedString> localizedStringSet,
                                           Attribute attribute,
                                           ProductType productType)

Specified by:

convertLocalizedStringSet in class ProductAttributeConverterBase<String>

convertLocalizedEnumValueSet

protected String convertLocalizedEnumValueSet(Set<LocalizedEnumValue> localizedEnumValueSet,
                                              Attribute attribute,
                                              ProductType productType)

Specified by:

convertLocalizedEnumValueSet in class ProductAttributeConverterBase<String>

convertIntegerSet

protected String convertIntegerSet(Set<Integer> integerSet,
                                   Attribute attribute,
                                   ProductType productType)

Specified by:

convertIntegerSet in class ProductAttributeConverterBase<String>

convertInteger

protected String convertInteger(Integer integer,
                                Attribute attribute,
                                ProductType productType)

Specified by:

convertInteger in class ProductAttributeConverterBase<String>

convertEnumValueSet

protected String convertEnumValueSet(Set<EnumValue> enumValueSet,
                                     Attribute attribute,
                                     ProductType productType)

Specified by:

convertEnumValueSet in class ProductAttributeConverterBase<String>

convertDoubleSet

protected String convertDoubleSet(Set<Double> doubleSet,
                                  Attribute attribute,
                                  ProductType productType)

Specified by:

convertDoubleSet in class ProductAttributeConverterBase<String>

convertDouble

protected String convertDouble(Double doubleValue,
                               Attribute attribute,
                               ProductType productType)

Specified by:

convertDouble in class ProductAttributeConverterBase<String>

convertDateTimeSet

protected String convertDateTimeSet(Set<ZonedDateTime> zonedDateTimeSet,
                                    Attribute attribute,
                                    ProductType productType)

Specified by:

convertDateTimeSet in class ProductAttributeConverterBase<String>

convertDateSet

protected String convertDateSet(Set<LocalDate> dateSet,
                                Attribute attribute,
                                ProductType productType)

Specified by:

convertDateSet in class ProductAttributeConverterBase<String>

convertChannelReferenceSet

protected String convertChannelReferenceSet(Set<Reference<Channel>> channelReferenceSet,
                                            Attribute attribute,
                                            ProductType productType)

Specified by:

convertChannelReferenceSet in class ProductAttributeConverterBase<String>

convertChannelReference

protected String convertChannelReference(Reference<Channel> channelReference,
                                         Attribute attribute,
                                         ProductType productType)

Specified by:

convertChannelReference in class ProductAttributeConverterBase<String>

convertCategoryReferenceSet

protected String convertCategoryReferenceSet(Set<Reference<Category>> categoryReferenceSet,
                                             Attribute attribute,
                                             ProductType productType)

Specified by:

convertCategoryReferenceSet in class ProductAttributeConverterBase<String>

convertCategoryReference

protected String convertCategoryReference(Reference<Category> categoryReference,
                                          Attribute attribute,
                                          ProductType productType)

Specified by:

convertCategoryReference in class ProductAttributeConverterBase<String>

convertBooleanSet

protected String convertBooleanSet(Set<Boolean> booleanSet,
                                   Attribute attribute,
                                   ProductType productType)

Specified by:

convertBooleanSet in class ProductAttributeConverterBase<String>

convertString

protected String convertString(String stringValue,
                               Attribute attribute,
                               ProductType productType)

Specified by:

convertString in class ProductAttributeConverterBase<String>

convertMoney

protected String convertMoney(javax.money.MonetaryAmount moneyValue,
                              Attribute attribute,
                              ProductType productType)

Specified by:

convertMoney in class ProductAttributeConverterBase<String>

convertLocalizedString

protected String convertLocalizedString(LocalizedString localizedString,
                                        Attribute attribute,
                                        ProductType productType)

Specified by:

convertLocalizedString in class ProductAttributeConverterBase<String>

convertLocalizedEnumValue

protected String convertLocalizedEnumValue(LocalizedEnumValue localizedEnumValue,
                                           Attribute attribute,
                                           ProductType productType)

Specified by:

convertLocalizedEnumValue in class ProductAttributeConverterBase<String>

convertEnumValue

protected String convertEnumValue(EnumValue enumValue,
                                  Attribute attribute,
                                  ProductType productType)

Specified by:

convertEnumValue in class ProductAttributeConverterBase<String>

convertDateTime

protected String convertDateTime(ZonedDateTime dateTimeValue,
                                 Attribute attribute,
                                 ProductType productType)

Specified by:

convertDateTime in class ProductAttributeConverterBase<String>

convertDate

protected String convertDate(LocalDate dateValue,
                             Attribute attribute,
                             ProductType productType)

Specified by:

convertDate in class ProductAttributeConverterBase<String>

convertBoolean

protected String convertBoolean(Boolean booleanValue,
                                Attribute attribute,
                                ProductType productType)

Specified by:

convertBoolean in class ProductAttributeConverterBase<String>