Package com.broadleafcommerce.catalog.dataexport.converter

Class ProductExportRowConverter

java.lang.Object

com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter<Product>

com.broadleafcommerce.catalog.dataexport.converter.ProductExportRowConverter

All Implemented Interfaces:

org.springframework.core.convert.converter.Converter<Product,Map<String,String>>

public class ProductExportRowConverter
extends com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter<Product>

Converts a Product to a Map row representation. This does not perform any conversion of related domains such as variants - only the simple resident fields of Product are included.

Author:

Samarth Dhruva (samarthd)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_MAPPING_SEPARATOR	Not a field - this is the separator that will be used to join together a key-value pair from Product.getAttributes().
static final String	ATTRIBUTE_NAME_LABEL_MAPPING_SEPARATOR	Not a field - this is the separator that will be used to join together a attribute to name label pair from Product.getAttributes().
static final String	CHARACTERISTICS_MAPPING_SEPARATOR	Not a field - this is the separator that will be used to join together a key-value pair from Product.getCharacteristics().
static final String	CHARACTERISTICS_PROPERTY_SEPARATOR	Not a field - this is the separator that will be used to join together properties corresponding to a ProductCharacteristic for Product.getCharacteristics().
static final String	FULFILLMENT_FLAT_RATES_MAPPING_SEPARATOR	Not a field - this is the separator that will be used to join together a key-value pair from Product.getFulfillmentFlatRates().
static final String	TERMS_PROPERTY_SEPARATOR	Not a field - this is the separator that will be used to join together properties corresponding to a ProductTerm for Product.getTerms().
static final String	TERMS_PROPERTY_VALUE_SEPARATOR	Not a field - this is the separator that will be used to join together a property-value pair corresponding to a ProductTerm for Product.getTerms().

Constructor Summary

Constructors

Constructor	Description
ProductExportRowConverter(ProductExportSpecification specification, com.fasterxml.jackson.databind.ObjectMapper objectMapper, ToStringConverter<Object> toStringConverter, DimensionsExportRowConverter dimensionsExportRowConverter, WeightExportRowConverter weightExportRowConverter)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	convert(Product source)
protected DimensionsExportRowConverter	getDimensionsExportRowConverter()
LinkedHashSet<String>	getHeaders()
protected String	getMultiValRepresentationOfAttributes(Map<String,Attribute> attributes)
protected String	getMultiValRepresentationOfCharacteristics(Map<String,ProductCharacteristic> characteristics)
protected String	getMultiValRepresentationOfFulfillmentFlatRates(Map<String,FulfillmentFlatRate> flatRates)
protected String	getMultiValRepresentationOfTerms(List<ProductTerm> terms)
protected @NonNull ToStringConverter<Object>	getToStringConverter()
protected WeightExportRowConverter	getWeightExportRowConverter()

Methods inherited from class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter

configureMapper, convertAndNormalize, convertAndNormalize, getMapper, getSpecification, getSpecificationExportModule, normalizeExportDataRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.convert.converter.Converter

andThen

Field Details

ATTRIBUTE_MAPPING_SEPARATOR

public static final String ATTRIBUTE_MAPPING_SEPARATOR

Not a field - this is the separator that will be used to join together a key-value pair from Product.getAttributes().

See Also:

• Constant Field Values

ATTRIBUTE_NAME_LABEL_MAPPING_SEPARATOR

public static final String ATTRIBUTE_NAME_LABEL_MAPPING_SEPARATOR

Not a field - this is the separator that will be used to join together a attribute to name label pair from Product.getAttributes().

See Also:

• Constant Field Values

FULFILLMENT_FLAT_RATES_MAPPING_SEPARATOR

public static final String FULFILLMENT_FLAT_RATES_MAPPING_SEPARATOR

Not a field - this is the separator that will be used to join together a key-value pair from Product.getFulfillmentFlatRates().

See Also:

• Constant Field Values

TERMS_PROPERTY_VALUE_SEPARATOR

public static final String TERMS_PROPERTY_VALUE_SEPARATOR

Not a field - this is the separator that will be used to join together a property-value pair corresponding to a ProductTerm for Product.getTerms().

See Also:

• Constant Field Values

TERMS_PROPERTY_SEPARATOR

public static final String TERMS_PROPERTY_SEPARATOR

Not a field - this is the separator that will be used to join together properties corresponding to a ProductTerm for Product.getTerms().

See Also:

• Constant Field Values

CHARACTERISTICS_MAPPING_SEPARATOR

public static final String CHARACTERISTICS_MAPPING_SEPARATOR

Not a field - this is the separator that will be used to join together a key-value pair from Product.getCharacteristics().

See Also:

• Constant Field Values

CHARACTERISTICS_PROPERTY_SEPARATOR

public static final String CHARACTERISTICS_PROPERTY_SEPARATOR

Not a field - this is the separator that will be used to join together properties corresponding to a ProductCharacteristic for Product.getCharacteristics().

See Also:

• Constant Field Values

Constructor Details

ProductExportRowConverter

public ProductExportRowConverter(ProductExportSpecification specification,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 ToStringConverter<Object> toStringConverter,
 DimensionsExportRowConverter dimensionsExportRowConverter,
 WeightExportRowConverter weightExportRowConverter)

Method Details

getHeaders

public LinkedHashSet<String> getHeaders()

Overrides:

getHeaders in class com.broadleafcommerce.common.dataexport.service.specification.AbstractExportRowConverter<Product>

convert

public Map<String,String> convert(Product source)

getMultiValRepresentationOfAttributes

protected String getMultiValRepresentationOfAttributes(Map<String,Attribute> attributes)

getMultiValRepresentationOfFulfillmentFlatRates

protected String getMultiValRepresentationOfFulfillmentFlatRates(Map<String,FulfillmentFlatRate> flatRates)

getMultiValRepresentationOfTerms

protected String getMultiValRepresentationOfTerms(List<ProductTerm> terms)

getMultiValRepresentationOfCharacteristics

protected String getMultiValRepresentationOfCharacteristics(Map<String,ProductCharacteristic> characteristics)

getToStringConverter

@NonNull
protected @NonNull ToStringConverter<Object> getToStringConverter()

getDimensionsExportRowConverter

protected DimensionsExportRowConverter getDimensionsExportRowConverter()

getWeightExportRowConverter

protected WeightExportRowConverter getWeightExportRowConverter()