com.commercetools.sync.commons.utils

Class SyncUtils

java.lang.Object

com.commercetools.sync.commons.utils.SyncUtils

public final class SyncUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SyncUtils()

Method Summary

Modifier and Type	Method and Description
static <T> java.util.List<java.util.List<T>>	batchDrafts(java.util.List<T> drafts, int batchSize) Given a list of resource (e.g.
static io.sphere.sdk.products.ProductDraftBuilder	getDraftBuilderFromStagedProduct(io.sphere.sdk.products.Product product) Given a Product this method creates a ProductDraftBuilder based on the staged projection values of the supplied product.
static java.util.List<io.sphere.sdk.categories.CategoryDraft>	replaceCategoriesReferenceIdsWithKeys(java.util.List<io.sphere.sdk.categories.Category> categories) Takes a list of Categories that are supposed to have their custom type and parent category reference 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 category drafts with their references containing keys instead of the ids.
static io.sphere.sdk.products.CategoryOrderHints	replaceCategoryOrderHintCategoryIdsWithKeys(io.sphere.sdk.products.CategoryOrderHints categoryOrderHints, java.util.Set<io.sphere.sdk.models.ResourceIdentifier<io.sphere.sdk.categories.Category>> categoryResourceIdentifiers) Given a CategoryOrderHints instance and a set of Category ResourceIdentifier, this method replaces all the categoryOrderHint ids with the Category keys.
static java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft>	replaceInventoriesReferenceIdsWithKeys(java.util.List<io.sphere.sdk.inventory.InventoryEntry> inventoryEntries) Takes a list of inventoryEntries that are supposed to have their custom type reference 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 inventory entry drafts with their references containing keys instead of the ids.
static io.sphere.sdk.products.ProductDraft	replaceProductDraftCategoryReferenceIdsWithKeys(io.sphere.sdk.products.ProductDraft productDraft) Takes a product draft that is supposed to have its category references expanded in order to be able to fetch the keys and replace the reference ids with the corresponding keys and then return a new product drafts with the references containing keys instead of the ids.
static java.util.List<io.sphere.sdk.products.ProductDraft>	replaceProductDraftsCategoryReferenceIdsWithKeys(java.util.List<io.sphere.sdk.products.ProductDraft> productDrafts) Takes a list of product drafts that are supposed to have their category references 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 product drafts with their references containing keys instead of the ids.
static java.util.List<io.sphere.sdk.products.ProductDraft>	replaceProductsReferenceIdsWithKeys(java.util.List<io.sphere.sdk.products.Product> products) Takes a list of Products that are supposed to have their product type and category references 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 product 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

Constructor Detail

SyncUtils

public SyncUtils()

Method Detail

batchDrafts

public static <T> java.util.List<java.util.List<T>> batchDrafts(@Nonnull
                                                                java.util.List<T> drafts,
                                                                int batchSize)

Given a list of resource (e.g. categories, products, etc..) drafts and a batchSize, this method separates the drafts into batches with the batchSize. Each batch is represented by a List of resources and all the batches are grouped and represented by an List<List> of resources, which is returned by the method.

Type Parameters:

T - the type of the draft resources.

Parameters:

drafts - the list of drafts to split into batches.

batchSize - the size of each batch.

Returns:

a list of lists where each list represents a batch of resources.

replaceCategoriesReferenceIdsWithKeys

@Nonnull
public static java.util.List<io.sphere.sdk.categories.CategoryDraft> replaceCategoriesReferenceIdsWithKeys(@Nonnull
                                                                                                                    java.util.List<io.sphere.sdk.categories.Category> categories)

Takes a list of Categories that are supposed to have their custom type and parent category reference 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 category drafts with their references containing keys instead of the ids. Note that if the references are not expanded for a category, the reference ids will not be replaced with keys and will still have their ids in place.

Parameters:

categories - the categories to replace their reference ids with keys

Returns:

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

replaceInventoriesReferenceIdsWithKeys

@Nonnull
public static java.util.List<io.sphere.sdk.inventory.InventoryEntryDraft> replaceInventoriesReferenceIdsWithKeys(@Nonnull
                                                                                                                          java.util.List<io.sphere.sdk.inventory.InventoryEntry> inventoryEntries)

Takes a list of inventoryEntries that are supposed to have their custom type reference 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 inventory entry drafts with their references containing keys instead of the ids. Note that if the references are not expanded for an inventory entry, the reference ids will not be replaced with keys and will still have their ids in place.

Parameters:

inventoryEntries - the inventory entries to replace their reference ids with keys

Returns:

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

replaceProductsReferenceIdsWithKeys

@Nonnull
public static java.util.List<io.sphere.sdk.products.ProductDraft> replaceProductsReferenceIdsWithKeys(@Nonnull
                                                                                                               java.util.List<io.sphere.sdk.products.Product> products)

Takes a list of Products that are supposed to have their product type and category references 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 product drafts with their references containing keys instead of the ids. Note that if the references are not expanded for a product, the reference ids will not be replaced with keys and will still have their ids in place.

Parameters:

products - the products to replace their reference ids with keys

Returns:

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

replaceProductDraftsCategoryReferenceIdsWithKeys

@Nonnull
public static java.util.List<io.sphere.sdk.products.ProductDraft> replaceProductDraftsCategoryReferenceIdsWithKeys(@Nonnull
                                                                                                                            java.util.List<io.sphere.sdk.products.ProductDraft> productDrafts)

Takes a list of product drafts that are supposed to have their category references 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 product drafts with their references containing keys instead of the ids. Note that if the references are not expanded for a product, the reference ids will not be replaced with keys and will still have their ids in place.

Parameters:

productDrafts - the product drafts to replace their reference ids with keys

Returns:

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

replaceProductDraftCategoryReferenceIdsWithKeys

@Nonnull
public static io.sphere.sdk.products.ProductDraft replaceProductDraftCategoryReferenceIdsWithKeys(@Nonnull
                                                                                                           io.sphere.sdk.products.ProductDraft productDraft)

Takes a product draft that is supposed to have its category references expanded in order to be able to fetch the keys and replace the reference ids with the corresponding keys and then return a new product drafts with the references containing keys instead of the ids. Note that the category references should be expanded for the productDraft, otherwise the reference ids will not be replaced with keys and will still have their ids in place.

Parameters:

productDraft - the product drafts to replace its reference ids with keys

Returns:

a new products draft with keys instead of ids for references.

replaceCategoryOrderHintCategoryIdsWithKeys

@Nonnull
public static io.sphere.sdk.products.CategoryOrderHints replaceCategoryOrderHintCategoryIdsWithKeys(@Nonnull
                                                                                                             io.sphere.sdk.products.CategoryOrderHints categoryOrderHints,
                                                                                                             @Nonnull
                                                                                                             java.util.Set<io.sphere.sdk.models.ResourceIdentifier<io.sphere.sdk.categories.Category>> categoryResourceIdentifiers)

Given a CategoryOrderHints instance and a set of Category ResourceIdentifier, this method replaces all the categoryOrderHint ids with the Category keys. TODO: EITHER TO BE MOVED INTO IT UTILS OR REUSED IN #replaceProductDraftCategoryReferenceIdsWithKeys.

Parameters:

categoryOrderHints - the categoryOrderHints that should have its keys replaced with ids.

categoryResourceIdentifiers - the category resource identifiers which contains the ids and keys of the categories.

Returns:

a new CategoryOrderHints instance with keys replacing the category ids.

getDraftBuilderFromStagedProduct

@Nonnull
public static io.sphere.sdk.products.ProductDraftBuilder getDraftBuilderFromStagedProduct(@Nonnull
                                                                                                   io.sphere.sdk.products.Product product)

Given a Product this method creates a ProductDraftBuilder based on the staged projection values of the supplied product.

Parameters:

product - the product to create a ProductDraftBuilder based on it's staged data.

Returns:

a ProductDraftBuilder based on the staged projection values of the supplied product.