com.commercetools.sync.categories.helpers

Class CategoryReferenceResolver

java.lang.Object

com.commercetools.sync.commons.helpers.BaseReferenceResolver<D,S>

com.commercetools.sync.commons.helpers.CustomReferenceResolver<io.sphere.sdk.categories.CategoryDraft,io.sphere.sdk.categories.CategoryDraftBuilder,CategorySyncOptions>

com.commercetools.sync.categories.helpers.CategoryReferenceResolver

public final class CategoryReferenceResolver
extends CustomReferenceResolver<io.sphere.sdk.categories.CategoryDraft,io.sphere.sdk.categories.CategoryDraftBuilder,CategorySyncOptions>

Field Summary

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

TYPE_DOES_NOT_EXIST

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

BLANK_ID_VALUE_ON_REFERENCE, BLANK_KEY_VALUE_ON_RESOURCE_IDENTIFIER, options

Constructor Summary

Constructors

Constructor and Description
CategoryReferenceResolver(CategorySyncOptions options, TypeService typeService, CategoryService categoryService) Takes a CategorySyncOptions instance, a CategoryService and TypeService to instantiate a CategoryReferenceResolver instance that could be used to resolve the category drafts in the CTP project specified in the injected CategorySyncOptions instance.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<java.lang.String>	getParentCategoryKey(io.sphere.sdk.categories.CategoryDraft draft)
static java.util.Optional<java.lang.String>	getParentCategoryKey(io.sphere.sdk.categories.CategoryDraftBuilder draftBuilder)
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>>	populateKeyToIdCachesForReferencedKeys(CategoryBatchValidator.ReferencedKeys referencedKeys) Calls the cacheKeysToIds service methods to fetch all the referenced keys (category and type) from the commercetools to populate caches for the reference resolution.
protected java.util.concurrent.CompletionStage<io.sphere.sdk.categories.CategoryDraftBuilder>	resolveCustomTypeReference(io.sphere.sdk.categories.CategoryDraftBuilder draftBuilder) Given a draft of D (e.g.
java.util.concurrent.CompletionStage<io.sphere.sdk.categories.CategoryDraft>	resolveReferences(io.sphere.sdk.categories.CategoryDraft categoryDraft) Given a CategoryDraft this method attempts to resolve the custom type and parent category references to return a CompletionStage which contains a new instance of the draft with the resolved references.

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

resolveCustomTypeReference

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

getIdFromReference, getKeyFromResourceIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryReferenceResolver

public CategoryReferenceResolver(@Nonnull
                                 CategorySyncOptions options,
                                 @Nonnull
                                 TypeService typeService,
                                 @Nonnull
                                 CategoryService categoryService)

Takes a CategorySyncOptions instance, a CategoryService and TypeService to instantiate a CategoryReferenceResolver instance that could be used to resolve the category drafts in the CTP project specified in the injected CategorySyncOptions instance.

Parameters:

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

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

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

Method Detail

resolveReferences

@Nonnull
public java.util.concurrent.CompletionStage<io.sphere.sdk.categories.CategoryDraft> resolveReferences(@Nonnull
                                                                                                               io.sphere.sdk.categories.CategoryDraft categoryDraft)

Given a CategoryDraft this method attempts to resolve the custom type and parent category references to return a CompletionStage which contains a new instance of the draft with the resolved references.

Specified by:

resolveReferences in class BaseReferenceResolver<io.sphere.sdk.categories.CategoryDraft,CategorySyncOptions>

Parameters:

categoryDraft - the categoryDraft to resolve its references.

Returns:

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

resolveCustomTypeReference

@Nonnull
protected java.util.concurrent.CompletionStage<io.sphere.sdk.categories.CategoryDraftBuilder> resolveCustomTypeReference(@Nonnull
                                                                                                                                  io.sphere.sdk.categories.CategoryDraftBuilder draftBuilder)

Description copied from class: CustomReferenceResolver

Given a draft of D (e.g. CategoryDraft) this method attempts to resolve it's custom type reference to return CompletionStage which contains a new instance of the draft with the resolved custom type reference.

The method then tries to fetch the key of the custom type, optimistically from a cache. If the key is is not found, the resultant draft would remain exactly the same as the passed draft (without a custom type reference resolution).

Specified by:

resolveCustomTypeReference in class CustomReferenceResolver<io.sphere.sdk.categories.CategoryDraft,io.sphere.sdk.categories.CategoryDraftBuilder,CategorySyncOptions>

Parameters:

draftBuilder - the draft builder to resolve it's references.

Returns:

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

getParentCategoryKey

@Nonnull
public static java.util.Optional<java.lang.String> getParentCategoryKey(@Nonnull
                                                                                 io.sphere.sdk.categories.CategoryDraftBuilder draftBuilder)
                                                                          throws ReferenceResolutionException

Throws:

ReferenceResolutionException

getParentCategoryKey

@Nonnull
public static java.util.Optional<java.lang.String> getParentCategoryKey(@Nonnull
                                                                                 io.sphere.sdk.categories.CategoryDraft draft)
                                                                          throws ReferenceResolutionException

Throws:

ReferenceResolutionException

populateKeyToIdCachesForReferencedKeys

@Nonnull
public java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> populateKeyToIdCachesForReferencedKeys(@Nonnull
                                                                                                                                                CategoryBatchValidator.ReferencedKeys referencedKeys)

Calls the cacheKeysToIds service methods to fetch all the referenced keys (category and type) from the commercetools to populate caches for the reference resolution.

Note: This method is meant be only used internally by the library to improve performance.

Parameters:

referencedKeys - a wrapper for the category references to fetch and cache the id's for.

Returns:

CompletionStage<Map<String>String>> in which the results of it's completions contains a map of requested references keys -> ids of parent category references.