de.hybris.platform.bmecat.jalo

Class BMECatMediaStep

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.GeneratedBMECatMediaStep

de.hybris.platform.bmecat.jalo.BMECatMediaStep

All Implemented Interfaces:

Serializable, Comparable

public class BMECatMediaStep
extends GeneratedBMECatMediaStep

BMECatMediaStep

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
static String	MEDIA_ROOT
static String	MEDIAS_ZIP_FILE
static String	MEDIAS_ZIP_FILE_CHECKED
static String	SEPARATOR

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

CATEGORYMIMEPURPOSEMAPPING, CATEGORYTYPE, DEFAULT_INITIAL_ATTRIBUTES, MEDIATYPE, PRODUCTMIMEPURPOSEMAPPING, PRODUCTTYPE

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
BMECatMediaStep()

Method Summary

Modifier and Type	Method and Description
boolean	canPerform(CronJob cronJob) Tells wether this step is able to perform for the given cronJob or not.
protected boolean	canUndo(CronJob forCronJob) Returns true, if this Step is undoable for the specified CronJob.
protected void	countMimes(BMECatImportCronJob cronJob, Collection mimes)
protected Map	createDefaultCategoryMapping(ComposedType targetType)
protected Map	createDefaultProductMapping(ComposedType targetType)
protected Media	createMedia(BMECatImportCronJob cronJob, Item.ItemAttributeMap values)
protected Media	createMedia(BMECatImportCronJob cronJob, Mime mimeValueObject, ZipFile mimeZipFile)
int	getCompletedCount(BMECatImportCronJob cronJob)
protected ZipFile	getMediasFile(BMECatImportCronJob cronJob)
protected Media	getOrCreateMedia(BMECatImportCronJob cronJob, Mime mimeValueObject, ZipFile mimeZipFile)
int	getTotalToComplete(BMECatImportCronJob cronJob)
protected Item.ItemAttributeMap	getValues(BMECatImportCronJob cronJob, Mime mimeValueObject)
protected void	importBMECatObject(Catalog catalog, AbstractValueObject object, 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	importCategoryMedias(BMECatImportCronJob cronJob, Collection mediaValueObjects, Category category)
protected void	importProductMedias(BMECatImportCronJob cronJob, Collection mediaValueObjects, Product product)
protected void	importSupplierMedias(BMECatImportCronJob cronJob, Collection mediaValueObjects, Company supplier)
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 cronJob) 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) Sets all attributes which could not be set during Item.createItem(SessionContext, ComposedType, ItemAttributeMap).
protected void	undoStep(CronJob forCronJob) Removes the medias create by this step.

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

getAllCategoryMimePurposeMapping, getAllCategoryMimePurposeMapping, getAllProductMimePurposeMapping, getAllProductMimePurposeMapping, getCategoryType, getCategoryType, getDefaultAttributeModes, getMediaType, getMediaType, getProductType, getProductType, setAllCategoryMimePurposeMapping, setAllCategoryMimePurposeMapping, setAllProductMimePurposeMapping, setAllProductMimePurposeMapping, setCategoryType, setCategoryType, setMediaType, setMediaType, setProductType, setProductType

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

createKeyword, createProcessor, customizeImport, finalizeStep, 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

MEDIA_ROOT

public static final String MEDIA_ROOT

See Also:

Constant Field Values

MEDIAS_ZIP_FILE

public static final String MEDIAS_ZIP_FILE

See Also:

Constant Field Values

MEDIAS_ZIP_FILE_CHECKED

public static final String MEDIAS_ZIP_FILE_CHECKED

See Also:

Constant Field Values

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

BMECatMediaStep

public BMECatMediaStep()

Method Detail

setNonInitialAttributes

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

Description copied from class: Item

Sets all attributes which could not be set during Item.createItem(SessionContext, ComposedType, ItemAttributeMap). as default this method just iterates over all attribute mappings and sets the value by invoking Item.setAttribute(SessionContext, String, Object).

Overrides:

setNonInitialAttributes in class Step

Parameters:

ctx - session context with language = NULL

item - the newly created item

nonInitialAttributes - the non-initial attributed obtained via Item.getNonInitialAttributes(SessionContext, ItemAttributeMap)

Throws:

JaloBusinessException

createDefaultProductMapping

protected Map createDefaultProductMapping(ComposedType targetType)

createDefaultCategoryMapping

protected Map createDefaultCategoryMapping(ComposedType targetType)

canUndo

protected boolean canUndo(CronJob forCronJob)

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:

forCronJob - the CronJob which is used for execution

Returns:

true since this step is able to remove its created medias.

See Also:

Step.undoStep(CronJob)

undoStep

protected void undoStep(CronJob forCronJob)

Removes the medias create by this step.

Overrides:

undoStep in class BMECatImportStep

Parameters:

forCronJob - context of step execution

See Also:

Step.canUndo(CronJob)

performStep

protected void performStep(CronJob cronJob)
                    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:

cronJob - the CronJob which is used for execution

Throws:

AbortCronJobException - if the execution is aborted due to an error

See Also:

Step.canPerform(CronJob)

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

getCompletedCount

public int getCompletedCount(BMECatImportCronJob cronJob)

Overrides:

getCompletedCount in class BMECatImportStep

getTotalToComplete

public int getTotalToComplete(BMECatImportCronJob cronJob)

Overrides:

getTotalToComplete in class BMECatImportStep

countMimes

protected void countMimes(BMECatImportCronJob cronJob,
                          Collection mimes)

importBMECatObject

protected void importBMECatObject(Catalog catalog,
                                  AbstractValueObject object,
                                  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:

catalog - the parsed catalog data

object - the parsed value object

cronJob - the cronJob which executes the current import

Throws:

ParseAbortException

getMediasFile

protected ZipFile getMediasFile(BMECatImportCronJob cronJob)

importProductMedias

protected void importProductMedias(BMECatImportCronJob cronJob,
                                   Collection mediaValueObjects,
                                   Product product)

importSupplierMedias

protected void importSupplierMedias(BMECatImportCronJob cronJob,
                                    Collection mediaValueObjects,
                                    Company supplier)

importCategoryMedias

protected void importCategoryMedias(BMECatImportCronJob cronJob,
                                    Collection mediaValueObjects,
                                    Category category)

getValues

protected Item.ItemAttributeMap getValues(BMECatImportCronJob cronJob,
                                          Mime mimeValueObject)

getOrCreateMedia

protected Media getOrCreateMedia(BMECatImportCronJob cronJob,
                                 Mime mimeValueObject,
                                 ZipFile mimeZipFile)

createMedia

protected Media createMedia(BMECatImportCronJob cronJob,
                            Item.ItemAttributeMap values)

createMedia

protected Media createMedia(BMECatImportCronJob cronJob,
                            Mime mimeValueObject,
                            ZipFile mimeZipFile)

canPerform

public boolean canPerform(CronJob cronJob)

Tells wether this step is able to perform for the given cronJob or not.

As default this method returns true.

Overrides:

canPerform in class BMECatImportStep

Parameters:

cronJob -

Returns:

true if this step is able to perform for the given cronJob