de.hybris.platform.jalo.type

Class MapType

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.type.TypeManagerManaged

de.hybris.platform.jalo.type.Type

de.hybris.platform.jalo.type.MapType

All Implemented Interfaces:

Serializable, Comparable

public class MapType
extends Type

This type represents a typed map. Both argument type and element type is typed.

Map types fulfil s special role describing localized attributes since each localized attribute must point to a map type having the Language composed type as argument type and the actual attribute type as return type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapType.MapTypeImpl Internal persistence layer implementation interface.

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.Type

Type.TypeImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

TypeManagerManaged.TypeManagerManagedImpl

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	ARGUMENT_TYPE The argument type attribute string constant.
static String	RETURN_TYPE The element (or return ) type attribute string constant.

Fields inherited from class de.hybris.platform.jalo.type.Type

CODE, DEFAULTVALUE, DESCRIPTION, XMLDEFINITION

Fields inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

AUTOCREATE, DEPRECATED, EXTENSION_NAME, GENERATE, NAME

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

Method Summary

Modifier and Type	Method and Description
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) The generic creation method for maptypes.
protected static String	escapeForMap(String raw)
String	exportXMLDefinition(XMLOutputter xout)
Type	getArgumentType() Returns the argument type.
Type	getArgumentType(SessionContext ctx) Returns the argument type.
static int[]	getEscapedMapPositions(String escaped, int startFrom)
protected MapType.MapTypeImpl	getMapTypeImpl() Internal access to persistence layer implementation.
protected Item.ItemAttributeMap	getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes) Cuts the following attributes which have been already set during creation: Type.CODE ARGUMENT_TYPE RETURN_TYPE
Type	getReturnType() Returns the element ( or return-) type.
Type	getReturnType(SessionContext ctx) Returns the element ( or return-) type.
String	getXMLDefinition() Assembles the XML definition to put inside a items.xml .
boolean	isAssignableFrom(Type type) Checks if this maptype is assignable from another maptype.
boolean	isInstance(Object o) Checks if a given object is instance of this maptype.
Object	parseValue(SessionContext ctx, String value)
String	toString() The string representation of this map type.
String	toString(SessionContext ctx, Object value)
boolean	typeCheckContent(Map map) Helper method for isInstance(Object).
protected static String	unescapeForMap(String escaped)

Methods inherited from class de.hybris.platform.jalo.type.Type

compareTo, getAllDescriptions, getAllDescriptions, getCode, getDefaultValue, getDefaultValue, getDescription, getDescription, getTypeImpl, setAllDescriptions, setAllDescriptions, setDefaultValue, setDefaultValue, setDescription, setDescription

Methods inherited from class de.hybris.platform.jalo.type.TypeManagerManaged

getAllNames, getAllNames, getExtensionName, getImpl, getName, getName, isAutocreate, isDeprecated, isGenerate, setAllNames, setAllNames, setAutocreate, setExtensionName, setGenerate, setName, setName

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, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getDefaultAttributeModes, 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, 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, setNonInitialAttributes, 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

ARGUMENT_TYPE

public static final String ARGUMENT_TYPE

The argument type attribute string constant.

RETURN_TYPE

public static final String RETURN_TYPE

The element (or return ) type attribute string constant.

Constructor Detail

MapType

public MapType()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

The generic creation method for maptypes.

The following attributes are required:

• Type.CODE
• ARGUMENT_TYPE
• RETURN_TYPE

Specified by:

createItem in class Item

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

getNonInitialAttributes

protected Item.ItemAttributeMap getNonInitialAttributes(SessionContext ctx,
                                                        Item.ItemAttributeMap allAttributes)

Cuts the following attributes which have been already set during creation:

• Type.CODE
• ARGUMENT_TYPE
• RETURN_TYPE

Overrides:

getNonInitialAttributes in class Item

Parameters:

ctx - session context with language = NULL

allAttributes - a ItemAttributeMap contaning attribute values.

Returns:

a ItemAttributeMap containing all attribute values, which belong to non-initial attributes.

getEscapedMapPositions

public static int[] getEscapedMapPositions(String escaped,
                                           int startFrom)

Since:

2.10

escapeForMap

protected static final String escapeForMap(String raw)

Since:

2.10

unescapeForMap

protected static final String unescapeForMap(String escaped)

Since:

2.10

toString

public String toString(SessionContext ctx,
                       Object value)
                throws JaloInvalidParameterException

Specified by:

toString in class Type

Throws:

JaloInvalidParameterException

Since:

2.10

parseValue

public Object parseValue(SessionContext ctx,
                         String value)
                  throws JaloInvalidParameterException

Specified by:

parseValue in class Type

Throws:

JaloInvalidParameterException

Since:

2.10

getArgumentType

public Type getArgumentType()

Returns the argument type.

getArgumentType

public Type getArgumentType(SessionContext ctx)

Returns the argument type.

getReturnType

public Type getReturnType()

Returns the element ( or return-) type.

getReturnType

public Type getReturnType(SessionContext ctx)

Returns the element ( or return-) type.

getXMLDefinition

public String getXMLDefinition()

Assembles the XML definition to put inside a items.xml .

Specified by:

getXMLDefinition in class Type

exportXMLDefinition

public String exportXMLDefinition(XMLOutputter xout)

Specified by:

exportXMLDefinition in class TypeManagerManaged

getMapTypeImpl

protected MapType.MapTypeImpl getMapTypeImpl()

Internal access to persistence layer implementation.

isAssignableFrom

public boolean isAssignableFrom(Type type)

Checks if this maptype is assignable from another maptype.

This is true if its argument type is assignable from the other type's argument type and its element type is assignable from the other type's element type.

Specified by:

isAssignableFrom in class Type

Parameters:

type - the type to be checked.

isInstance

public boolean isInstance(Object o)

Checks if a given object is instance of this maptype.

This is true if the object is a map and each key is instance of the argument type and each value is instance of the element type.

Specified by:

isInstance in class Type

Parameters:

o - the object to be checked.

typeCheckContent

public boolean typeCheckContent(Map map)

Helper method for isInstance(Object). Checks content of a map if it is compatible with the argument and element type.

toString

public String toString()

The string representation of this map type.

Overrides:

toString in class Type

Returns:

the String representation of this item.