com.commercetools.sync.products.helpers

Class ProductReferenceResolver

java.lang.Object

com.commercetools.sync.commons.helpers.BaseReferenceResolver<io.sphere.sdk.products.ProductDraft,ProductSyncOptions>

com.commercetools.sync.products.helpers.ProductReferenceResolver

public final class ProductReferenceResolver
extends BaseReferenceResolver<io.sphere.sdk.products.ProductDraft,ProductSyncOptions>

Field Summary

Fields inherited from class com.commercetools.sync.commons.helpers.BaseReferenceResolver

BLANK_ID_VALUE_ON_RESOURCE_IDENTIFIER, options

Constructor Summary

Constructors

Constructor and Description

ProductReferenceResolver(ProductSyncOptions productSyncOptions, ProductTypeService productTypeService, CategoryService categoryService, TypeService typeService, ChannelService channelService, CustomerGroupService customerGroupService, TaxCategoryService taxCategoryService, StateService stateService, ProductService productService) Takes a ProductSyncOptions instance, a ProductTypeService, a CategoryService, a TypeService, a ChannelService, a CustomerGroupService, a TaxCategoryService, a StateService and a ProductService to instantiate a ProductReferenceResolver instance that could be used to resolve the product type, categories, variants, tax category and product state references of product drafts in the CTP project specified in the injected ProductSyncOptions instance.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder>	resolveCategoryReferences(io.sphere.sdk.products.ProductDraftBuilder draftBuilder) Given a ProductDraftBuilder this method attempts to resolve the categories and categoryOrderHints to return a CompletionStage which contains a new instance of the builder with the resolved references.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder>	resolveProductTypeReference(io.sphere.sdk.products.ProductDraftBuilder draftBuilder) Given a ProductDraftBuilder this method attempts to resolve the product type to return a CompletionStage which contains a new instance of the builder with the resolved product type reference.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraft>	resolveReferences(io.sphere.sdk.products.ProductDraft productDraft) Given a ProductDraft this method attempts to resolve the product type, categories, variants, tax category and product state references to return a CompletionStage which contains a new instance of the draft with the resolved references.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder>	resolveStateReference(io.sphere.sdk.products.ProductDraftBuilder draftBuilder) Given a ProductDraftBuilder this method attempts to resolve the state to return a CompletionStage which contains a new instance of the builder with the resolved state reference.
java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder>	resolveTaxCategoryReference(io.sphere.sdk.products.ProductDraftBuilder draftBuilder) Given a ProductDraftBuilder this method attempts to resolve the tax category to return a CompletionStage which contains a new instance of the builder with the resolved tax category reference.

Methods inherited from class com.commercetools.sync.commons.helpers.BaseReferenceResolver

getKeyFromResourceIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductReferenceResolver

public ProductReferenceResolver(@Nonnull
                                ProductSyncOptions productSyncOptions,
                                @Nonnull
                                ProductTypeService productTypeService,
                                @Nonnull
                                CategoryService categoryService,
                                @Nonnull
                                TypeService typeService,
                                @Nonnull
                                ChannelService channelService,
                                @Nonnull
                                CustomerGroupService customerGroupService,
                                @Nonnull
                                TaxCategoryService taxCategoryService,
                                @Nonnull
                                StateService stateService,
                                @Nonnull
                                ProductService productService)

Takes a ProductSyncOptions instance, a ProductTypeService, a CategoryService, a TypeService, a ChannelService, a CustomerGroupService, a TaxCategoryService, a StateService and a ProductService to instantiate a ProductReferenceResolver instance that could be used to resolve the product type, categories, variants, tax category and product state references of product drafts in the CTP project specified in the injected ProductSyncOptions instance.

Parameters:

productSyncOptions - the container of all the options of the sync process including the CTP project client and/or configuration and other sync-specific options.

productTypeService - the service to fetch the product type for reference resolution.

categoryService - the service to fetch the categories for reference resolution.

typeService - the service to fetch the custom types for reference resolution.

channelService - the service to fetch the channels for reference resolution.

customerGroupService - the service to fetch the customer groups for reference resolution.

taxCategoryService - the service to fetch tax categories for reference resolution.

stateService - the service to fetch product states for reference resolution.

productService - the service to fetch products for product reference resolution on reference attributes.

Method Detail

resolveReferences

public java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraft> resolveReferences(@Nonnull
                                                                                                   io.sphere.sdk.products.ProductDraft productDraft)

Given a ProductDraft this method attempts to resolve the product type, categories, variants, tax category and product state references to return a CompletionStage which contains a new instance of the draft with the resolved references. The keys of the references are either taken from the expanded references or taken from the id field of the references.

Specified by:

resolveReferences in class BaseReferenceResolver<io.sphere.sdk.products.ProductDraft,ProductSyncOptions>

Parameters:

productDraft - the productDraft to resolve it's references.

Returns:

a CompletionStage that contains as a result a new productDraft instance with resolved references or, in case an error occurs during reference resolution, a ReferenceResolutionException.

resolveProductTypeReference

@Nonnull
public java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder> resolveProductTypeReference(@Nonnull
                                                                                                                             io.sphere.sdk.products.ProductDraftBuilder draftBuilder)

Given a ProductDraftBuilder this method attempts to resolve the product type to return a CompletionStage which contains a new instance of the builder with the resolved product type reference. The key of the product type reference is either taken from the expanded reference or taken from the value of the id field.

Parameters:

draftBuilder - the productDraft to resolve its product type reference.

Returns:

a CompletionStage that contains as a result a new builder instance with resolved product type reference or, in case an error occurs during reference resolution, a ReferenceResolutionException.

resolveCategoryReferences

@Nonnull
public java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder> resolveCategoryReferences(@Nonnull
                                                                                                                           io.sphere.sdk.products.ProductDraftBuilder draftBuilder)

Given a ProductDraftBuilder this method attempts to resolve the categories and categoryOrderHints to return a CompletionStage which contains a new instance of the builder with the resolved references. The key of the category references is either taken from the expanded references or taken from the value of the id fields.

Parameters:

draftBuilder - the productDraft to resolve its category and categoryOrderHints references.

Returns:

a CompletionStage that contains as a result a new builder instance with resolved references or, in case an error occurs during reference resolution, a ReferenceResolutionException.

resolveTaxCategoryReference

@Nonnull
public java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder> resolveTaxCategoryReference(@Nonnull
                                                                                                                             io.sphere.sdk.products.ProductDraftBuilder draftBuilder)

Given a ProductDraftBuilder this method attempts to resolve the tax category to return a CompletionStage which contains a new instance of the builder with the resolved tax category reference. The key of the tax category reference is either taken from the expanded reference or taken from the value of the id field.

Parameters:

draftBuilder - the productDraft to resolve its tax category reference.

Returns:

a CompletionStage that contains as a result a new builder instance with resolved tax category reference or, in case an error occurs during reference resolution, a ReferenceResolutionException.

resolveStateReference

@Nonnull
public java.util.concurrent.CompletionStage<io.sphere.sdk.products.ProductDraftBuilder> resolveStateReference(@Nonnull
                                                                                                                       io.sphere.sdk.products.ProductDraftBuilder draftBuilder)

Given a ProductDraftBuilder this method attempts to resolve the state to return a CompletionStage which contains a new instance of the builder with the resolved state reference. The key of the state reference is either taken from the expanded reference or taken from the value of the id field.

Parameters:

draftBuilder - the productDraft to resolve its state reference.

Returns:

a CompletionStage that contains as a result a new builder instance with resolved state reference or, in case an error occurs during reference resolution, a ReferenceResolutionException.