de.hybris.platform.bmecat.jalo

Class BMECatImportStep

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

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedBMECatArticlePriceStep, GeneratedBMECatArticleReferenceStep, GeneratedBMECatArticleStep, GeneratedBMECatArticleToCategoryStep, GeneratedBMECatCatalogStep, GeneratedBMECatCategoryStep, GeneratedBMECatInfoStep, GeneratedBMECatMediaStep

public abstract class BMECatImportStep
extends GeneratedBMECatImportStep

Base class for all import step providing essential functionality such as parsing the BMECat file and calling processing methods. A BMECatObjectProcessor instance processes the xml file and calls initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob) before any data object is read and importBMECatObject(de.hybris.platform.bmecat.parser.Catalog, AbstractValueObject, BMECatImportCronJob) for each BMECat value object provided by the actual parser.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BMECatImportStep.DefaultBMECatObjectProcessor Default implementation of the BMECat object processor.

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	XML_MIME_TYPE
static String	ZIP_MIME_TYPE

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

DEFAULT_INITIAL_ATTRIBUTES

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

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.
Keyword	createKeyword(BMECatImportCronJob cronJob, String keyword, Language lang) Creates an new Keyword for the given CatalogVersion and keyword value.
protected BMECatObjectProcessor	createProcessor(BMECatImportCronJob cronJob) Creates the BMECatObjectProcessor instance which should call initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob) before any data object is read and importBMECatObject(de.hybris.platform.bmecat.parser.Catalog, AbstractValueObject, BMECatImportCronJob) for each BMECat value object provided by the actual parser.
protected void	customizeImport(BMECatParser parser) Overwrite this method to add own TagListener to HEADER, ARTICLE or CATALOG_STRUCTURE.
protected void	finalizeStep(CronJob cronJob) Methods gives step the possibility to act before the step is finished.
protected BMECatManager	getBMECatManager()
protected CatalogManager	getCatalogManager()
int	getCompletedCount(BMECatImportCronJob cronJob)
int	getCompletionStatus(BMECatImportCronJob cronJob) Overwrite to provide a completion status for this currently processed step.
protected InputStream	getData(JobMedia jobMedia) Gets the BMECat xml file which will be parsed
protected Collection	getOrCreateKeywords(BMECatImportCronJob cronJob, Collection keywordValues) Gets or creates Keywords for every keyword value that is passed as parameter
protected Product	getProduct(CatalogVersion catalogVersion, String articleID) Returns a product for a specified catalag version and id
int	getTotalToComplete(BMECatImportCronJob cronJob)
protected abstract void	importBMECatObject(Catalog catalog, AbstractValueObject object, BMECatImportCronJob cronJob) Called once for each parsed BMECat value object except the Catalog itself, which is passed to initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob)instead.
protected abstract void	initializeBMECatImport(Catalog catalog, BMECatImportCronJob cronJob) Called once per step to pass information about the importing catalog before all object will be processed
boolean	isAbortable() Identifies bmecat import steps as abortable by default
protected void	performStep(CronJob cronJob) Performs BMECatImportCronJob by creating a BMECat 1.2 Sax parser around the media data attached to the cronJob.
void	remove(SessionContext ctx) Removes this item.
protected void	undoStep(CronJob cronJob) Removes all keywords created by this step for the specified cronJob.
protected void	writeToFile(File file, InputStream inputStream) Writes an input stream to a file

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

getDefaultAttributeModes

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

addChange, canUndo, createItem, debug, error, fatal, getChanges, getChanges, getChanges, getChanges, getFailErrorMode, getIgnoreErrorMode, getMostRecentChange, getNonInitialAttributes, getPauseErrorMode, hasChanges, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isWarnEnabled, log, setNonInitialAttributes, 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

XML_MIME_TYPE

public static final String XML_MIME_TYPE

See Also:

Constant Field Values

ZIP_MIME_TYPE

public static final String ZIP_MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

BMECatImportStep

public BMECatImportStep()

Method Detail

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if this item could not be removed for some reason

getData

protected InputStream getData(JobMedia jobMedia)

Gets the BMECat xml file which will be parsed

Parameters:

jobMedia - BMECat xml file

Returns:

xml data as input stream

writeToFile

protected void writeToFile(File file,
                           InputStream inputStream)

Writes an input stream to a file

Parameters:

file - file that the content is written to

inputStream - content that will is written

performStep

protected void performStep(CronJob cronJob)
                    throws AbortCronJobException

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

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

Specified by:

performStep in class Step

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)

finalizeStep

protected void finalizeStep(CronJob cronJob)

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

createProcessor

protected BMECatObjectProcessor createProcessor(BMECatImportCronJob cronJob)

Creates the BMECatObjectProcessor instance which should call initializeBMECatImport(de.hybris.platform.bmecat.parser.Catalog, BMECatImportCronJob) before any data object is read and importBMECatObject(de.hybris.platform.bmecat.parser.Catalog, AbstractValueObject, BMECatImportCronJob) for each BMECat value object provided by the actual parser.

Parameters:

cronJob - the cronJob which is currently executed

Returns:

the new BMECatProcessor instance

getCompletionStatus

public int getCompletionStatus(BMECatImportCronJob cronJob)

Overwrite to provide a completion status for this currently processed step.

Returns:

[0,100] if getCompletedCount(BMECatImportCronJob) and getTotalToComplete(BMECatImportCronJob) are implemented, -1 otherwise

getCompletedCount

public int getCompletedCount(BMECatImportCronJob cronJob)

getTotalToComplete

public int getTotalToComplete(BMECatImportCronJob cronJob)

initializeBMECatImport

protected abstract void initializeBMECatImport(Catalog catalog,
                                               BMECatImportCronJob cronJob)
                                        throws ParseAbortException

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

Parameters:

catalog - object which holds information about the BMECat catalog tag

cronJob - context under which this step is

Throws:

ParseAbortException

importBMECatObject

protected abstract void importBMECatObject(Catalog catalog,
                                           AbstractValueObject object,
                                           BMECatImportCronJob cronJob)
                                    throws ParseAbortException

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

Parameters:

catalog - the parsed catalog data

object - the parsed value object

cronJob - the cronJob which executes the current import

Throws:

ParseAbortException

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.

Specified by:

canPerform in class Step

Parameters:

cronJob -

Returns:

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

getBMECatManager

protected BMECatManager getBMECatManager()

getCatalogManager

protected CatalogManager getCatalogManager()

getProduct

protected Product getProduct(CatalogVersion catalogVersion,
                             String articleID)

Returns a product for a specified catalag version and id

Parameters:

catalogVersion -

articleID -

Returns:

the Product

getOrCreateKeywords

protected Collection getOrCreateKeywords(BMECatImportCronJob cronJob,
                                         Collection keywordValues)

Gets or creates Keywords for every keyword value that is passed as parameter

Parameters:

cronJob - context of search/creation which provides catalogversion and keyword type

keywordValues - collection of keyword names (Strings)

Returns:

Collections of Keywords

createKeyword

public Keyword createKeyword(BMECatImportCronJob cronJob,
                             String keyword,
                             Language lang)

Creates an new Keyword for the given CatalogVersion and keyword value.

Parameters:

cronJob - The BMECatImportCronJob in which this step is executed

keyword - The keyword value.

Returns:

The new Keyword for the given CatalogVersion and keyword value.

undoStep

protected void undoStep(CronJob cronJob)

Removes all keywords created by this step for the specified cronJob.

Specified by:

undoStep in class Step

Parameters:

cronJob - context of step execution

See Also:

Step.canUndo(CronJob)

customizeImport

protected void customizeImport(BMECatParser parser)

Overwrite this method to add own TagListener to HEADER, ARTICLE or CATALOG_STRUCTURE.

Parameters:

parser - bmecat parser which process the tags

isAbortable

public boolean isAbortable()

Identifies bmecat import steps as abortable by default

Overrides:

isAbortable in class Step

Returns:

true, if this Step is abortable

See Also:

Step.isAbortable()