Package de.hybris.platform.servicelayer.internal.converter.impl

Class ItemModelConverter

java.lang.Object

de.hybris.platform.servicelayer.internal.converter.impl.ItemModelConverter

All Implemented Interfaces:

TypeSystemAwareModelConverter, UpdateableModelConverter, ModelConverter, Cloneable

Direct Known Subclasses:

PrefetchAllModelConverter, VariantProductModelConverter

public class ItemModelConverter
extends Object
implements Cloneable, UpdateableModelConverter, TypeSystemAwareModelConverter

This is a general ModelConverter implementation which should be working for almost every AbstractItemModel. Using the ItemModelConverter(ModelService, I18NService, CommonI18NService, String, Class, SerializationStrategy, SourceTransformer, SelfHealingService) constructor you specify which source Item class you want to use (e.g. Product, this will be used for compatibility checks in load(Object)) and which ItemModel class will be created if you load such an item using load(Object) . If you need functionality which is beyond this simple implementation, you will have to provide your own ItemModel implementation. This class is an internal API and is subject to change without further notice

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ItemModelConverter.AttributesToLoad
protected static class	ItemModelConverter.LoadedAttributeValues
static class	ItemModelConverter.ModelAttributeInfo
class	ItemModelConverter.ModifiedAttributeValues
static class	ItemModelConverter.RelationTypeAttributeInfo
static class	ItemModelConverter.TypeAttributeInfo
protected static class	ItemModelConverter.TypeMetaInfo	This class is an internal API and is subject to change without further notice

Constructor Summary

Constructors

Constructor	Description
ItemModelConverter(ModelService modelService, I18NService i18nService, CommonI18NService commonI18NService, String type, Class<? extends AbstractItemModel> modelClass, SerializationStrategy serializationStrategy)	For backward compatibility
ItemModelConverter(ModelService modelService, I18NService i18nService, CommonI18NService commonI18NService, String type, Class<? extends AbstractItemModel> modelClass, SerializationStrategy serializationStrategy, SourceTransformer sourceTransformer, SelfHealingService selfHealingService)	Constructs a new ItemModelConverter instance which handles beans of given class type related to given composed type.

Method Summary

Modifier and Type	Method	Description
void	addModelModificationListener(Object model, ModelModificationListener listener)	Adds the given ModelModificationListener to the given model.
void	afterDetach(Object model, ModelContext ctx)	This method is executed after the given model is attached from the given ModelContext
void	afterModification(AbstractItemModel model, PK pk, long persistenceVersion)
protected ItemModelConverter.TypeMetaInfo	assembleMetaInfo(ComposedType ct, Collection<ItemModelConverter.TypeAttributeInfo> attributes)	Initializes ItemModelConverter.TypeMetaInfo._modelAttributesAll and ItemModelConverter.TypeMetaInfo._modelAttributesInitial using attribute meta infos.
void	beforeAttach(Object model, ModelContext ctx)	This method is executed before the given model is attached to the given ModelContext
protected Collection<ItemModelConverter.TypeAttributeInfo>	calculateTypeAttributeInfos(ComposedType ct)	Calculates attribute meta info objects for a given composed type.
protected void	clearAttribute(AbstractItemModel model, String qualifier)
protected void	clearLocAttribute(AbstractItemModel model, String qualifier, Locale loc)
protected Object	convertModelsToObjects(AbstractItemModel model, String qualifier, Object value)	Checks if the given object is a model, a collection of models, or a map with models and tries to convert them to related source object.
protected Object	convertObjectsToModels(PersistenceObject item, String qualifier, Object value)	Tries to convert given object, collection of objects or map of objects to related model instances.
AbstractItemModel	create(String type)	Instantiates a new instance of configured model class.
protected ItemModelInternalContext	createContextForExistingModel(String type, PK pk, long persistenceVersion, AttributeProvider attributeProvider)
protected ItemModelInternalContext	createContextForNewModel(String type)
protected ItemModelConverter.ModelAttributeInfo	createModelAttributeInfo(ItemModelConverter.TypeAttributeInfo info)	This method is an internal API and is subject to change without further notice
protected AbstractItemModel	createModelInstance(ItemModelInternalContext ctx)
protected PersistenceObject	createNewItem(AbstractItemModel model, ItemModelConverter.ModifiedAttributeValues values)	Performs item creation.
boolean	equals(Object o)
boolean	exists(Object model)	Returns true if for the given model a source Item exists and if this item Item#isAlive()
protected void	fillModel(AbstractItemModel model, ItemModelConverter.AttributesToLoad attributesToLoad, PersistenceObject item)	Loads and fills model instance with loaded attribute values.
List<ItemModelConverter.ModelAttributeInfo>	getAllModelAttributes()
protected ItemModelConverter.AttributesToLoad	getAttributesToReload(AbstractItemModel model, ItemModelConverter.ModifiedAttributeValues savedValues, boolean forCreation)
Object	getAttributeValue(Object model, String attributeQualifier)	Generic attribute value getter to read attribute data from arbitrary model instances.
protected CommonI18NService	getCommonI18NService()
protected ComposedType	getComposedType(AbstractItemModel model)
protected ConfigIntf	getConfig()	Encapsulates fetching of ConfigIntf.
String	getDefaultType()
Map<String,Set<Locale>>	getDirtyAttributes(Object model)	Returns a map with all modified attribute qualifiers for the given model.
Object	getDirtyAttributeValue(Object model, String attributeQualifier)	Internal method for DefaultModelService when inspecting dirty attributes during save!
protected Set<String>	getDirtyLocalizedAttributesWithNonDataLocales(Map<Locale,Set<String>> dirtyLocalizedAttributes, Map<Locale,Set<Locale>> dataLocale2NonDataLocales)
Object	getDirtyLocalizedAttributeValue(Object model, String attributeQualifier, Locale locale)	Internal method for DefaultModelService when inspecting dirty attributes during save!
protected DynamicAttributesProvider	getDynamicAttributesProvider()
protected Set<ItemModelConverter.ModelAttributeInfo>	getExcluded(Collection<String> excluded)
protected final Object	getFieldValue(Object model, ItemModelConverter.ModelAttributeInfo info)
protected Method	getGetter(Object model, ItemModelConverter.ModelAttributeInfo info)
protected I18NService	getI18nService()
ItemModelConverter.ModelAttributeInfo	getInfo(String qualfier)
List<ItemModelConverter.ModelAttributeInfo>	getInitialModelAttributes()
protected LocaleProvider	getLocaleProvider()
Object	getLocalizedAttributeValue(Object model, String attributeQualifier, Locale locale)	Generic attribute value getter to read attribute data from arbitrary model instances.
protected Method	getLocalizedGetter(Object model, ItemModelConverter.ModelAttributeInfo info)
protected Method	getLocalizedSetter(Object model, ItemModelConverter.ModelAttributeInfo info, Object value)
Set<String>	getMandatoryAttributes()
Set<String>	getMandatoryAttributesForCreation()
Class<? extends AbstractItemModel>	getModelClass()	Gets the class used for instantiation of related models.
protected ModelService	getModelService()
Set<String>	getPartOfAttributes(TypeService typeService)	Returns a collection of all partof atrributes
PersistenceObject	getPersistenceSource(Object model)
SerializationStrategy	getSerializationStrategy()
protected Method	getSetter(Object model, ItemModelConverter.ModelAttributeInfo info, Object value)
Object	getSource(Object model)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.7.0 - Please usegetPersistenceSource(Object)
protected Locale	getStdLocale()
String	getType(Object model)	Returns the exact type of the given model.
protected String	getTypeFromModelContext(Object model)
Set<String>	getUniqueAttributes()
Set<String>	getWritablePartOfAttributes(TypeService typeService)	Returns a collection of writable partof atrributes
int	hashCode()
protected boolean	hasNonDataLocales(Map<Locale,Set<Locale>> dataLocale2LocaleMappings)
void	init(ConverterRegistry registry)	Called once before using the converter the first time.
boolean	isConfiguredForLegacyPersistence()
protected boolean	isEnumValue(Object value)
boolean	isModified(Object model)	Returns true if the given model is new or the ModelValueHistory of the model contains changed attributes.
boolean	isModified(Object model, String attribute)	Returns true if the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed.
boolean	isModified(Object model, String attribute, Locale loc)	Returns true if the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed.
boolean	isNew(Object model)	Returns true if the given model was not persisted yet.
protected boolean	isNonLazyLoadedAttribute(AttributeDescriptor desc)	Tells whether or not a attribute should be lazy loaded.
protected boolean	isReferenceAttribute(AttributeDescriptor desc)	Tells whether an attribute is a reference to an item (including Collection and Maps referencing items).
boolean	isRemoved(Object model)	Returns true if for the given model no source Item exists or this item is not Item#isAlive()
boolean	isUpToDate(Object model)	The given model is not up-to-date (returns false) when: the model is new (see ModelConverter.isNew(Object)) or the model was removed (see ModelConverter.isRemoved(Object)) or the model was locally modified or the Item in the database is newer as the source item of the model
boolean	jaloOnlyAttribute(String qualifier)
final AbstractItemModel	load(Object source)	Instantiates a new instance of configured model class for the given source Item and loads all of its attributes.
protected void	mergeNonDataLocales(AbstractItemModel model)
LocMap<Locale,Object>	mergeOldValuesIntoDataLocales(Map<Locale,Set<Locale>> dataLocale2LocaleMappings, String qualifier, LocMap<Locale,Object> oldLocValues)
protected boolean	mustConvert(Type type)	Tells whether or not values of the given type require conversion before using them as model attribute values.
protected void	preLoadAttribute(AbstractItemModel model, String qualifier, Object value)
protected void	preLoadLocAttribute(Map<String,LocMap<Locale,Object>> localizedAttributesFieldValue, AbstractItemModel model, String qualifier, Locale loc, Object value)
protected ItemModelConverter.LoadedAttributeValues	readAttributes(Locale dataLoc, PersistenceObject item, Set<String> qualifiers)	Performs bulk-reading of item attribute values,
protected AttributePrefetchMode	readPrefetchSettings()	Reads configuration setting ServicelayerConstants.PARAM_PREFETCH and determines preFetch mode.
protected Object	readSingleAttribute(Locale dataLoc, PersistenceObject item, String qualifier)	Performs reading for a single item attribute.
void	reload(Object modelOriginal)	Clears all attributes of given bean so that they will be reloaded on next request.
void	remove(Object model)	Tries to remove the source Item of the given AbstractItemModel.
void	removeModelModificationListener(Object model, ModelModificationListener listener)	Removes the ModelModificationListener from the given model.
void	save(Object model, Collection<String> excludedAttributes)	Takes all modified values from the given AbstractItemModel and writes them down to the source Item (if it exists).
protected void	setAttributeLoadError(AbstractItemModel model, String qualifier, ModelLoadingException error)
void	setAttributeValue(Object model, String attributeQualifier, Object value)	Generic attribute value setter to modify attribute data on arbitrary model instances.
protected void	setLocAttributeLoadError(AbstractItemModel model, String qualifier, Locale loc, ModelLoadingException error)
protected void	storeAttributes(Item item, ItemModelConverter.ModifiedAttributeValues values)	Performs storing of item attribute values.
String	toString()
void	typeSystemChanged()	Type system was changed and converter will respect this changes.
void	unloadAttributes(AbstractItemModel model)

Methods inherited from class java.lang.Object

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

Constructor Details

ItemModelConverter

public ItemModelConverter(ModelService modelService,
 I18NService i18nService,
 CommonI18NService commonI18NService,
 String type,
 Class<? extends AbstractItemModel> modelClass,
 SerializationStrategy serializationStrategy)

For backward compatibility

ItemModelConverter

public ItemModelConverter(ModelService modelService,
 I18NService i18nService,
 CommonI18NService commonI18NService,
 String type,
 Class<? extends AbstractItemModel> modelClass,
 SerializationStrategy serializationStrategy,
 SourceTransformer sourceTransformer,
 SelfHealingService selfHealingService)

Constructs a new ItemModelConverter instance which handles beans of given class type related to given composed type.

Parameters:

type - specifies the type this handler can handle, is used in save(Object, Collection) if a new item instance is created

modelClass - specifies which AbstractItemModel class will be used to instantiate a new model via load(Object)

Method Details

readPrefetchSettings

protected AttributePrefetchMode readPrefetchSettings()

Reads configuration setting ServicelayerConstants.PARAM_PREFETCH and determines preFetch mode. Method is called once initially for each ItemModelConverter instance.

• ServicelayerConstants.VALUE_PREFETCH_DEFAULT or no value means

getConfig

protected ConfigIntf getConfig()

Encapsulates fetching of ConfigIntf. This allows overriding e.g. for test cases.

getInitialModelAttributes

public List<ItemModelConverter.ModelAttributeInfo> getInitialModelAttributes()

getAllModelAttributes

public List<ItemModelConverter.ModelAttributeInfo> getAllModelAttributes()

getInfo

public ItemModelConverter.ModelAttributeInfo getInfo(String qualfier)

create

public AbstractItemModel create(String type)

Instantiates a new instance of configured model class.

Specified by:

create in interface ModelConverter

Returns:

new empty model

isConfiguredForLegacyPersistence

public boolean isConfiguredForLegacyPersistence()

createModelInstance

protected AbstractItemModel createModelInstance(ItemModelInternalContext ctx)

createContextForNewModel

protected ItemModelInternalContext createContextForNewModel(String type)

createContextForExistingModel

protected ItemModelInternalContext createContextForExistingModel(String type,
 PK pk,
 long persistenceVersion,
 AttributeProvider attributeProvider)

load

public final AbstractItemModel load(Object source)

Instantiates a new instance of configured model class for the given source Item and loads all of its attributes.

Specified by:

load in interface ModelConverter

Parameters:

source - object which will be used for filling new model

Returns:

new model instance with data of given source

Throws:

IllegalArgumentException - if the given source object is not compatible with the item class provided in this classes constructor.

addModelModificationListener

public void addModelModificationListener(Object model,
 ModelModificationListener listener)

Description copied from interface: UpdateableModelConverter

Adds the given ModelModificationListener to the given model.

Specified by:

addModelModificationListener in interface UpdateableModelConverter

removeModelModificationListener

public void removeModelModificationListener(Object model,
 ModelModificationListener listener)

Description copied from interface: UpdateableModelConverter

Removes the ModelModificationListener from the given model.

Specified by:

removeModelModificationListener in interface UpdateableModelConverter

beforeAttach

public void beforeAttach(Object model,
 ModelContext ctx)

Description copied from interface: ModelConverter

This method is executed before the given model is attached to the given ModelContext

Specified by:

beforeAttach in interface ModelConverter

mergeNonDataLocales

protected void mergeNonDataLocales(AbstractItemModel model)

mergeOldValuesIntoDataLocales

public LocMap<Locale,Object> mergeOldValuesIntoDataLocales(Map<Locale,Set<Locale>> dataLocale2LocaleMappings,
 String qualifier,
 LocMap<Locale,Object> oldLocValues)

getDirtyLocalizedAttributesWithNonDataLocales

protected Set<String> getDirtyLocalizedAttributesWithNonDataLocales(Map<Locale,Set<String>> dirtyLocalizedAttributes,
 Map<Locale,Set<Locale>> dataLocale2NonDataLocales)

hasNonDataLocales

protected boolean hasNonDataLocales(Map<Locale,Set<Locale>> dataLocale2LocaleMappings)

afterDetach

public void afterDetach(Object model,
 ModelContext ctx)

Description copied from interface: ModelConverter

This method is executed after the given model is attached from the given ModelContext

Specified by:

afterDetach in interface ModelConverter

getWritablePartOfAttributes

public Set<String> getWritablePartOfAttributes(TypeService typeService)

Description copied from interface: ModelConverter

Returns a collection of writable partof atrributes

Specified by:

getWritablePartOfAttributes in interface ModelConverter

getPartOfAttributes

public Set<String> getPartOfAttributes(TypeService typeService)

Description copied from interface: ModelConverter

Returns a collection of all partof atrributes

Specified by:

getPartOfAttributes in interface ModelConverter

reload

public void reload(Object modelOriginal)

Clears all attributes of given bean so that they will be reloaded on next request.

Specified by:

reload in interface ModelConverter

Parameters:

modelOriginal - model which will be filled from scratch using mapped source

remove

public void remove(Object model)

Tries to remove the source Item of the given AbstractItemModel.

Specified by:

remove in interface ModelConverter

Parameters:

model - the model for which to remove the source

Throws:

IllegalArgumentException - if the given model is not of type ItemModel

save

public void save(Object model,
 Collection<String> excludedAttributes)

Takes all modified values from the given AbstractItemModel and writes them down to the source Item (if it exists). If the item doesn't exist, an exception is thrown since the Item type itself is abstract.

Specified by:

save in interface ModelConverter

Parameters:

model - the model to save

Throws:

IllegalArgumentException - if the given model is not an instance of ItemModel

IllegalStateException - if the source item of the model doesn't exist any more

afterModification

public void afterModification(AbstractItemModel model,
 PK pk,
 long persistenceVersion)

unloadAttributes

public void unloadAttributes(AbstractItemModel model)

getExcluded

protected Set<ItemModelConverter.ModelAttributeInfo> getExcluded(Collection<String> excluded)

getSource

@Deprecated(since="5.7.0",
            forRemoval=true)
public Object getSource(Object model)

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.7.0 - Please usegetPersistenceSource(Object)

For the given bean the underlying Item is returned.

Specified by:

getSource in interface ModelConverter

Parameters:

model - the model for which to return the source

Returns:

the underlying source of the given model, or null if the source doesn't (yet) exist

Throws:

IllegalArgumentException - if the given bean is not of type AbstractItemModel

IllegalStateException - is the model has never been persisted or the underlying item does not exist any more

getPersistenceSource

public PersistenceObject getPersistenceSource(Object model)

Specified by:

getPersistenceSource in interface ModelConverter

isModified

public boolean isModified(Object model)

Description copied from interface: ModelConverter

Returns true if the given model is new or the ModelValueHistory of the model contains changed attributes.

Specified by:

isModified in interface ModelConverter

Parameters:

model - the model

Returns:

false otherwise

isModified

public boolean isModified(Object model,
 String attribute)

Description copied from interface: ModelConverter

Returns true if the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed. If the attribute is localized the current session data Locale (see LocaleProvider#getCurrentDataLocale()) is used.

Specified by:

isModified in interface ModelConverter

Parameters:

model - the model

attribute - the attribute qualifier

Returns:

false if the attribute was not modified.

isModified

public boolean isModified(Object model,
 String attribute,
 Locale loc)

Description copied from interface: ModelConverter

Returns true if the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed. For localized attributes the given Locale is used to check for modifications. If the Locale is null then all Locales will be checked for modifications. For non-localized attributes the given Locale will be ignored.

Specified by:

isModified in interface ModelConverter

Parameters:

model - the model

attribute - the attribute qualifier

loc - the Locale. Can be null.

Returns:

false otherwise.

exists

public boolean exists(Object model)

Description copied from interface: ModelConverter

Returns true if for the given model a source Item exists and if this item Item#isAlive()

Specified by:

exists in interface ModelConverter

Parameters:

model - the model

Returns:

false if the model was not persisted yet (no underlying item) or the item was removed.

isRemoved

public boolean isRemoved(Object model)

Description copied from interface: ModelConverter

Returns true if for the given model no source Item exists or this item is not Item#isAlive()

Specified by:

isRemoved in interface ModelConverter

Parameters:

model - the model

Returns:

false if the model ModelConverter.isNew(Object) or the item is alive.

isNew

public boolean isNew(Object model)

Description copied from interface: ModelConverter

Returns true if the given model was not persisted yet.

Specified by:

isNew in interface ModelConverter

Parameters:

model - the model

Returns:

false if an AttributeProvider for the given model exists.

isUpToDate

public boolean isUpToDate(Object model)

Description copied from interface: ModelConverter

The given model is not up-to-date (returns false) when:

• the model is new (see ModelConverter.isNew(Object)) or
• the model was removed (see ModelConverter.isRemoved(Object)) or
• the model was locally modified or
• the Item in the database is newer as the source item of the model

Specified by:

isUpToDate in interface ModelConverter

Parameters:

model - the model

Returns:

true if the model is up-to-date

getAttributeValue

public Object getAttributeValue(Object model,
 String attributeQualifier)

Description copied from interface: ModelConverter

Generic attribute value getter to read attribute data from arbitrary model instances.

Specified by:

getAttributeValue in interface ModelConverter

Parameters:

model - the model instance

attributeQualifier - the attribute qualifier

Returns:

the attribute value

getDirtyAttributeValue

public Object getDirtyAttributeValue(Object model,
 String attributeQualifier)

Internal method for DefaultModelService when inspecting dirty attributes during save!

getLocalizedAttributeValue

public Object getLocalizedAttributeValue(Object model,
 String attributeQualifier,
 Locale locale)

Description copied from interface: ModelConverter

Generic attribute value getter to read attribute data from arbitrary model instances.

Specified by:

getLocalizedAttributeValue in interface ModelConverter

Parameters:

model - the model instance

attributeQualifier - the attribute qualifier

locale - Locale for which value will be returned

Returns:

the attribute value

getDirtyLocalizedAttributeValue

public Object getDirtyLocalizedAttributeValue(Object model,
 String attributeQualifier,
 Locale locale)

Internal method for DefaultModelService when inspecting dirty attributes during save!

setAttributeValue

public void setAttributeValue(Object model,
 String attributeQualifier,
 Object value)

Description copied from interface: ModelConverter

Generic attribute value setter to modify attribute data on arbitrary model instances.

Specified by:

setAttributeValue in interface ModelConverter

Parameters:

model - the model

attributeQualifier - the attribute qualifier

value - the attribute value

getModelClass

public Class<? extends AbstractItemModel> getModelClass()

Gets the class used for instantiation of related models.

Returns:

model class

getDefaultType

public String getDefaultType()

getType

public String getType(Object model)

Description copied from interface: ModelConverter

Returns the exact type of the given model.

Specified by:

getType in interface ModelConverter

getTypeFromModelContext

protected String getTypeFromModelContext(Object model)

getComposedType

protected ComposedType getComposedType(AbstractItemModel model)

readSingleAttribute

protected Object readSingleAttribute(Locale dataLoc,
 PersistenceObject item,
 String qualifier)

Performs reading for a single item attribute.

Parameters:

dataLoc - the locale to be used

item - the item to read from

qualifier - the attribute qualifier

Returns:

the attribute value

jaloOnlyAttribute

public boolean jaloOnlyAttribute(String qualifier)

calculateTypeAttributeInfos

protected Collection<ItemModelConverter.TypeAttributeInfo> calculateTypeAttributeInfos(ComposedType ct)

Calculates attribute meta info objects for a given composed type.

isReferenceAttribute

protected boolean isReferenceAttribute(AttributeDescriptor desc)

Tells whether an attribute is a reference to an item (including Collection and Maps referencing items).

assembleMetaInfo

protected ItemModelConverter.TypeMetaInfo assembleMetaInfo(ComposedType ct,
 Collection<ItemModelConverter.TypeAttributeInfo> attributes)

Initializes ItemModelConverter.TypeMetaInfo._modelAttributesAll and ItemModelConverter.TypeMetaInfo._modelAttributesInitial using attribute meta infos. Must be called with active write lock!!

createModelAttributeInfo

protected ItemModelConverter.ModelAttributeInfo createModelAttributeInfo(ItemModelConverter.TypeAttributeInfo info)

This method is an internal API and is subject to change without further notice

readAttributes

protected ItemModelConverter.LoadedAttributeValues readAttributes(Locale dataLoc,
 PersistenceObject item,
 Set<String> qualifiers)

Performs bulk-reading of item attribute values,

Parameters:

item - the item to read from

qualifiers - the attributes to load values for

storeAttributes

protected void storeAttributes(Item item,
 ItemModelConverter.ModifiedAttributeValues values)

Performs storing of item attribute values.

Parameters:

item - the item to write into

values - the (jalo compatible!) values to store

isNonLazyLoadedAttribute

protected boolean isNonLazyLoadedAttribute(AttributeDescriptor desc)

Tells whether or not a attribute should be lazy loaded.

Parameters:

desc - the attribute descriptor

mustConvert

protected boolean mustConvert(Type type)

Tells whether or not values of the given type require conversion before using them as model attribute values. Here all instances of composed types and other types containing composed types are considered to require conversion.

Parameters:

type - the type to check

See Also:

• isNonLazyLoadedAttribute(AttributeDescriptor)

getStdLocale

protected Locale getStdLocale()

createNewItem

protected PersistenceObject createNewItem(AbstractItemModel model,
 ItemModelConverter.ModifiedAttributeValues values)

Performs item creation. Override this method if you have to provide sophisticated functionality to create a new Item (more than just ComposedType.newInstance(Map).

Parameters:

values - the attributes for the new item

Returns:

the new Item instance

toString

public String toString()

Overrides:

toString in class Object

fillModel

protected void fillModel(AbstractItemModel model,
 ItemModelConverter.AttributesToLoad attributesToLoad,
 PersistenceObject item)

Loads and fills model instance with loaded attribute values.

Parameters:

model - the model instance to fill values into

attributesToLoad - the attributes to be loaded

setLocAttributeLoadError

protected void setLocAttributeLoadError(AbstractItemModel model,
 String qualifier,
 Locale loc,
 ModelLoadingException error)

setAttributeLoadError

protected void setAttributeLoadError(AbstractItemModel model,
 String qualifier,
 ModelLoadingException error)

preLoadLocAttribute

protected void preLoadLocAttribute(Map<String,LocMap<Locale,Object>> localizedAttributesFieldValue,
 AbstractItemModel model,
 String qualifier,
 Locale loc,
 Object value)

clearLocAttribute

protected void clearLocAttribute(AbstractItemModel model,
 String qualifier,
 Locale loc)

preLoadAttribute

protected void preLoadAttribute(AbstractItemModel model,
 String qualifier,
 Object value)

clearAttribute

protected void clearAttribute(AbstractItemModel model,
 String qualifier)

convertModelsToObjects

protected Object convertModelsToObjects(AbstractItemModel model,
 String qualifier,
 Object value)

Checks if the given object is a model, a collection of models, or a map with models and tries to convert them to related source object.

Parameters:

value - model, collection of models or map of models to convert

Returns:

converted source object/s or original if no conversion is possible

convertObjectsToModels

protected Object convertObjectsToModels(PersistenceObject item,
 String qualifier,
 Object value)

Tries to convert given object, collection of objects or map of objects to related model instances.

Parameters:

value - object, collection of objects or map of objects to convert to model/s

Returns:

converted model or original if no conversion is possible

isEnumValue

protected boolean isEnumValue(Object value)

getAttributesToReload

protected ItemModelConverter.AttributesToLoad getAttributesToReload(AbstractItemModel model,
 ItemModelConverter.ModifiedAttributeValues savedValues,
 boolean forCreation)

init

public void init(ConverterRegistry registry)

Description copied from interface: ModelConverter

Called once before using the converter the first time.

Specified by:

init in interface ModelConverter

Parameters:

registry - the registry holding this converter.

getModelService

protected ModelService getModelService()

getI18nService

protected I18NService getI18nService()

getCommonI18NService

protected CommonI18NService getCommonI18NService()

getLocaleProvider

protected LocaleProvider getLocaleProvider()

getDynamicAttributesProvider

protected DynamicAttributesProvider getDynamicAttributesProvider()

getGetter

protected Method getGetter(Object model,
 ItemModelConverter.ModelAttributeInfo info)

getLocalizedGetter

protected Method getLocalizedGetter(Object model,
 ItemModelConverter.ModelAttributeInfo info)

getSetter

protected Method getSetter(Object model,
 ItemModelConverter.ModelAttributeInfo info,
 Object value)

getLocalizedSetter

protected Method getLocalizedSetter(Object model,
 ItemModelConverter.ModelAttributeInfo info,
 Object value)

getSerializationStrategy

public SerializationStrategy getSerializationStrategy()

getFieldValue

protected final Object getFieldValue(Object model,
 ItemModelConverter.ModelAttributeInfo info)

getDirtyAttributes

public Map<String,Set<Locale>> getDirtyAttributes(Object model)

Description copied from interface: ModelConverter

Returns a map with all modified attribute qualifiers for the given model. The keys are all localized and non-localized attribute qualifier which were modified. If the map value is null the key is a non-localized attribute qualifier else the map value contains the locale in which language the localized attribute was modified.

Specified by:

getDirtyAttributes in interface ModelConverter

Parameters:

model - the new (not saved) model

Returns:

a map with all modified attribute qualifier.

getUniqueAttributes

public Set<String> getUniqueAttributes()

getMandatoryAttributes

public Set<String> getMandatoryAttributes()

getMandatoryAttributesForCreation

public Set<String> getMandatoryAttributesForCreation()

typeSystemChanged

public void typeSystemChanged()

Description copied from interface: TypeSystemAwareModelConverter

Type system was changed and converter will respect this changes.

Specified by:

typeSystemChanged in interface TypeSystemAwareModelConverter

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object