Package com.broadleafcommerce.catalog.service.product.consolidation

Class TranslationProductConsolidationContributor

java.lang.Object

com.broadleafcommerce.catalog.service.product.consolidation.ContextualProductConsolidationContributor<ProductTranslation>

com.broadleafcommerce.catalog.service.product.consolidation.TranslationProductConsolidationContributor

All Implemented Interfaces:

ProductConsolidationContributor

public class TranslationProductConsolidationContributor
extends ContextualProductConsolidationContributor<ProductTranslation>

Consolidates Translations into products.

This contributor should run after any other contributors which consolidate translatable data, such as the PrimaryAssetProductConsolidationContributor, VariantProductConsolidationContributor, and @CategoryProductConsolidationContributor.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORDER

Fields inherited from class com.broadleafcommerce.catalog.service.product.consolidation.ContextualProductConsolidationContributor

IGNORE_ARCHIVED_FILTER, typeFactory

Constructor Summary

Constructors

Constructor

Description

TranslationProductConsolidationContributor(com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService, ProductService<Product> productService, VariantService<Variant> variantService, ProductAssetService<ProductAsset> productAssetService, CategoryService<Category> categoryService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected List<String>	getCategoryIds(List<ConsolidatedProduct> products)	Get a list of distinct category ids from the given ConsolidatedProducts.
protected CategoryService<Category>	getCategoryService()
protected List<ProductTranslation>	getObjectsToConsolidate(Set<String> productIds, List<ConsolidatedProduct> products, com.broadleafcommerce.data.tracking.core.tenant.domain.InheritanceLines inheritanceLines, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Retrieve the full list of domain objects of this type to be consolidated into the products.
protected ProductAssetService<ProductAsset>	getProductAssetService()
protected ProductService<Product>	getProductService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
protected List<ProductTranslation>	getTranslations(String entityType, List<String> ids, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.util.MultiValueMap<String,String> productIdsForEntityIds)
protected VariantService<Variant>	getVariantService()
protected Function<ProductTranslation,String>	idGetter()	Defines the function which retrieves the contextId of the domain object in order to recognize it in different contexts.
protected Function<ProductTranslation,String>	productIdGetter()	Defines the function which retrieves the Product ID from the domain object to consolidate, in order to group it with the appropriate product for processing.
protected List<ProductTranslation>	retrieveAllAssetTranslations(List<ConsolidatedProduct> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected List<ProductTranslation>	retrieveAllCategoriesTranslations(List<ConsolidatedProduct> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected List<ProductTranslation>	retrieveAllPrimaryAssetTranslations(List<ConsolidatedProduct> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Retrieves translations for primary ProductAssets.
protected List<ProductTranslation>	retrieveAllProductTranslations(Set<String> productIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected List<ProductTranslation>	retrieveAllVariantsTranslations(List<ConsolidatedProduct> products, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected BiConsumer<ConsolidatedProduct,List<ProductTranslation>>	setter()	Defines the function which should be used to set the domain objects on the consolidated product.
protected void	setTranslations(ConsolidatedProduct consolidatedProduct, List<ProductTranslation> productTranslations)

Methods inherited from class com.broadleafcommerce.catalog.service.product.consolidation.ContextualProductConsolidationContributor

consolidateProducts, consolidateRelations, contextCompositeKey, contextCompositeKey, contextStatesMatch, createOverrideProductForContext, findImplicitMatches, getCloneMapper, getInheritanceLevel, getMostSpecificCatalogId, getProductConsolidationRequest, getRsqlParser, getTypeFactory, ignoreArchived, isInheriting, setListValue, setSingleValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.catalog.service.product.consolidation.ProductConsolidationContributor

shouldConsolidate

Field Details

ORDER

public static final int ORDER

See Also:

• Constant Field Values

Constructor Details

TranslationProductConsolidationContributor

public TranslationProductConsolidationContributor(com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService,
 ProductService<Product> productService,
 VariantService<Variant> variantService,
 ProductAssetService<ProductAsset> productAssetService,
 CategoryService<Category> categoryService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

getObjectsToConsolidate

protected List<ProductTranslation> getObjectsToConsolidate(Set<String> productIds,
 List<ConsolidatedProduct> products,
 com.broadleafcommerce.data.tracking.core.tenant.domain.InheritanceLines inheritanceLines,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from class: ContextualProductConsolidationContributor

Retrieve the full list of domain objects of this type to be consolidated into the products.

Specified by:

getObjectsToConsolidate in class ContextualProductConsolidationContributor<ProductTranslation>

Parameters:

productIds - the IDs of the products to consolidate

products - the products in all explicit context states

inheritanceLines - the catalog inheritance lines top-down from all of the products

context - context information surrounding sandboxing/multitenant state

Returns:

all domain objects of this type to consolidate into the products

retrieveAllProductTranslations

protected List<ProductTranslation> retrieveAllProductTranslations(Set<String> productIds,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

retrieveAllPrimaryAssetTranslations

protected List<ProductTranslation> retrieveAllPrimaryAssetTranslations(List<ConsolidatedProduct> products,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Retrieves translations for primary ProductAssets.

Parameters:

products - the products to get primary asset translations for

context - context surrounding sandboxing and multitenant state

Returns:

the translations for the primary assets

retrieveAllAssetTranslations

protected List<ProductTranslation> retrieveAllAssetTranslations(List<ConsolidatedProduct> products,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

retrieveAllVariantsTranslations

protected List<ProductTranslation> retrieveAllVariantsTranslations(List<ConsolidatedProduct> products,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

retrieveAllCategoriesTranslations

protected List<ProductTranslation> retrieveAllCategoriesTranslations(List<ConsolidatedProduct> products,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getCategoryIds

protected List<String> getCategoryIds(List<ConsolidatedProduct> products)

Get a list of distinct category ids from the given ConsolidatedProducts.

Stream.distinct() is used to avoid fetching category translations with a large batch of the same category ids

Parameters:

products - a list of ConsolidatedProducts to get the category ids from

Returns:

a list of distinct category ids from the given ConsolidatedProducts

getTranslations

protected List<ProductTranslation> getTranslations(String entityType,
 List<String> ids,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 org.springframework.util.MultiValueMap<String,String> productIdsForEntityIds)

setter

protected BiConsumer<ConsolidatedProduct,List<ProductTranslation>> setter()

Description copied from class: ContextualProductConsolidationContributor

Defines the function which should be used to set the domain objects on the consolidated product.

Specified by:

setter in class ContextualProductConsolidationContributor<ProductTranslation>

Returns:

function to set domain objects on the consolidated product

setTranslations

protected void setTranslations(ConsolidatedProduct consolidatedProduct,
 List<ProductTranslation> productTranslations)

productIdGetter

protected Function<ProductTranslation,String> productIdGetter()

Description copied from class: ContextualProductConsolidationContributor

Defines the function which retrieves the Product ID from the domain object to consolidate, in order to group it with the appropriate product for processing.

Specified by:

productIdGetter in class ContextualProductConsolidationContributor<ProductTranslation>

Returns:

function to retrieve Product ID of the domain object

idGetter

protected Function<ProductTranslation,String> idGetter()

Description copied from class: ContextualProductConsolidationContributor

Defines the function which retrieves the contextId of the domain object in order to recognize it in different contexts.

Specified by:

idGetter in class ContextualProductConsolidationContributor<ProductTranslation>

Returns:

function to retrieve contextId of the domain object

getTranslationEntityService

protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()

getProductService

protected ProductService<Product> getProductService()

getVariantService

protected VariantService<Variant> getVariantService()

getProductAssetService

protected ProductAssetService<ProductAsset> getProductAssetService()

getCategoryService

protected CategoryService<Category> getCategoryService()