com.commercetools.sync.producttypes.utils

Class ProductTypeReferenceReplacementUtils

java.lang.Object

com.commercetools.sync.producttypes.utils.ProductTypeReferenceReplacementUtils

public final class ProductTypeReferenceReplacementUtils
extends java.lang.Object

Util class which provides utilities that can be used when syncing resources from a source commercetools project to a target one.

Method Summary

Modifier and Type	Method and Description
static io.sphere.sdk.producttypes.queries.ProductTypeQuery	buildProductTypeQuery() Builds a ProductTypeQuery for fetching products from a source CTP project with an expansion to the ProductType reference of any NestedType Attribute
static io.sphere.sdk.producttypes.queries.ProductTypeQuery	buildProductTypeQuery(int maximumSetDepth) Builds a ProductTypeQuery for fetching products from a source CTP project with an expansion to the ProductType reference of any NestedType Attribute and also any SetType Attribute that has an elementType of NestedType depending on the given maximumSetDepth will provide an expansion for the nestedType of this set depth and all nested types of smaller depths.
static java.util.List<io.sphere.sdk.producttypes.ProductTypeDraft>	replaceProductTypesReferenceIdsWithKeys(java.util.List<io.sphere.sdk.producttypes.ProductType> productTypes) Takes a list of ProductTypes that are supposed to have their productType references (in case it has NestedType or set of NestedType) expanded in order to be able to fetch the keys and replace the reference ids with the corresponding keys and then return a new list of productType drafts with their references containing keys instead of the ids.

Methods inherited from class java.lang.Object

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

Method Detail

replaceProductTypesReferenceIdsWithKeys

@Nonnull
public static java.util.List<io.sphere.sdk.producttypes.ProductTypeDraft> replaceProductTypesReferenceIdsWithKeys(@Nonnull
                                                                                                                           java.util.List<io.sphere.sdk.producttypes.ProductType> productTypes)

Takes a list of ProductTypes that are supposed to have their productType references (in case it has NestedType or set of NestedType) expanded in order to be able to fetch the keys and replace the reference ids with the corresponding keys and then return a new list of productType drafts with their references containing keys instead of the ids.

Note:If some references are not expanded for an attributeDefinition of a productType, the method will throw a ReferenceReplacementException containing the root causes of the exceptions that occurred in any of the supplied productTypes.

Parameters:

productTypes - the list of productTypes to replace the references on and convert to productTypeDrafts.

Returns:

a list of productType drafts with keys instead of ids for references.

buildProductTypeQuery

@Nonnull
public static io.sphere.sdk.producttypes.queries.ProductTypeQuery buildProductTypeQuery()

Builds a ProductTypeQuery for fetching products from a source CTP project with an expansion to the ProductType reference of any NestedType Attribute

Note: Please only use this util if you have nestedType attributes in the productTypes that you will fetch from a source commercetools project. Otherwise, it is more efficient to build the query without expansions, if they are not needed, to avoid unnecessarily bigger payloads fetched from the source project.

Returns:

the query for fetching products from the source CTP project with an expansion to the ProductType reference of any NestedType Attribute.

buildProductTypeQuery

@Nonnull
public static io.sphere.sdk.producttypes.queries.ProductTypeQuery buildProductTypeQuery(int maximumSetDepth)

Builds a ProductTypeQuery for fetching products from a source CTP project with an expansion to the ProductType reference of any NestedType Attribute and also any SetType Attribute that has an elementType of NestedType depending on the given maximumSetDepth will provide an expansion for the nestedType of this set depth and all nested types of smaller depths. For example:

if maximumSetDepth is 0, it means there is no atttribute that is a type of set of nestedType. Therefore, the built query will have the following expansion paths:
attributes[*].type.typeReference

if maximumSetDepth is 1, it means the maximum nesting of sets is set of a NestedType. Therefore, the built query will have the following expansion paths:
attributes[*].type.typeReference, attributes[*].type.elementType.typeReference

if maximumSetDepth is 2, it means the maximum nesting of sets is set of set of a NestedType. Therefore, the built query will have the following expansion paths:
attributes[*].type.typeReference, attributes[*].type.elementType.typeReference, attributes[*].type.elementType.elementType.typeReference

and so on..

Note: Please only use this util if you have nestedType attributes in the productTypes that you will fetch from a source commercetools project. Otherwise, it is more efficient to build the query without expansions, if they are not needed, to avoid unnecessarily bigger payloads fetched from the source project.

Parameters:

maximumSetDepth - defines the maximum nesting of SetType attributes. If there are no setType of NestedType attributes in source productTypes then this number should be 0. If there is an attribute of type setType of a NestedType then this number should be 1. If the maximum nesting is a setType of a setType attribute, then this number should be 2, and so on.

Returns:

the query for fetching productTypes from the source CTP project with all the aforementioned references expanded.