Package com.broadleafcommerce.catalog.service.product.hydration

Class DefaultProductHydrationService

java.lang.Object
com.broadleafcommerce.catalog.service.product.hydration.DefaultProductHydrationService
All Implemented Interfaces:
ProductHydrationService
public class DefaultProductHydrationService extends Object implements ProductHydrationService
Author:
Samarth Dhruva (samarthd)

  • Field Details

    • CHARACTERISTIC_VALUE_TRANSLATION_ENTITY_FIELD_PATTERN

      protected static final Pattern CHARACTERISTIC_VALUE_TRANSLATION_ENTITY_FIELD_PATTERN

  • Constructor Details

  • Method Details

    • hydrate

      public Product hydrate(@NonNull @NonNull Product unhydrated, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ProductHydrationService
      Gets the IDs of items that are referenced by the unhydrated product, finds the referenced items in the data store, and then replaces each item reference on the product with the fully-populated representation of the item.

      The class-level javadoc above describes the references which will be hydrated by default.

      Specified by:
      hydrate in interface ProductHydrationService
      Parameters:
      unhydrated - the unhydrated product whose references should be hydrated
      Returns:
      the product after applying the hydration

    • determineReferences

      protected void determineReferences(Product product, ProductReferences references)
      Traverses through the product and populates the references with each referenced ID.
      Parameters:
      product - the product whose references should be examined
      references - each item that the product makes a reference to will be added to this object

    • determineReferences

      protected void determineReferences(@Nullable DataDrivenEnum dataDrivenEnum, ProductReferences references)

    • determineReferences

      protected void determineReferences(IncludedProduct includedProduct, ProductReferences references)

    • determineReferences

      protected void determineReferences(ProductOption productOption, ProductReferences references)

    • determineReferences

      protected void determineReferences(ItemChoice itemChoice, ProductReferences references)

    • determineReferences

      protected void determineReferences(SpecificItemChoice specificChoice, ProductReferences references)

    • determineReferences

      protected void determineReferences(Characteristic characteristic, ProductReferences references)

    • findReferences

      protected ResolvedProductReferences findReferences(ProductReferences references, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Queries for all of the references in references and returns the results.
      Parameters:
      references - all of the references that need to be found in the data store
      contextInfo - context information surrounding sandboxing and multitenant state
      Returns:
      the results of querying for the referenced items

    • findOptionTemplateReferences

      protected void findOptionTemplateReferences(ProductReferences references, ResolvedProductReferences resolved)
      Collects the ids of all products and variants referenced by an OptionTemplate. These ids are needed to resolve the products and variants that later will be hydrated onto the product option by applyHydration(SpecificItemChoice, ResolvedProductReferences). This method may resolve the appropriate ids once the ResolvedProductReferences.getOptionTemplatesById() have been resolved.
      Parameters:
      references - the product references to update
      resolved - the object containing the list of resolved option templates

    • applyHydration

      @Deprecated protected Product applyHydration(Product product, ResolvedProductReferences foundItems)
      Deprecated.
      Use applyHydration(Product, ResolvedProductReferences, List, ContextInfo)

    • applyHydration

      protected Product applyHydration(Product product, ResolvedProductReferences foundItems, List<Variant> variants, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Traverses through the product and replaces each item reference with the fully-populated representation of the reference as found in foundItems. Also goes through the existing variants for the product and hydrates the ProductOptions with all possible option values.

      If a reference was not found, an error will be logged.

      For ProductCharacteristic hydration, this will set the associated Characteristic on any product characteristic already present on the product. It will also add any missing product characteristics based on the associated BusinessType.

      Default values can be synced via Bulk Operations allowing those changes to go through the typical sandboxing change and approval workflows.

      Parameters:
      product - the product whose references should be hydrated
      foundItems - the results of querying for references in the data store
      variants - all variants for under product
      Returns:
      the given product after hydrating its references

    • hydrateMissingProductCharacteristics

      protected void hydrateMissingProductCharacteristics(Product product, ResolvedProductReferences foundItems, boolean initializeDefaultValues, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Handles hydrating ProductCharacteristics onto a Product. This will look up the Characteristics linked to the product's BusinessType and populate those that are missing.

      This is also responsible for hydrating any configurable product characteristics.

      If the initializeDefaultValues is set, then it will attempt to create ProductCharacteristicValues from the associated CharacteristicValue only if characteristic contains default values and there does not already exist a product characteristic value.

      Parameters:
      product - Product to hydrate
      initializeDefaultValues - whether or not to initialize default Characteristic Values
      foundItems - Related entities referenced by the product to be hydrated onto it.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • getOptionMatchingCharacteristic

      protected Optional<ProductOption> getOptionMatchingCharacteristic(@NonNull @NonNull Product product, @NonNull @NonNull Characteristic characteristic)

    • hydrateConfigurableProductCharacteristics

      protected void hydrateConfigurableProductCharacteristics(Product product, Characteristic characteristic)
      Generates a ProductOption for any newly discovered Characteristic that is configurable or adds any missing AttributeChoiceValues if the Product already has a matching ProductOption from the CharacteristicValues.
      Parameters:
      product - The parent Product.
      characteristic - The discovered Characteristic from which to generate a ProductOption.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • getProductOptionTypeFromCharacteristic

      protected String getProductOptionTypeFromCharacteristic(@NonNull @NonNull Characteristic characteristic)
      Determines ProductOption type to represent the configurable Characteristic.
      Parameters:
      characteristic - The source configurable Characteristic to generate a ProductOption from.
      Returns:
      The option type to use.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0
      See Also:

    • getAttributeChoiceTypeFromCharacteristic

      protected String getAttributeChoiceTypeFromCharacteristic(@NonNull @NonNull Characteristic characteristic)
      Determines the AttributeChoice type from the configurable Characteristic.
      Parameters:
      characteristic - The source configurable Characteristic to generate a ProductOption from.
      Returns:
      The choice type to use.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0
      See Also:

    • setAllowedValueFromCharacteristicValue

      protected void setAllowedValueFromCharacteristicValue(@NonNull @NonNull AttributeChoiceValue allowedValue, @NonNull @NonNull CharacteristicValue characteristicValue, @NonNull @NonNull Characteristic characteristic)
      Extension point for converting complex Characteristic values to strings, which AttributeChoice values require. This is only applicable for configurable Characteristics of type VARIANT_OPTION.
      Parameters:
      allowedValue - The AttributeChoiceValue created to represent the characteristicValue for a configurable Characteristic.
      characteristicValue - The source CharacteristicValue to be converted to a ProductOption's allowedValue.
      characteristic - The parent Characteristic of the characteristicValue.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0
      See Also:

    • setProductPrimaryAssetIfFound

      protected void setProductPrimaryAssetIfFound(Product product, ResolvedProductReferences foundItems)

    • setProductPrimaryCategoryIfFound

      protected void setProductPrimaryCategoryIfFound(Product product, ResolvedProductReferences foundItems)

    • setProductDataDrivenEnumFieldsIfFound

      protected void setProductDataDrivenEnumFieldsIfFound(Product product, ResolvedProductReferences foundItems)

    • applyHydration

      protected void applyHydration(ProductCharacteristic productCharacteristic, ResolvedProductReferences foundItems)

    • applyHydration

      protected void applyHydration(@Nullable DataDrivenEnum dataDrivenEnum, String hydrationTarget, ResolvedProductReferences foundItems)

    • applyHydration

      protected void applyHydration(IncludedProduct includedProduct, ResolvedProductReferences foundItems)

    • applyHydration

      @Deprecated protected ProductOption applyHydration(ProductOption option, ResolvedProductReferences foundItems)
      Deprecated.
      Use applyHydration(ProductOption, ResolvedProductReferences, List)

    • applyHydration

      protected ProductOption applyHydration(ProductOption option, ResolvedProductReferences foundItems, List<Variant> variants)
      Traverses through the option and replaces each item reference with the fully-populated representation of the reference as found in foundItems.

      If a reference was not found, an error will be logged.

      Parameters:
      option - the product option whose references should be hydrated
      foundItems - the results of querying for references in the data store
      Returns:
      the given option after hydrating its references

    • applyHydration

      protected void applyHydration(ItemChoice itemChoice, ResolvedProductReferences foundItems)

    • applyHydration

      protected void applyHydration(SpecificItemChoice specificChoice, ResolvedProductReferences foundItems)

    • hydrate

      public org.springframework.data.domain.Page<Product> hydrate(@NonNull @NonNull org.springframework.data.domain.Page<Product> unhydrated, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ProductHydrationService
      Gets the IDs of items that are referenced by each product, finds the referenced items in the data store, and then replaces each item reference on the product with the fully-populated representation of the item.

      A page of those hydrated products is then returned.

      The class-level javadoc above describes the references which will be hydrated by default.

      Specified by:
      hydrate in interface ProductHydrationService
      Parameters:
      unhydrated - the page of unhydrated products whose references should be hydrated
      contextInfo - context information surrounding sandboxing and multitenant state
      Returns:
      a page of the hydrated products

    • hydratePrimaryAssets

      public org.springframework.data.domain.Page<Product> hydratePrimaryAssets(org.springframework.data.domain.Page<Product> unhydrated, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ProductHydrationService
      Specifically finds and hydrates the Product.primaryAsset of each product in the given page.
      Specified by:
      hydratePrimaryAssets in interface ProductHydrationService
      Parameters:
      unhydrated - the page of unhydrated products whose primary assets should be hydrated
      contextInfo - context information surrounding sandboxing and multitenant state
      Returns:
      a page of the hydrated products

    • hydrate

      public ProductOption hydrate(ProductOption unhydrated, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ProductHydrationService
      Gets the IDs of items that are referenced by the unhydrated option, finds the referenced items in the data store, and then replaces each item reference on the option with the fully-populated representation of the item.

      The class-level javadoc above describes the references which will be hydrated by default.

      Specified by:
      hydrate in interface ProductHydrationService
      Parameters:
      unhydrated - the unhydrated option whose references should be hydrated
      contextInfo - context information surrounding sandboxing and multitenant state
      Returns:
      the option after applying the hydration

    • hydrateCharacteristics

      public <T extends Product> List<T> hydrateCharacteristics(List<T> unhydrated, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Description copied from interface: ProductHydrationService
      Specifically finds and hydrates the Product.characteristics of each product in the given list, including any default values.
      Specified by:
      hydrateCharacteristics in interface ProductHydrationService
      Parameters:
      unhydrated - the list of unhydrated products whose characteristics should be hydrated
      contextInfo - context information surrounding sandboxing and multitenant state
      Returns:
      a list of the hydrated products

    • hydrateDefaultVariant

      protected void hydrateDefaultVariant(ResolvedProductReferences foundItems, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • getProductIds

      protected Set<String> getProductIds(List<Map.Entry<String,String>> partition)

    • getSkus

      protected Set<String> getSkus(List<Map.Entry<String,String>> partition)

    • buildSkuAndProductIdKey

      protected String buildSkuAndProductIdKey(String productId, String sku)

    • getProductService

      protected ProductService<Product> getProductService()

    • getProductAssetService

      protected ProductAssetService<ProductAsset> getProductAssetService()

    • getVariantService

      protected VariantService<Variant> getVariantService()

    • getCategoryService

      protected CategoryService<Category> getCategoryService()

    • getCategoryProductService

      protected CategoryProductService<CategoryProduct> getCategoryProductService()

    • getDataDrivenEnumService

      protected DataDrivenEnumService<DataDrivenEnum> getDataDrivenEnumService()

    • getTypeFactory

      protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

    • getOptionTemplateService

      protected OptionTemplateService<OptionTemplate> getOptionTemplateService()

    • setOptionTemplateService

      @Autowired public void setOptionTemplateService(OptionTemplateService<OptionTemplate> optionTemplateService)

    • getBusinessTypeService

      protected BusinessTypeService<BusinessType> getBusinessTypeService()

    • setBusinessTypeService

      @Autowired public void setBusinessTypeService(BusinessTypeService<BusinessType> businessTypeService)

    • getCharacteristicService

      protected CharacteristicService<Characteristic> getCharacteristicService()

    • setCharacteristicService

      @Autowired public void setCharacteristicService(CharacteristicService<Characteristic> characteristicService)

    • getSkuGenerationService

      protected SkuGenerationService<Variant> getSkuGenerationService()

    • setSkuGenerationService

      @Autowired public void setSkuGenerationService(SkuGenerationService<Variant> skuGenerationService)

    • setTranslationEntityService

      @Autowired public void setTranslationEntityService(com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

    • getTranslationEntityService

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