de.hybris.platform.jalo.type

Class RelationAttributeAccess

java.lang.Object

de.hybris.platform.jalo.type.RelationAttributeAccess

All Implemented Interfaces:

AttributeAccess

public class RelationAttributeAccess
extends Object
implements AttributeAccess

Base class for relation attribute accesses. use this for building n:m-relations with attribute accesses.

Constructor Summary

Constructors

Constructor and Description
RelationAttributeAccess(String qualifier, boolean isSource, boolean localized, boolean singleValued) Creates a new attribute access for one end of a relation.

Method Summary

Modifier and Type	Method and Description
protected Map	convertListMapToSingleValuedMap(Map listMap)
protected Map	convertSingleValuedMapToListMap(Map singleValuedMap)
Object	getValue(SessionContext ctx, Item item) Retrieves the attribute data from a given item.
void	setValue(SessionContext ctx, Item item, Object value) Stores the attribute data for a given item.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelationAttributeAccess

public RelationAttributeAccess(String qualifier,
                               boolean isSource,
                               boolean localized,
                               boolean singleValued)

Creates a new attribute access for one end of a relation.

Parameters:

qualifier - the relation qualifier - must be the same at both ends for unidirectional relations

isSource - tells whether this end is the source - only one end can be source

localized - tells whether the relation value is localized or not

singleValued - for the special case when the 1-end of an unidirectional 1:n relation is described - use with care, mostly using a simple typed property should be preferred

Method Detail

convertSingleValuedMapToListMap

protected Map convertSingleValuedMapToListMap(Map singleValuedMap)

convertListMapToSingleValuedMap

protected Map convertListMapToSingleValuedMap(Map listMap)

setValue

public final void setValue(SessionContext ctx,
                           Item item,
                           Object value)
                    throws JaloTypeException,
                           JaloInvalidParameterException,
                           JaloSecurityException

Description copied from interface: AttributeAccess

Stores the attribute data for a given item.

Specified by:

setValue in interface AttributeAccess

Parameters:

ctx - the current session context - e.g. specifies the session language

item - the item to store data for

value - the value to store

Throws:

JaloTypeException - in case the attribute type does not allow storing this value

JaloInvalidParameterException - in case the value is not compatible with this attribute

JaloSecurityException - in case there are security constraints which do not allow this value to be written

getValue

public final Object getValue(SessionContext ctx,
                             Item item)
                      throws JaloTypeException,
                             JaloInvalidParameterException,
                             JaloSecurityException

Description copied from interface: AttributeAccess

Retrieves the attribute data from a given item. Primitive data types like int are wrapped into their object instances.

Specified by:

getValue in interface AttributeAccess

Parameters:

ctx - the current session context - e.g. specifies the session language

item - the item to get data from

Returns:

the data value

Throws:

JaloTypeException - in case the attribute type does not allow reading this value

JaloInvalidParameterException - in some data required for reading the value is missing or not as expected ( like missing session language )

JaloSecurityException - in case there are security constraints which do not allow reding this value