de.hybris.platform.servicelayer.model

Class ItemModelContextImpl

java.lang.Object

de.hybris.platform.servicelayer.model.ItemModelContextImpl

All Implemented Interfaces:

ItemModelContext, ItemModelInternalContext, Serializable

public class ItemModelContextImpl
extends Object
implements ItemModelInternalContext, Serializable

Default implementation for ItemModelContext.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	afterCreate(LocaleProvider locProvider, AttributeProvider attrProvider, DynamicAttributesProvider dynProvider, PK pk, long persistenceVersion, String typeCode)
void	afterReload(long persistenceVersion)
void	afterUpdate(long persistenceVersion)
void	beforeAttach(LocaleProvider localeProvider)
boolean	equals(Object obj)
boolean	exists() Checks if the model is still valid.
PK	generateNewPK() Generate the new PK and assigns it to the current model.
AttributeProvider	getAttributeProvider()
Map<String,LocMap<Locale,Object>>	getCombinedLocalizedValuesMap()
protected Locale	getCurrentLocale()
Set<String>	getDirtyAttributes() Returns all changed attributes.
Map<Locale,Set<String>>	getDirtyLocalizedAttributes() Returns all changed localized attributes with the locale.
DynamicAttributesProvider	getDynamicAttributesProvider()
<T> T	getDynamicValue(AbstractItemModel model, String attribute) Retrieves the dynamic value of the attribute.
protected FetchStrategy	getFetchStrategy()
String	getItemType() Retrieves the item type of the model.
LocaleProvider	getLocaleProvider(boolean required)
<T> T	getLocalizedDynamicValue(AbstractItemModel model, String attribute, Locale loc) Retrieves the dynamic value of the attribute with the local.
<T> T	getLocalizedRelationValue(String key, Locale locale) Retrieves the current value of the specific attribute with the locale.
<T> T	getLocalizedValue(String key, Locale locale) Retrieves the localized value of the key.
protected Object	getLocalizedWithFallback(Map<Locale,Object> attrLocMap, String qualifier, Locale dataLocale, boolean keepOriginals, boolean isRelationAttribute)
PK	getNewPK() Returns the newPK assigned to the current model
<T> T	getOriginalValue(String key) Retrieves the original loaded value of the attribute.
<T> T	getOriginalValue(String key, Locale loc) Retrieves the original loaded value of the localized attribute with the locale.
protected <T> T	getOrLoadLocalized(Map<Locale,Object> locMap, String qualifier, Locale dataLoc, boolean keepAsOriginal)
PersistenceObject	getPersistenceSource()
long	getPersistenceVersion() Retrieves the persistence version of the model.
PK	getPK() Retrieves the pk of the model.
<T> T	getPropertyValue(String attribute) Returns a value of a property with given name.
Object	getRawPropertyValue(String qualifier)
SerializationStrategy	getSerializationStrategy()
Object	getSource() Retrieves the item of the model.
String	getTenantId() Retrieves the tenant id of the model.
<T> T	getValue(String key, T currentValue) Retrieves the value of the key.
ModelValueHistory	getValueHistory()
int	hashCode(AbstractItemModel itemModel) Calculates the hash code of the model.
boolean	isDirty() Checks if the model has been modified.
boolean	isDirty(String attribute) Checks if the specific attribute has been changed.
boolean	isDirty(String attribute, Locale loc) Checks if the specific localized attribute has been changed with the locale.
boolean	isDynamicAttribute(String attributeName) Returns information whether given attribute is dynamic or not
boolean	isLoaded(String attribute) Checks if the specific attribute has been loaded from the database.
boolean	isLoaded(String attribute, Locale loc) Checks if the specific localized attribute has been loaded with the locale from the database.
boolean	isNew() Checks if the model is a new model.
boolean	isRemoved() Checks if the model has been removed from the database.
boolean	isUpToDate() Checks if the model is still up to date with.
protected <T> T	loadLocalized(Map<Locale,Object> locMap, String qualifier, Locale dataLoc, boolean keepAsOriginal)
protected <T> T	loadLocalized(Map<Locale,Object> locMap, String qualifier, Locale dataLoc, boolean keepAsOriginal, boolean resetDirty)
Object	loadOriginalValue(String attribute) Returns the original value for the given attribute
Object	loadOriginalValue(String attribute, Locale locale) Returns the original localized value for the given attribute
protected Object	loadUnlocalizedAttribute(String key, boolean keepAsOriginalValue, boolean resetDirty)
protected void	markDirty(String attribute)
protected void	markDirty(String attribute, Locale dataLocale)
void	setAttributeProvider(AttributeProvider attributeProvider)
void	setDynamicAttributesProvider(DynamicAttributesProvider attributeProvider)
<T> void	setDynamicValue(AbstractItemModel model, String attribute, T value) Sets the dynamic value of the attribute.
void	setFetchStrategy(FetchStrategy fetchStrategy)
void	setLocaleProvider(LocaleProvider localeProvider)
<T> void	setLocalizedDynamicValue(AbstractItemModel model, String attribute, Locale loc, T value) Sets the dynamic value of the attribute under the locale.
<T> void	setLocalizedValue(String qualifier, Locale locale, T value) Sets the new value for the specific attribute with the locale.
<T> void	setPropertyValue(String attribute, T value) Allows to set a value of a property with given name.
void	setRawPropertyValue(String qualifier, Object value)
void	setSerializationStrategy(SerializationStrategy strategy)
<T> T	setValue(String key, T newValue) Sets the new value for the specific attribute.
protected void	throwLoadingError(String qualifier)
protected void	throwLoadingError(String qualifier, Locale dataLocale)
protected Locale	toDataLocale(Locale locale)
Object	writeReplace(Object model) YXX

Methods inherited from class java.lang.Object

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

Method Detail

hashCode

public int hashCode(AbstractItemModel itemModel)

Description copied from interface: ItemModelInternalContext

Calculates the hash code of the model.

Specified by:

hashCode in interface ItemModelInternalContext

Returns:

the hash code value

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getValueHistory

public ModelValueHistory getValueHistory()

isDynamicAttribute

public boolean isDynamicAttribute(String attributeName)

Description copied from interface: ItemModelInternalContext

Returns information whether given attribute is dynamic or not

Specified by:

isDynamicAttribute in interface ItemModelInternalContext

Parameters:

attributeName - attribute name

Returns:

true if attribute is dynamic, false otherwise

writeReplace

public Object writeReplace(Object model)
                    throws ObjectStreamException

Description copied from interface: ItemModelInternalContext

YXX

Specified by:

writeReplace in interface ItemModelInternalContext

Throws:

ObjectStreamException

getPK

public PK getPK()

Description copied from interface: ItemModelContext

Retrieves the pk of the model.

Specified by:

getPK in interface ItemModelContext

getItemType

public String getItemType()

Description copied from interface: ItemModelContext

Retrieves the item type of the model.

Specified by:

getItemType in interface ItemModelContext

getPersistenceVersion

public long getPersistenceVersion()

Description copied from interface: ItemModelContext

Retrieves the persistence version of the model.

Specified by:

getPersistenceVersion in interface ItemModelContext

getSource

public Object getSource()

Description copied from interface: ItemModelContext

Retrieves the item of the model.

Specified by:

getSource in interface ItemModelContext

Returns:

the behind scene jalo item.

getPersistenceSource

public PersistenceObject getPersistenceSource()

isDirty

public boolean isDirty()

Description copied from interface: ItemModelContext

Checks if the model has been modified.

Specified by:

isDirty in interface ItemModelContext

Returns:

true if the model has been modified, false otherwise

exists

public boolean exists()

Description copied from interface: ItemModelContext

Checks if the model is still valid. NOTE: if the model is a new one, this method must return false, because it is not persisted in the database yet.

Specified by:

exists in interface ItemModelContext

Returns:

true if it is valid, false otherwise.

isRemoved

public boolean isRemoved()

Description copied from interface: ItemModelContext

Checks if the model has been removed from the database. NOTE: if the model is a new one, this method must return false, because a new model cannot be removed.

Specified by:

isRemoved in interface ItemModelContext

Returns:

true if removed, false otherwise.

isUpToDate

public boolean isUpToDate()

Description copied from interface: ItemModelContext

Checks if the model is still up to date with.

This method must return false under one of these situations:
• the model is new,
• the model has been removed,
• the model has been modified, or
• there is newer version persisted in the database.

Specified by:

isUpToDate in interface ItemModelContext

Returns:

true if it is up to date, false otherwise.

isNew

public boolean isNew()

Description copied from interface: ItemModelContext

Checks if the model is a new model. That means it is not persisted in the database.

Specified by:

isNew in interface ItemModelContext

Returns:

true if it is new, false otherwise.

getValue

public <T> T getValue(String key,
                      T currentValue)

Retrieves the value of the key. NOTE: the value will be fetched only if it is neither set nor loaded. For example, the method getCode() won't fetch the "code" attribute from the database if the setCode() has been called before.

Specified by:

getValue in interface ItemModelInternalContext

Returns:

the current value.

getPropertyValue

public <T> T getPropertyValue(String attribute)

Description copied from interface: ItemModelInternalContext

Returns a value of a property with given name.

Specified by:

getPropertyValue in interface ItemModelInternalContext

Parameters:

attribute - name

Returns:

value of property with given name

setPropertyValue

public <T> void setPropertyValue(String attribute,
                                 T value)

Description copied from interface: ItemModelInternalContext

Allows to set a value of a property with given name.

Specified by:

setPropertyValue in interface ItemModelInternalContext

Parameters:

attribute - name

value - value to set

getRawPropertyValue

public Object getRawPropertyValue(String qualifier)

setRawPropertyValue

public void setRawPropertyValue(String qualifier,
                                Object value)

loadUnlocalizedAttribute

protected Object loadUnlocalizedAttribute(String key,
                                          boolean keepAsOriginalValue,
                                          boolean resetDirty)

setValue

public <T> T setValue(String key,
                      T newValue)

Description copied from interface: ItemModelInternalContext

Sets the new value for the specific attribute.

Specified by:

setValue in interface ItemModelInternalContext

Returns:

the new value of the attribute.

getDirtyAttributes

public Set<String> getDirtyAttributes()

Description copied from interface: ItemModelContext

Returns all changed attributes.

Specified by:

getDirtyAttributes in interface ItemModelContext

Returns:

the set of all changed attributes.

isDirty

public boolean isDirty(String attribute)

Description copied from interface: ItemModelContext

Checks if the specific attribute has been changed.

Specified by:

isDirty in interface ItemModelContext

Returns:

true if changed, false otherwise.

isLoaded

public boolean isLoaded(String attribute)

Description copied from interface: ItemModelContext

Checks if the specific attribute has been loaded from the database.

Specified by:

isLoaded in interface ItemModelContext

Returns:

true if loaded, false otherwise.

getOriginalValue

public <T> T getOriginalValue(String key)

Description copied from interface: ItemModelContext

Retrieves the original loaded value of the attribute.

Specified by:

getOriginalValue in interface ItemModelContext

Returns:

the original value.

loadOriginalValue

public Object loadOriginalValue(String attribute)

Description copied from interface: ItemModelInternalContext

Returns the original value for the given attribute

Specified by:

loadOriginalValue in interface ItemModelInternalContext

Parameters:

attribute - attribute name

Returns:

original value of the given attribute

loadOriginalValue

public Object loadOriginalValue(String attribute,
                                Locale locale)

Description copied from interface: ItemModelInternalContext

Returns the original localized value for the given attribute

Specified by:

loadOriginalValue in interface ItemModelInternalContext

Parameters:

attribute - attribute name

locale - locale name

Returns:

original value of the given attribute

getDynamicValue

public <T> T getDynamicValue(AbstractItemModel model,
                             String attribute)

Description copied from interface: ItemModelInternalContext

Retrieves the dynamic value of the attribute.

Specified by:

getDynamicValue in interface ItemModelInternalContext

Parameters:

model - YTODO

Returns:

the dynamic value.

setDynamicValue

public <T> void setDynamicValue(AbstractItemModel model,
                                String attribute,
                                T value)

Description copied from interface: ItemModelInternalContext

Sets the dynamic value of the attribute.

Specified by:

setDynamicValue in interface ItemModelInternalContext

Parameters:

model - YTODO

getLocalizedDynamicValue

public <T> T getLocalizedDynamicValue(AbstractItemModel model,
                                      String attribute,
                                      Locale loc)

Description copied from interface: ItemModelInternalContext

Retrieves the dynamic value of the attribute with the local.

Specified by:

getLocalizedDynamicValue in interface ItemModelInternalContext

Parameters:

model - YTODO

Returns:

the dynamic value.

setLocalizedDynamicValue

public <T> void setLocalizedDynamicValue(AbstractItemModel model,
                                         String attribute,
                                         Locale loc,
                                         T value)

Description copied from interface: ItemModelInternalContext

Sets the dynamic value of the attribute under the locale.

Specified by:

setLocalizedDynamicValue in interface ItemModelInternalContext

Parameters:

model - YTODO

getLocalizedValue

public <T> T getLocalizedValue(String key,
                               Locale locale)

Retrieves the localized value of the key. NOTE: the value will be fetched only if it is neither set nor loaded. For example, the method getName(Locale.GERMANY) won't fetch the German "name" attribute from the database if the setName("German_name", Locale.GERMANY) has been called before.

Specified by:

getLocalizedValue in interface ItemModelInternalContext

Returns:

the current value with the locale.

getLocalizedRelationValue

public <T> T getLocalizedRelationValue(String key,
                                       Locale locale)

Description copied from interface: ItemModelInternalContext

Retrieves the current value of the specific attribute with the locale.

Specified by:

getLocalizedRelationValue in interface ItemModelInternalContext

Returns:

the current value with the locale.

getLocalizedWithFallback

protected Object getLocalizedWithFallback(Map<Locale,Object> attrLocMap,
                                          String qualifier,
                                          Locale dataLocale,
                                          boolean keepOriginals,
                                          boolean isRelationAttribute)
                                   throws IllegalArgumentException

Throws:

IllegalArgumentException

getOrLoadLocalized

protected <T> T getOrLoadLocalized(Map<Locale,Object> locMap,
                                   String qualifier,
                                   Locale dataLoc,
                                   boolean keepAsOriginal)

loadLocalized

protected <T> T loadLocalized(Map<Locale,Object> locMap,
                              String qualifier,
                              Locale dataLoc,
                              boolean keepAsOriginal)

loadLocalized

protected <T> T loadLocalized(Map<Locale,Object> locMap,
                              String qualifier,
                              Locale dataLoc,
                              boolean keepAsOriginal,
                              boolean resetDirty)

toDataLocale

protected Locale toDataLocale(Locale locale)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

setLocalizedValue

public <T> void setLocalizedValue(String qualifier,
                                  Locale locale,
                                  T value)

Description copied from interface: ItemModelInternalContext

Sets the new value for the specific attribute with the locale.

Specified by:

setLocalizedValue in interface ItemModelInternalContext

isDirty

public boolean isDirty(String attribute,
                       Locale loc)

Description copied from interface: ItemModelContext

Checks if the specific localized attribute has been changed with the locale.

Specified by:

isDirty in interface ItemModelContext

Returns:

true if changed, false otherwise.

isLoaded

public boolean isLoaded(String attribute,
                        Locale loc)

Description copied from interface: ItemModelContext

Checks if the specific localized attribute has been loaded with the locale from the database.

Specified by:

isLoaded in interface ItemModelContext

Returns:

true if loaded, false otherwise.

getOriginalValue

public <T> T getOriginalValue(String key,
                              Locale loc)

Description copied from interface: ItemModelContext

Retrieves the original loaded value of the localized attribute with the locale.

Specified by:

getOriginalValue in interface ItemModelContext

Returns:

the original localized value with the locale.

getDirtyLocalizedAttributes

public Map<Locale,Set<String>> getDirtyLocalizedAttributes()

Description copied from interface: ItemModelContext

Returns all changed localized attributes with the locale.

Specified by:

getDirtyLocalizedAttributes in interface ItemModelContext

Returns:

the set of all changed localized attributes with the locale.

throwLoadingError

protected void throwLoadingError(String qualifier)

throwLoadingError

protected void throwLoadingError(String qualifier,
                                 Locale dataLocale)

markDirty

protected void markDirty(String attribute)

markDirty

protected void markDirty(String attribute,
                         Locale dataLocale)

getCurrentLocale

protected Locale getCurrentLocale()
                           throws IllegalStateException

Throws:

IllegalStateException

getSerializationStrategy

public SerializationStrategy getSerializationStrategy()

getLocaleProvider

public LocaleProvider getLocaleProvider(boolean required)

setLocaleProvider

public void setLocaleProvider(LocaleProvider localeProvider)

getDynamicAttributesProvider

public DynamicAttributesProvider getDynamicAttributesProvider()

getFetchStrategy

protected FetchStrategy getFetchStrategy()

getTenantId

public String getTenantId()

Description copied from interface: ItemModelContext

Retrieves the tenant id of the model.

Specified by:

getTenantId in interface ItemModelContext

getCombinedLocalizedValuesMap

public Map<String,LocMap<Locale,Object>> getCombinedLocalizedValuesMap()

beforeAttach

public void beforeAttach(LocaleProvider localeProvider)

setAttributeProvider

public void setAttributeProvider(AttributeProvider attributeProvider)

getAttributeProvider

public AttributeProvider getAttributeProvider()

setDynamicAttributesProvider

public void setDynamicAttributesProvider(DynamicAttributesProvider attributeProvider)

afterCreate

public void afterCreate(LocaleProvider locProvider,
                        AttributeProvider attrProvider,
                        DynamicAttributesProvider dynProvider,
                        PK pk,
                        long persistenceVersion,
                        String typeCode)

afterUpdate

public void afterUpdate(long persistenceVersion)

afterReload

public void afterReload(long persistenceVersion)

setFetchStrategy

public void setFetchStrategy(FetchStrategy fetchStrategy)

setSerializationStrategy

public void setSerializationStrategy(SerializationStrategy strategy)

getNewPK

public PK getNewPK()

Description copied from interface: ItemModelInternalContext

Returns the newPK assigned to the current model

Specified by:

getNewPK in interface ItemModelInternalContext

Returns:

new PK for the not saved model

generateNewPK

public PK generateNewPK()

Description copied from interface: ItemModelInternalContext

Generate the new PK and assigns it to the current model. Will be generated only for new models if the new PK has not been generated yet

Specified by:

generateNewPK in interface ItemModelInternalContext

Returns:

new generated PK for the not saved model