com.commercetools.sync.categories.helpers

Class CategorySyncStatistics

java.lang.Object

com.commercetools.sync.commons.helpers.BaseSyncStatistics

com.commercetools.sync.categories.helpers.CategorySyncStatistics

public class CategorySyncStatistics
extends BaseSyncStatistics

Field Summary

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

reportMessage

Constructor Summary

Constructors

Constructor and Description
CategorySyncStatistics()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getCategoryKeysWithMissingParents()
java.util.Optional<java.lang.String>	getMissingParentKey(java.lang.String childCategoryKey) Given a childCategoryKey this method, checks in the categoryKeysWithMissingParents if it exists as a child to a missing parent, and returns the key of first found (since a category can have only one parent) missing parent in an optional.
int	getNumberOfCategoriesWithMissingParents() Returns the total number of categories with missing parents.
java.lang.String	getReportMessage() Builds a summary of the category sync statistics instance that looks like the following example:
void	putMissingParentCategoryChildKey(java.lang.String missingParentCategoryKey, java.lang.String childKey) This method checks if there is an entry with the key of the missingParentCategoryKey in the categoryKeysWithMissingParents, if there isn't it creates a new entry with this parent key and as a value a new set containing the childKey.
void	removeChildCategoryKeyFromMissingParentsMap(java.lang.String childCategoryKey) Given a child categoryKey this method removes its occurrences from the map categoryKeysWithMissingParents.
void	setCategoryKeysWithMissingParents(java.util.concurrent.ConcurrentHashMap<java.lang.String,java.util.Set<java.lang.String>> categoryKeysWithMissingParents)

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

calculateProcessingTime, getCreated, getFailed, getLatestBatchHumanReadableProcessingTime, getLatestBatchProcessingTimeInDays, getLatestBatchProcessingTimeInHours, getLatestBatchProcessingTimeInMillis, getLatestBatchProcessingTimeInMinutes, getLatestBatchProcessingTimeInSeconds, getProcessed, getUpdated, incrementCreated, incrementCreated, incrementFailed, incrementFailed, incrementProcessed, incrementProcessed, incrementUpdated, incrementUpdated, startTimer

Methods inherited from class java.lang.Object

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

Constructor Detail

CategorySyncStatistics

public CategorySyncStatistics()

Method Detail

getReportMessage

public java.lang.String getReportMessage()

Builds a summary of the category sync statistics instance that looks like the following example:

"Summary: 2 categories were processed in total (0 created, 0 updated and 0 categories failed to sync)."

Specified by:

getReportMessage in class BaseSyncStatistics

Returns:

a summary message of the category sync statistics instance.

getNumberOfCategoriesWithMissingParents

public int getNumberOfCategoriesWithMissingParents()

Returns the total number of categories with missing parents.

Returns:

the total number of categories with missing parents.

getCategoryKeysWithMissingParents

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getCategoryKeysWithMissingParents()

setCategoryKeysWithMissingParents

public void setCategoryKeysWithMissingParents(@Nonnull
                                              java.util.concurrent.ConcurrentHashMap<java.lang.String,java.util.Set<java.lang.String>> categoryKeysWithMissingParents)

putMissingParentCategoryChildKey

public void putMissingParentCategoryChildKey(@Nonnull
                                             java.lang.String missingParentCategoryKey,
                                             @Nonnull
                                             java.lang.String childKey)

This method checks if there is an entry with the key of the missingParentCategoryKey in the categoryKeysWithMissingParents, if there isn't it creates a new entry with this parent key and as a value a new set containing the childKey. Otherwise, if there is already, it just adds the categoryKey to the existing set.

Parameters:

missingParentCategoryKey - the key of the missing parent.

childKey - the key of the category with a missing parent.

getMissingParentKey

@Nonnull
public java.util.Optional<java.lang.String> getMissingParentKey(@Nonnull
                                                                         java.lang.String childCategoryKey)

Given a childCategoryKey this method, checks in the categoryKeysWithMissingParents if it exists as a child to a missing parent, and returns the key of first found (since a category can have only one parent) missing parent in an optional. Otherwise, it returns an empty optional.

Parameters:

childCategoryKey - key of the category to find it's has a missing parent key.

Returns:

the key of that missing parent in an optional, if it exists. Otherwise, it returns an empty optional.

removeChildCategoryKeyFromMissingParentsMap

public void removeChildCategoryKeyFromMissingParentsMap(@Nonnull
                                                        java.lang.String childCategoryKey)

Given a child categoryKey this method removes its occurrences from the map categoryKeysWithMissingParents.

NOTE: When all the children keys of a missing parent are removed, the value of the map entry will be an empty list. i.e. the entry itself will not be removed. However, this could be investigated whether removing the entry at all when the list is empty will affect the algorithm. TODO: RELATED BUT NOT SAME AS GITHUB ISSUE#77

Parameters:

childCategoryKey - the child category key to remove from categoryKeysWithMissingParents