Package de.hybris.platform.catalog.jalo.synchronization

Class CatalogVersionSyncCopyContext

java.lang.Object

de.hybris.platform.catalog.jalo.synchronization.AbstractItemCopyContext

de.hybris.platform.catalog.jalo.synchronization.GenericCatalogCopyContext

de.hybris.platform.catalog.jalo.synchronization.CatalogVersionSyncCopyContext

public class CatalogVersionSyncCopyContext
extends GenericCatalogCopyContext

Since:

3.1-u6

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.catalog.jalo.synchronization.GenericCatalogCopyContext

GenericCatalogCopyContext.AbstractParentResolver, GenericCatalogCopyContext.ReferenceParentResolver

Field Summary

Fields inherited from class de.hybris.platform.catalog.jalo.synchronization.GenericCatalogCopyContext

LEGACY_MODE_FLAG, PARTIAL_COLLECTION_TRANSLATION_ALLOWED

Fields inherited from class de.hybris.platform.catalog.jalo.synchronization.AbstractItemCopyContext

ctx

Constructor Summary

Constructors

Constructor	Description
CatalogVersionSyncCopyContext(CatalogVersionSyncJob job, CatalogVersionSyncCronJob cronjob, CatalogVersionSyncWorker worker)

Method Summary

Modifier and Type	Method	Description
protected void	afterCopying(Item copy, CatalogItemCopyCreator icc)
protected boolean	canBeTranslatedPartially(AttributeCopyCreator attributeCopyCreator)
protected Item	copy(ItemCopyCreator parent, Item original, Item copyToUpdate, ItemSyncTimestamp itemSyncTimestamp)	Overwritten to lock item to copy.
protected ItemSyncTimestamp	createSyncTimestamp(CatalogVersionSyncCronJob owningCronJob, int currentTurn, Item source, ItemCopyCreator icc)	Creates a new ItemSyncTimestamp based on the current context and parameters.
void	delete(Item original)	Delegates delete to SynchronizationPersistenceAdapter.remove(Object) Throws two kind of exceptions SynchronizationPersistenceException - which is unrecoverable and it is propagated to upper layer RecoverableSynchronizationPersistenceException - which can be temporary issue and after rerun can vanish
protected de.hybris.platform.catalog.jalo.synchronization.GenericCatalogCopyContext.ItemCopyCacheEntry	getCopy(Item source)	Overwritten to use limited item cache besides super type logic.
protected java.util.Set	getCopyCreatorBlacklist(Item original, Item toUpdate)
protected java.util.Map	getCopyCreatorPresetValues(Item original, Item copyToupdate)	Sets fixedly the catalog version attribute for all Products,Categories, Mediasand Keywords.
protected java.util.Set<java.lang.String>	getCopyCreatorWhitelist(Item original, Item toUpdate)	Builds a white list based upon the SyncItemJob.attributeDescriptors set.
protected SyncSchedule	getCurrentSchedule()
protected int	getCurrentTurn()
protected java.util.Set<java.lang.String>	getNonCopyableOneToManyAttributes(Item original, ComposedType composedType, boolean forUpdate)
protected SyncAttributeDescriptorData	getSyncAttributeDescriptorData(AttributeCopyCreator attributeCopyCreator)
protected CatalogVersion	getTargetVersionForQueryCatalogItemCopy(Item sourceItem)
protected CatalogVersionSyncWorker	getWorker()
protected boolean	hasSchedule(CatalogItemCopyCreator icc)
protected boolean	hasSchedule(PK srcPK)
boolean	isFromSourceVersion(Item item)	Returns true if the item is from *this* source version or it is a source version item of a dependantJob (or dependsOnJob)
protected boolean	isPartOf(AttributeDescriptor attributeDescriptor)	Used by AbstractItemCopyContext.splitDescriptors(TypeCopyDescriptor, ComposedType)to determine whether an attribute holds partOf values.
protected boolean	isPotentiallyNonCopyableOneToManyAttribute(AttributeDescriptor attributeDescriptor, boolean forUpdate)
protected boolean	isUntranslatablePartOfItem(AttributeCopyCreator acc, Item original)	Overwritten to switch off translation if configured so in SyncAttributeDescriptorConfig.
protected boolean	mustBeTranslated(AttributeCopyCreator acc, Item original)	Makes sure each catalog items must always be translated.
protected boolean	mustDump(CatalogItemCopyCreator icc)
protected void	writeDumpRecord(CatalogItemCopyCreator icc)
protected void	writeDumpRecord(PK srcPK, PK tgtPK, PK timestampPK, java.util.Set<java.lang.String> pendingAttributes, java.util.Map<PK,PK> parentMappings, boolean isDeadlockVictim)

Methods inherited from class de.hybris.platform.catalog.jalo.synchronization.GenericCatalogCopyContext

addCreationAttribute, afterCreate, beforeCopying, cleanup, collectPartOfItemsToCopy, computeDependentItemResolvers, computeIsCopyOnDemand, computeParentResolvers, copy, copy, copy, copyMediaData, copyPartOfValues, createAttributeCopyCreator, createCreator, finishedCopying, forceCopy, getCatalogKeyAttributesCache, getCatalogVersion, getCatalogVersionAttribute, getCatalogVersionAttributeCache, getContainedCatalogItemTypes, getCopiedItemCache, getCopyCacheHits, getCopyCacheMisses, getCopyCacheSize, getCopyOnDemandCache, getCounterpartItem, getCreationAttributes, getCronjob, getCurrentlyCopying, getDependentItemResolverCache, getDependentItemTypes, getIsCatalogTypeCache, getJob, getNonCatalogItemUniqueAttributes, getNonCatalogKeyAttributesCache, getRootCatalogType, getRootCatalogTypeCache, getRootUniqueItemType, getSourceVersion, getTargetLanguages, getTargetVersion, getUniqueKeyAttributes, initPersistenceAdapter, isCatalogItem, isCatalogItemType, isCopyOnDemand, isCopyOnDemandCatalogItemType, isCurrentlyCopying, isDependentFromSourceVersion, isExclusiveMode, isForceUpdate, isPartialCollectionTranslationEnabledGlobally, isRequiredForCreation, isSavePrevousValues, isStarted, isUntranslatableProductFeature, logSavedValues, mayBeCatalogItemDependent, mayBeCatalogItemDependent, mustBeTranslated, popCurrentlyCopying, processQueryResult, pushCurrentlyCopying, queryCatalogItemCopy, queryCopy, queryExistingSyncTimestamp, queryNonCatalogItemCopy, registerCopy, setCategoryOptions, setCopyCacheHits, setCopyCacheMisses, setCopyCacheSize, setSavePrevousValues, setTargetLanguages, setTimestamp, translate, translateAD, translateItemValue, translateValue, updateSyncTimestamp

Methods inherited from class de.hybris.platform.catalog.jalo.synchronization.AbstractItemCopyContext

allItems, createCopyDescriptor, createSession, debug, debug, error, error, getCatalogManager, getCtx, getFlexibleSearch, getSession, getTypeCopyDescriptor, ignoreAttribute, info, info, isAtomic, isAtomic, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, log, safeToString, splitDescriptors, toItem, toItems, toString, valuesToString, warn, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogVersionSyncCopyContext

public CatalogVersionSyncCopyContext(CatalogVersionSyncJob job,
                                     CatalogVersionSyncCronJob cronjob,
                                     CatalogVersionSyncWorker worker)

Method Detail

getWorker

protected CatalogVersionSyncWorker getWorker()

getCurrentSchedule

protected SyncSchedule getCurrentSchedule()

hasSchedule

protected boolean hasSchedule(CatalogItemCopyCreator icc)

hasSchedule

protected boolean hasSchedule(PK srcPK)

getCurrentTurn

protected int getCurrentTurn()

Specified by:

getCurrentTurn in class GenericCatalogCopyContext

afterCopying

protected void afterCopying(Item copy,
                            CatalogItemCopyCreator icc)

Overrides:

afterCopying in class GenericCatalogCopyContext

mustDump

protected boolean mustDump(CatalogItemCopyCreator icc)

writeDumpRecord

protected void writeDumpRecord(CatalogItemCopyCreator icc)

writeDumpRecord

protected void writeDumpRecord(PK srcPK,
                               PK tgtPK,
                               PK timestampPK,
                               java.util.Set<java.lang.String> pendingAttributes,
                               java.util.Map<PK,PK> parentMappings,
                               boolean isDeadlockVictim)

getCopyCreatorWhitelist

protected java.util.Set<java.lang.String> getCopyCreatorWhitelist(Item original,
                                                                  Item toUpdate)

Builds a white list based upon the SyncItemJob.attributeDescriptors set. Only attributes which belong to this set are copied to the target item.

This applies to catalog items only. Any other item which is copied as partOf value is copied completely.

Overrides:

getCopyCreatorWhitelist in class GenericCatalogCopyContext

getCopyCreatorBlacklist

protected java.util.Set getCopyCreatorBlacklist(Item original,
                                                Item toUpdate)

Overrides:

getCopyCreatorBlacklist in class GenericCatalogCopyContext

getNonCopyableOneToManyAttributes

protected java.util.Set<java.lang.String> getNonCopyableOneToManyAttributes(Item original,
                                                                            ComposedType composedType,
                                                                            boolean forUpdate)

isPotentiallyNonCopyableOneToManyAttribute

protected boolean isPotentiallyNonCopyableOneToManyAttribute(AttributeDescriptor attributeDescriptor,
                                                             boolean forUpdate)

getCopyCreatorPresetValues

protected java.util.Map getCopyCreatorPresetValues(Item original,
                                                   Item copyToupdate)

Description copied from class: GenericCatalogCopyContext

Sets fixedly the catalog version attribute for all Products,Categories, Mediasand Keywords.

Overrides:

getCopyCreatorPresetValues in class GenericCatalogCopyContext

isUntranslatablePartOfItem

protected boolean isUntranslatablePartOfItem(AttributeCopyCreator acc,
                                             Item original)

Overwritten to switch off translation if configured so in SyncAttributeDescriptorConfig.

Overrides:

isUntranslatablePartOfItem in class GenericCatalogCopyContext

mustBeTranslated

protected boolean mustBeTranslated(AttributeCopyCreator acc,
                                   Item original)

Description copied from class: GenericCatalogCopyContext

Makes sure each catalog items must always be translated. This way all references to catalog items which do not exist in the target catalog are delayed until they become copied or the copy process ends.

Overrides:

mustBeTranslated in class GenericCatalogCopyContext

See Also:

ItemCopyContext.mustBeTranslated(de.hybris.platform.catalog.jalo.copy.AttributeCopyCreator, de.hybris.platform.jalo.Item)

canBeTranslatedPartially

protected boolean canBeTranslatedPartially(AttributeCopyCreator attributeCopyCreator)

Overrides:

canBeTranslatedPartially in class GenericCatalogCopyContext

isPartOf

protected boolean isPartOf(AttributeDescriptor attributeDescriptor)

Description copied from class: AbstractItemCopyContext

Used by AbstractItemCopyContext.splitDescriptors(TypeCopyDescriptor, ComposedType)to determine whether an attribute holds partOf values. These values are always copied (created or translated if already existing) when the original item is being copied.

Overrides:

isPartOf in class AbstractItemCopyContext

getSyncAttributeDescriptorData

protected SyncAttributeDescriptorData getSyncAttributeDescriptorData(AttributeCopyCreator attributeCopyCreator)

getCopy

protected de.hybris.platform.catalog.jalo.synchronization.GenericCatalogCopyContext.ItemCopyCacheEntry getCopy(Item source)

Overwritten to use limited item cache besides super type logic.

Overrides:

getCopy in class GenericCatalogCopyContext

createSyncTimestamp

protected ItemSyncTimestamp createSyncTimestamp(CatalogVersionSyncCronJob owningCronJob,
                                                int currentTurn,
                                                Item source,
                                                ItemCopyCreator icc)

Description copied from class: GenericCatalogCopyContext

Creates a new ItemSyncTimestamp based on the current context and parameters.

Overrides:

createSyncTimestamp in class GenericCatalogCopyContext

delete

public void delete(Item original)
            throws SynchronizationPersistenceException,
                   RecoverableSynchronizationPersistenceException

Delegates delete to SynchronizationPersistenceAdapter.remove(Object) Throws two kind of exceptions

• SynchronizationPersistenceException - which is unrecoverable and it is propagated to upper layer
• RecoverableSynchronizationPersistenceException - which can be temporary issue and after rerun can vanish

Throws:

SynchronizationPersistenceException

RecoverableSynchronizationPersistenceException

copy

protected Item copy(ItemCopyCreator parent,
                    Item original,
                    Item copyToUpdate,
                    ItemSyncTimestamp itemSyncTimestamp)

Overwritten to lock item to copy. We don't want multiple workers to copy the same item!

Overrides:

copy in class GenericCatalogCopyContext

isFromSourceVersion

public boolean isFromSourceVersion(Item item)
                            throws JaloInvalidParameterException

Returns true if the item is from *this* source version or it is a source version item of a dependantJob (or dependsOnJob)

Overrides:

isFromSourceVersion in class GenericCatalogCopyContext

Parameters:

item - the item to check

Throws:

JaloInvalidParameterException - if the item is no catalog item

getTargetVersionForQueryCatalogItemCopy

protected CatalogVersion getTargetVersionForQueryCatalogItemCopy(Item sourceItem)

Overrides:

getTargetVersionForQueryCatalogItemCopy in class GenericCatalogCopyContext