Package com.broadleafcommerce.catalog.dataexport

Class ProductExportRowProducer

java.lang.Object

com.broadleafcommerce.catalog.dataexport.ProductExportRowProducer

All Implemented Interfaces:

ExportRowProducer<Product>

public class ProductExportRowProducer
extends Object
implements ExportRowProducer<Product>

ExportRowProducer implementation for Product.

Author:

Samarth Dhruva (samarthd)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProductExportRowProducer.Headers	These are headers that the row producer itself will add by default.
static final class	ProductExportRowProducer.LineTypes	These are the different line types that the row producer will assign for the different exported rows.

Constructor Summary

Constructors

Constructor

Description

ProductExportRowProducer(ProductExportRowConverter productExportRowConverter, VariantExportRowConverter variantExportRowConverter, IncludedProductExportRowConverter includedProductExportRowConverter, ProductOptionExportRowConverter productOptionExportRowConverter, CategoryProductExportRowConverter categoryProductExportRowConverter, ProductAssetExportRowConverter productAssetExportRowConverter, AttributeChoiceValueExportRowConverter attributeChoiceValueExportRowConverter, SpecificItemChoiceExportRowConverter specificItemChoiceExportRowConverter, ProductTagExportRowConverter productTagExportRowConverter, VariantService<Variant> variantService, CategoryProductService<CategoryProduct> categoryProductService, ProductAssetService<ProductAsset> productAssetService, ProductTagService<ProductTag> productTagService)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.common.dataexport.service.RowGenerationResponse	generateRows(List<Product> batch, com.broadleafcommerce.common.dataexport.domain.Export export, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Given a list of base domain objects, will produce all of the rows that are needed to represent them and any desired related/embedded domain objects.
protected AttributeChoiceValueExportRowConverter	getAttributeChoiceValueExportRowConverter()
protected CategoryProductExportRowConverter	getCategoryProductExportRowConverter()
protected CategoryProductService<CategoryProduct>	getCategoryProductService()
LinkedHashSet<String>	getHeaders()	Returns the exhaustive set of headers that this row producer may output values for.
protected IncludedProductExportRowConverter	getIncludedProductExportRowConverter()
protected ProductAssetExportRowConverter	getProductAssetExportRowConverter()
protected ProductAssetService<ProductAsset>	getProductAssetService()
protected ProductExportRowConverter	getProductExportRowConverter()
protected ProductOptionExportRowConverter	getProductOptionExportRowConverter()
protected ProductTagExportRowConverter	getProductTagExportRowConverter()
protected ProductTagService<ProductTag>	getProductTagService()
protected SpecificItemChoiceExportRowConverter	getSpecificItemChoiceExportRowConverter()
protected VariantExportRowConverter	getVariantExportRowConverter()
protected VariantService<Variant>	getVariantService()
protected Map<String,List<CategoryProduct>>	readCategoryProductsByProductIdIn(Set<String> productIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<String,List<ProductAsset>>	readProductAssetsByProductIdIn(Set<String> productIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<String,List<ProductTag>>	readProductTagsByProductIdIn(Set<String> productIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<String,List<Variant>>	readVariantsByProductIdIn(Set<String> productIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

ProductExportRowProducer

public ProductExportRowProducer(ProductExportRowConverter productExportRowConverter,
 VariantExportRowConverter variantExportRowConverter,
 IncludedProductExportRowConverter includedProductExportRowConverter,
 ProductOptionExportRowConverter productOptionExportRowConverter,
 CategoryProductExportRowConverter categoryProductExportRowConverter,
 ProductAssetExportRowConverter productAssetExportRowConverter,
 AttributeChoiceValueExportRowConverter attributeChoiceValueExportRowConverter,
 SpecificItemChoiceExportRowConverter specificItemChoiceExportRowConverter,
 ProductTagExportRowConverter productTagExportRowConverter,
 VariantService<Variant> variantService,
 CategoryProductService<CategoryProduct> categoryProductService,
 ProductAssetService<ProductAsset> productAssetService,
 ProductTagService<ProductTag> productTagService)

Method Details

getHeaders

public LinkedHashSet<String> getHeaders()

Description copied from interface: ExportRowProducer

Returns the exhaustive set of headers that this row producer may output values for. These correspond to keys in the RowGenerationResponse.rows produced by #generateRows(List).

This method is called by the ExportProcessor when it needs to report all of the headers it may possibly output.

Specified by:

getHeaders in interface ExportRowProducer<Product>

Returns:

the exhaustive set of headers that this row producer may output values for

generateRows

public com.broadleafcommerce.common.dataexport.service.RowGenerationResponse generateRows(List<Product> batch,
 com.broadleafcommerce.common.dataexport.domain.Export export,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ExportRowProducer

Given a list of base domain objects, will produce all of the rows that are needed to represent them and any desired related/embedded domain objects.

For this reason, the returned list may contain more than one element for each element in the input list.

If any queries need to be performed to retrieve any of the related domains, they are performed by this method.

Specified by:

generateRows in interface ExportRowProducer<Product>

Parameters:

batch - a list of base domain objects to produce rows for

export - the export that is being processed

contextInfo - context information surrounding sandboxing and multitenant state. This should be used to narrow results of any queries that need to be performed to generate the output.

Returns:

a response containing a list of row representations of the base domain objects (and any related domain objects). Details about success/failure are also included.

readVariantsByProductIdIn

protected Map<String,List<Variant>> readVariantsByProductIdIn(Set<String> productIds,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readCategoryProductsByProductIdIn

protected Map<String,List<CategoryProduct>> readCategoryProductsByProductIdIn(Set<String> productIds,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readProductAssetsByProductIdIn

protected Map<String,List<ProductAsset>> readProductAssetsByProductIdIn(Set<String> productIds,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readProductTagsByProductIdIn

protected Map<String,List<ProductTag>> readProductTagsByProductIdIn(Set<String> productIds,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getProductExportRowConverter

protected ProductExportRowConverter getProductExportRowConverter()

getVariantExportRowConverter

protected VariantExportRowConverter getVariantExportRowConverter()

getIncludedProductExportRowConverter

protected IncludedProductExportRowConverter getIncludedProductExportRowConverter()

getProductOptionExportRowConverter

protected ProductOptionExportRowConverter getProductOptionExportRowConverter()

getCategoryProductExportRowConverter

protected CategoryProductExportRowConverter getCategoryProductExportRowConverter()

getProductAssetExportRowConverter

protected ProductAssetExportRowConverter getProductAssetExportRowConverter()

getAttributeChoiceValueExportRowConverter

protected AttributeChoiceValueExportRowConverter getAttributeChoiceValueExportRowConverter()

getSpecificItemChoiceExportRowConverter

protected SpecificItemChoiceExportRowConverter getSpecificItemChoiceExportRowConverter()

getProductTagExportRowConverter

protected ProductTagExportRowConverter getProductTagExportRowConverter()

getVariantService

protected VariantService<Variant> getVariantService()

getCategoryProductService

protected CategoryProductService<CategoryProduct> getCategoryProductService()

getProductAssetService

protected ProductAssetService<ProductAsset> getProductAssetService()

getProductTagService

protected ProductTagService<ProductTag> getProductTagService()