Package de.hybris.platform.jalo.type

Class CollectionType

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.CollectionType

All Implemented Interfaces:

Serializable, Comparable

public class CollectionType
extends Type

A type representing a typed collection.

The actual type of the collection may be one of the following:

• collection ( use COLLECTION )
• set ( use SET ) which contains unique elements
• list ( use LIST ) which is ordered

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CollectionType.CollectionTypeImpl	The presistence 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	Description
static final int	COLLECTION	The default collection type constants.
static final String	COLLECTION_ENUM_CODE	The default collection enum code .
static final String	ELEMENT_TYPE	The collection element type attribute string constant.
static final int	LIST	The list collection type constants.
static final String	LIST_ENUM_CODE	The list collection enum code.
static final int	SET	The set collection type constants.
static final String	SET_ENUM_CODE	The set collection enum code.
static final int	SORTED_SET	Deprecated. since ages
static final String	SORTED_SET_ENUM_CODE	Deprecated. since ages
static final String	TYPE_OF_COLLECTION	The type of collection attribute string constant.
static final String	TYPE_OF_COLLECTION_ENUM_CODE	The code of the typeOfCollection enumeration type.
static final String	TYPE_OF_COLLECTION_INTERNAL	The internal type of collection 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, HJMPTS, 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	Description
CollectionType()

Method Summary

Modifier and Type	Method	Description
protected int	convertTypeOfCollectionEnumToInt(EnumerationValue enumeration)	Converts typeOfCollection enums into intern int codes.
protected EnumerationValue	convertTypeOfCollectionIntToEnum(int type)	Converts typeOfCollection internal int representation int enum values.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Generic item creation method.
protected static final String	escapeForCollection(String raw)
String	exportXMLDefinition(org.znerd.xmlenc.XMLOutputter xout)
protected CollectionType.CollectionTypeImpl	getCollectionTypeImpl()	Internal access to persistence layer implementation.
Type	getElementType()	Returns the type of the elements of this collection type.
Type	getElementType(SessionContext ctx)	Returns the type of the elements of this collection.
static int[]	getEscapedCollectionPositions(String escaped, int startFrom)
protected Item.ItemAttributeMap	getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes)	Cuts the following attribute values which are already set during actual item creation: Type.CODE ELEMENT_TYPE TYPE_OF_COLLECTION
int	getTypeOfCollection()
EnumerationValue	getTypeOfCollectionEnum()	Returns the type of this collection as enumeration value.
String	getXMLDefinition()	Assembles the XML definition string to put inside a items.xml .
boolean	isAssignableFrom(Type type)	Tests whether this collection type is assignable from another collection type.
boolean	isInstance(Object o)	Tests if a given object is instance of this collection type.
protected boolean	isTypeAssignableFrom(int type1, int type2)	Checks assignability between types of collection: COLLECTION is assignable from all SET is assignable from SET and SORTED_SET LIST is assignable from LIST and SORTED_SET SORTED_SET is assignable from SORTED_SET only
Collection	newInstance()	Returns an empty collection if the specified type (see @link #getTypeOfCollection()}).
Object	parseValue(SessionContext ctx, String value)	reads a collection of '(' + escaped element string + ')'.
String	toString(SessionContext ctx, Object value)	Writes a collection as '(' + escaped element string + ')'.
protected static final String	unescapeForCollection(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, toString

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, getImplementation, 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, getPartOfRemovedSessionMarker, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRelatedItems, getRelatedItems, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, 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, setRelatedItems, setTransientObject, setUseTA, suppressRelation, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

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

Field Details

TYPE_OF_COLLECTION_ENUM_CODE

public static final String TYPE_OF_COLLECTION_ENUM_CODE

The code of the typeOfCollection enumeration type.

See Also:

• getTypeOfCollectionEnum()
• Constant Field Values

COLLECTION

public static final int COLLECTION

The default collection type constants.

See Also:

• getTypeOfCollection()
• Constant Field Values

COLLECTION_ENUM_CODE

public static final String COLLECTION_ENUM_CODE

The default collection enum code .

See Also:

• getTypeOfCollectionEnum()
• Constant Field Values

SET

public static final int SET

The set collection type constants.

See Also:

• getTypeOfCollection()
• Constant Field Values

SET_ENUM_CODE

public static final String SET_ENUM_CODE

The set collection enum code.

See Also:

• getTypeOfCollectionEnum()
• Constant Field Values

LIST

public static final int LIST

The list collection type constants.

See Also:

• Constant Field Values

LIST_ENUM_CODE

public static final String LIST_ENUM_CODE

The list collection enum code.

See Also:

• getTypeOfCollectionEnum()
• Constant Field Values

SORTED_SET

@Deprecated(since="ages",
            forRemoval=false)
public static final int SORTED_SET

Deprecated.

since ages

The sorted set collection type constants.

See Also:

• getTypeOfCollection()
• Constant Field Values

SORTED_SET_ENUM_CODE

@Deprecated(since="ages",
            forRemoval=false)
public static final String SORTED_SET_ENUM_CODE

Deprecated.

since ages

The sorted set collection enum code.

See Also:

• getTypeOfCollectionEnum()
• Constant Field Values

ELEMENT_TYPE

public static final String ELEMENT_TYPE

The collection element type attribute string constant.

See Also:

• Constant Field Values

TYPE_OF_COLLECTION

public static final String TYPE_OF_COLLECTION

The type of collection attribute string constant.

See Also:

• Constant Field Values

TYPE_OF_COLLECTION_INTERNAL

public static final String TYPE_OF_COLLECTION_INTERNAL

The internal type of collection attribute string constant.

Since this attribute is private is may only be used for FlexibleSearch queries like this example:

 "... WHERE {" + CollectionType.TYPE_OF_COLLECTION_INTERNAL + "} = " + CollectionType.SET + " ..."
 

Its value can be retrieved manually by getTypeOfCollection().

See Also:

• Constant Field Values

Constructor Details

CollectionType

public CollectionType()

Method Details

convertTypeOfCollectionEnumToInt

protected int convertTypeOfCollectionEnumToInt(EnumerationValue enumeration)
                                        throws JaloInvalidParameterException

Converts typeOfCollection enums into intern int codes.

Throws:

JaloInvalidParameterException

convertTypeOfCollectionIntToEnum

protected EnumerationValue convertTypeOfCollectionIntToEnum(int type)
                                                     throws JaloInvalidParameterException

Converts typeOfCollection internal int representation int enum values.

Throws:

JaloInvalidParameterException

createItem

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

Generic item creation method.

Requires the following attributes:

• Type.CODE
• ELEMENT_TYPE

Optionally the type of collection may be defined by TYPE_OF_COLLECTION.

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 attribute values which are already set during actual item creation:

• Type.CODE
• ELEMENT_TYPE
• TYPE_OF_COLLECTION

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.

toString

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

Writes a collection as '(' + escaped element string + ')'. The element string representation is escaped so that each occurence of '(', ')' or ',' is prepended by a '\'.

Specified by:

toString in class Type

Throws:

JaloInvalidParameterException

Since:

2.10

getEscapedCollectionPositions

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

Since:

2.10

escapeForCollection

protected static final String escapeForCollection(String raw)

Since:

2.10

unescapeForCollection

protected static final String unescapeForCollection(String escaped)

Since:

2.10

parseValue

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

reads a collection of '(' + escaped element string + ')'. The element string representation must be escaped so that each occurence of '(', ')' or ',' is prepended by a '\'.

Specified by:

parseValue in class Type

Throws:

JaloInvalidParameterException

Since:

2.10

getElementType

public Type getElementType()

Returns the type of the elements of this collection type.

getElementType

public Type getElementType(SessionContext ctx)

Returns the type of the elements of this collection.

getTypeOfCollection

public int getTypeOfCollection()

Returns:

the internal type of the collection as one of

• SET,
• LIST,
• COLLECTION.

getTypeOfCollectionEnum

public EnumerationValue getTypeOfCollectionEnum()

Returns the type of this collection as enumeration value. The enumeration type can be retrieved using ist code constant TYPE_OF_COLLECTION_ENUM_CODE. Its values got the codes

• COLLECTION_ENUM_CODE
• LIST_ENUM_CODE
• SET_ENUM_CODE
• SORTED_SET_ENUM_CODE

newInstance

public Collection newInstance()

Returns an empty collection if the specified type (see @link #getTypeOfCollection()}).

getXMLDefinition

public String getXMLDefinition()

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

Specified by:

getXMLDefinition in class Type

exportXMLDefinition

public String exportXMLDefinition(org.znerd.xmlenc.XMLOutputter xout)

Specified by:

exportXMLDefinition in class TypeManagerManaged

getCollectionTypeImpl

protected CollectionType.CollectionTypeImpl getCollectionTypeImpl()

Internal access to persistence layer implementation.

isAssignableFrom

public boolean isAssignableFrom(Type type)

Tests whether this collection type is assignable from another collection type. This is only true if this type's element type is assignable from the other collection type's element type and the type of collections are assignable.

Specified by:

isAssignableFrom in class Type

Parameters:

type - the type to be checked.

See Also:

• isTypeAssignableFrom(int, int)

isTypeAssignableFrom

protected boolean isTypeAssignableFrom(int type1,
 int type2)

Checks assignability between types of collection:

• COLLECTION is assignable from all
• SET is assignable from SET and SORTED_SET
• LIST is assignable from LIST and SORTED_SET
• SORTED_SET is assignable from SORTED_SET only

isInstance

public boolean isInstance(Object o)

Tests if a given object is instance of this collection type. This checks the type of collection and each element of being instance of the element type.

Since all elements are checked this method is considerably costly so use with care!

Specified by:

isInstance in class Type

Parameters:

o - the object to be checked.