de.hybris.platform.bmecat.jalo

Class BMECatCategoryStep

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.cronjob.jalo.GeneratedStep

de.hybris.platform.cronjob.jalo.Step

de.hybris.platform.bmecat.jalo.GeneratedBMECatImportStep

de.hybris.platform.bmecat.jalo.BMECatImportStep

de.hybris.platform.bmecat.jalo.GeneratedBMECatCategoryStep

de.hybris.platform.bmecat.jalo.BMECatCategoryStep

All Implemented Interfaces:

Serializable, Comparable

public class BMECatCategoryStep
extends GeneratedBMECatCategoryStep

Step imports catalog structure

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.bmecat.jalo.BMECatImportStep

BMECatImportStep.DefaultBMECatObjectProcessor

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field and Description
protected static EnumerationValue	CATALOGVERSION
protected static EnumerationValue	DESCRIPTION
protected static EnumerationValue	ID
protected static EnumerationValue	KEYWORDS
protected static EnumerationValue	NAME
protected static EnumerationValue	ORDER
protected static EnumerationValue	PARENT

Fields inherited from class de.hybris.platform.bmecat.jalo.GeneratedBMECatCategoryStep

CATEGORYATTRIBUTEMAPPING, CATEGORYTYPE, DEFAULT_INITIAL_ATTRIBUTES

Fields inherited from class de.hybris.platform.bmecat.jalo.BMECatImportStep

XML_MIME_TYPE, ZIP_MIME_TYPE

Fields inherited from class de.hybris.platform.cronjob.jalo.GeneratedStep

BATCHJOB, CODE, CRONJOBPENDINGSTEPSRELATION_MARKMODIFIED, CRONJOBPENDINGSTEPSRELATION_SRC_ORDERED, CRONJOBPENDINGSTEPSRELATION_TGT_ORDERED, CRONJOBPROCESSEDSTEPSRELATION_MARKMODIFIED, CRONJOBPROCESSEDSTEPSRELATION_SRC_ORDERED, CRONJOBPROCESSEDSTEPSRELATION_TGT_ORDERED, ERRORMODE, PENDINGCRONJOBS, PROCESSEDCRONJOBS, SEQUENCENUMBER, SYNCHRONOUS

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
BMECatCategoryStep()

Method Summary

Modifier and Type	Method and Description
protected boolean	canUndo(CronJob forSchedule) Returns true, if this Step is undoable for the specified CronJob.
protected Category	createCatalogCategory(Item.ItemAttributeMap values)
protected Map	createDefaultMapping(ComposedType targetType) Creates and returns the default category attribute mapping.
protected void	finalizeStep(CronJob cronJob) Methods gives step the possibility to act before the step is finished.
protected Category	getCatalogCategory(BMECatImportCronJob cronJob, String code)
int	getCompletedCount(BMECatImportCronJob cronJob)
int	getTotalToComplete(BMECatImportCronJob cronJob)
protected Item.ItemAttributeMap	getValues(BMECatImportCronJob cronJob, CatalogStructure csValueObject)
protected void	importBMECatObject(Catalog catalogValueObject, AbstractValueObject obj, BMECatImportCronJob cronJob) Called once for each parsed BMECat value object except the Catalog itself, which is passed to BMECatImportStep.initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob)instead.
protected void	initializeBMECatImport(Catalog catalog, BMECatImportCronJob cronJob) Called once per step to pass information about the importing catalog before all object will be processed
protected void	performStep(CronJob forSchedule) Performs BMECatImportCronJob by creating a BMECat 1.2 Sax parser around the media data attached to the cronJob.
void	setNonInitialAttributes(SessionContext ctx, Item item, Item.ItemAttributeMap nonInitialAttributes) Implements default setting of category type and the attribute mapping if these attributes are not specified during step creation.
protected void	undoStep(CronJob forSchedule) Removes all created categories.
void	updateCatalogCategory(BMECatImportCronJob cronJob, Category category, CatalogStructure csValueObject)
void	updateCatalogVersion(BMECatImportCronJob cronJob, CatalogGroupSystem cgsValueObject)

Methods inherited from class de.hybris.platform.bmecat.jalo.GeneratedBMECatCategoryStep

getAllCategoryAttributeMapping, getAllCategoryAttributeMapping, getCategoryType, getCategoryType, getDefaultAttributeModes, setAllCategoryAttributeMapping, setAllCategoryAttributeMapping, setCategoryType, setCategoryType

Methods inherited from class de.hybris.platform.bmecat.jalo.BMECatImportStep

canPerform, createKeyword, createProcessor, customizeImport, getBMECatManager, getCatalogManager, getCompletionStatus, getData, getOrCreateKeywords, getProduct, isAbortable, remove, writeToFile

Methods inherited from class de.hybris.platform.cronjob.jalo.Step

addChange, createItem, debug, error, fatal, getChanges, getChanges, getChanges, getChanges, getFailErrorMode, getIgnoreErrorMode, getMostRecentChange, getNonInitialAttributes, getPauseErrorMode, hasChanges, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, toString, warn

Methods inherited from class de.hybris.platform.cronjob.jalo.GeneratedStep

getBatchJob, getBatchJob, getCode, getCode, getErrorMode, getErrorMode, getSequenceNumber, getSequenceNumber, getSequenceNumberAsPrimitive, getSequenceNumberAsPrimitive, isSynchronous, isSynchronous, isSynchronousAsPrimitive, isSynchronousAsPrimitive, setBatchJob, setBatchJob, setCode, setCode, setErrorMode, setErrorMode, setSequenceNumber, setSequenceNumber, setSequenceNumber, setSequenceNumber, setSynchronous, setSynchronous, setSynchronous, setSynchronous

Methods inherited from class de.hybris.platform.jalo.GenericItem

getInitialProperties

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setOwner, setPermissionsByMap, setTransientObject, setUseTA, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

protected static EnumerationValue ID

ORDER

protected static EnumerationValue ORDER

PARENT

protected static EnumerationValue PARENT

DESCRIPTION

protected static EnumerationValue DESCRIPTION

KEYWORDS

protected static EnumerationValue KEYWORDS

NAME

protected static EnumerationValue NAME

CATALOGVERSION

protected static EnumerationValue CATALOGVERSION

Constructor Detail

BMECatCategoryStep

public BMECatCategoryStep()

Method Detail

setNonInitialAttributes

public void setNonInitialAttributes(SessionContext ctx,
                                    Item item,
                                    Item.ItemAttributeMap nonInitialAttributes)
                             throws JaloBusinessException

Implements default setting of category type and the attribute mapping if these attributes are not specified during step creation.

Overrides:

setNonInitialAttributes in class Step

Parameters:

ctx -

item -

nonInitialAttributes -

Throws:

JaloBusinessException

initializeBMECatImport

protected void initializeBMECatImport(Catalog catalog,
                                      BMECatImportCronJob cronJob)

Description copied from class: BMECatImportStep

Called once per step to pass information about the importing catalog before all object will be processed

Specified by:

initializeBMECatImport in class BMECatImportStep

Parameters:

catalog - object which holds information about the BMECat catalog tag

cronJob - context under which this step is

See Also:

BMECatImportStep.initializeBMECatImport(Catalog, BMECatImportCronJob)

performStep

protected void performStep(CronJob forSchedule)
                    throws AbortCronJobException

Description copied from class: BMECatImportStep

Performs BMECatImportCronJob by creating a BMECat 1.2 Sax parser around the media data attached to the cronJob.

First BMECatImportStep.initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob)is called to pass all informations about the BMECat catalog of the imported document. Afterwards BMECatImportStep.importBMECatObject(de.hybris.platform.bmecat.parser.Catalog, AbstractValueObject, BMECatImportCronJob) is called for any other BMECat data object.

Overrides:

performStep in class BMECatImportStep

Parameters:

forSchedule - the CronJob which is used for execution

Throws:

AbortCronJobException - if the execution is aborted due to an error

See Also:

Step.performStep(de.hybris.platform.cronjob.jalo.CronJob)

importBMECatObject

protected void importBMECatObject(Catalog catalogValueObject,
                                  AbstractValueObject obj,
                                  BMECatImportCronJob cronJob)
                           throws ParseAbortException

Description copied from class: BMECatImportStep

Called once for each parsed BMECat value object except the Catalog itself, which is passed to BMECatImportStep.initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob)instead.

Specified by:

importBMECatObject in class BMECatImportStep

Parameters:

catalogValueObject - the parsed catalog data

obj - the parsed value object

cronJob - the cronJob which executes the current import

Throws:

ParseAbortException

See Also:

BMECatImportStep.importBMECatObject(Catalog, AbstractValueObject, BMECatImportCronJob)

getCompletedCount

public int getCompletedCount(BMECatImportCronJob cronJob)

Overrides:

getCompletedCount in class BMECatImportStep

getTotalToComplete

public int getTotalToComplete(BMECatImportCronJob cronJob)

Overrides:

getTotalToComplete in class BMECatImportStep

canUndo

protected boolean canUndo(CronJob forSchedule)

Description copied from class: Step

Returns true, if this Step is undoable for the specified CronJob. Otherwise false is returned. If one step of a CronJob returns false the whole CronJob will stop the undo process. The default implementation returns false. If your subclass of Step supports the undo-feature, override this method and return true.

Overrides:

canUndo in class Step

Parameters:

forSchedule -

Returns:

true since this step can remove its changes

See Also:

Step.canUndo(de.hybris.platform.cronjob.jalo.CronJob)

undoStep

protected void undoStep(CronJob forSchedule)

Removes all created categories.

Overrides:

undoStep in class BMECatImportStep

Parameters:

forSchedule - the current running cronJob

See Also:

Step.undoStep(de.hybris.platform.cronjob.jalo.CronJob)

updateCatalogVersion

public void updateCatalogVersion(BMECatImportCronJob cronJob,
                                 CatalogGroupSystem cgsValueObject)

updateCatalogCategory

public void updateCatalogCategory(BMECatImportCronJob cronJob,
                                  Category category,
                                  CatalogStructure csValueObject)

createCatalogCategory

protected Category createCatalogCategory(Item.ItemAttributeMap values)

getCatalogCategory

protected Category getCatalogCategory(BMECatImportCronJob cronJob,
                                      String code)

getValues

protected Item.ItemAttributeMap getValues(BMECatImportCronJob cronJob,
                                          CatalogStructure csValueObject)

createDefaultMapping

protected Map createDefaultMapping(ComposedType targetType)

Creates and returns the default category attribute mapping. The keys are EnumerationValues of the CategoryAttributeEnum-EnumerationType. Values are AttributeDescriptors of the specified targetType.

Parameters:

targetType - the composed type which should be used for the category import

Returns:

the default category attribute mapping

finalizeStep

protected void finalizeStep(CronJob cronJob)

Description copied from class: BMECatImportStep

Methods gives step the possibility to act before the step is finished. (e.g. after the parser has parsed the catalog file)

Overrides:

finalizeStep in class BMECatImportStep