Package de.hybris.platform.cmsfacades.types.service.impl

Class GenericComponentTypeStructureService

java.lang.Object

de.hybris.platform.cmsfacades.types.service.impl.GenericComponentTypeStructureService

All Implemented Interfaces:

ComponentTypeStructureService, org.springframework.beans.factory.InitializingBean

public class GenericComponentTypeStructureService
extends java.lang.Object
implements ComponentTypeStructureService, org.springframework.beans.factory.InitializingBean

Implementation of the ComponentTypeStructureService that first attempts to get type using the registered structure type ComponentTypeStructureRegistry.getComponentTypeStructure(String). As a fallback strategy, it creates an instance of the ComponentTypeStructure by introspecting the Type and its attributes. This service will be first lookup for the ComposedTypeModel and check if one of its super type is CMSItemModel. If it passes this verification, then it will convert an instance of ComposedTypeModel into a new instance of ComponentTypeStructure.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.Long	DEFAULT_EXPIRATION_TIME

Constructor Summary

Constructors

Constructor	Description
GenericComponentTypeStructureService()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected void	collectExtraAttributesFromTypeAndAncestorsInRegistry(ComposedTypeModel composedType, java.util.Set<ComponentTypeAttributeStructure> attributes)	Recursively collects extra attributes that are not in the Data Model, but it is present on the the registry
protected void	collectTypePopulatorsFromTypeAndAncestorsInRegistry(ComposedTypeModel composedType, java.util.List<Populator<ComposedTypeModel,ComponentTypeData>> populators)	Recursively collects type populators from the registry until it reaches the root type (CMSItem)
ComponentTypeStructure	getComponentTypeStructure(java.lang.String typeCode)	Get a ComponentTypeStructure by its typecode.
protected ComponentTypeStructure	getComponentTypeStructureInternal(java.lang.String typeCode)	Internal method to get the component type structure for a given typeCode
protected ComponentTypeStructureRegistry	getComponentTypeStructureRegistry()
java.util.Collection<ComponentTypeStructure>	getComponentTypeStructures()	Get all elements in the registry.
protected Converter<ComposedTypeModel,ComponentTypeStructure>	getComposedTypeToStructureConverter()
protected ConfigurationService	getConfigurationService()
protected com.google.common.base.Supplier<java.util.Map<java.lang.String,ComponentTypeStructure>>	getInternalComponentTypeStructureMap()
protected java.util.Set<java.lang.String>	getTypeBlacklistSet()
protected TypeService	getTypeService()
protected com.google.common.base.Supplier<java.util.Map<java.lang.String,ComponentTypeStructure>>	initializeComponentTypeStructureMap()	Supplier function to initialize the ComponentTypeStructure map.
protected com.google.common.base.Supplier<java.util.Map<java.lang.String,ComponentTypeStructure>>	initializeInternalStructureMap(java.lang.Long expirationTime)
protected java.util.function.Predicate<java.lang.String>	isAbstractType()	Predicate to test if the composed type represented by the typeCode is abstract.
void	setComponentTypeStructureRegistry(ComponentTypeStructureRegistry componentTypeStructureRegistry)
void	setComposedTypeToStructureConverter(Converter<ComposedTypeModel,ComponentTypeStructure> composedTypeToStructureConverter)
void	setConfigurationService(ConfigurationService configurationService)
void	setTypeBlacklistSet(java.util.Set<java.lang.String> typeBlacklistSet)
void	setTypeService(TypeService typeService)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPIRATION_TIME

protected static final java.lang.Long DEFAULT_EXPIRATION_TIME

Constructor Detail

GenericComponentTypeStructureService

public GenericComponentTypeStructureService()

Method Detail

getComponentTypeStructure

public ComponentTypeStructure getComponentTypeStructure(java.lang.String typeCode)

Description copied from interface: ComponentTypeStructureService

Get a ComponentTypeStructure by its typecode.

Specified by:

getComponentTypeStructure in interface ComponentTypeStructureService

Parameters:

typeCode - - the typeCode of the element to retrieve.

Returns:

the element matching the typeCode

Throws:

UnknownIdentifierException - when the typeCode does not exist

ConversionException - when the type requested does not extend CMSItem

getComponentTypeStructures

public java.util.Collection<ComponentTypeStructure> getComponentTypeStructures()

Description copied from interface: ComponentTypeStructureService

Get all elements in the registry.

Specified by:

getComponentTypeStructures in interface ComponentTypeStructureService

Returns:

all items in the registry or an empty collection if no elements are found.

initializeComponentTypeStructureMap

protected com.google.common.base.Supplier<java.util.Map<java.lang.String,ComponentTypeStructure>> initializeComponentTypeStructureMap()

Supplier function to initialize the ComponentTypeStructure map.

isAbstractType

protected java.util.function.Predicate<java.lang.String> isAbstractType()

Predicate to test if the composed type represented by the typeCode is abstract.

Returns TRUE if the composed type is abstract.

getComponentTypeStructureInternal

protected ComponentTypeStructure getComponentTypeStructureInternal(java.lang.String typeCode)

Internal method to get the component type structure for a given typeCode

Parameters:

typeCode - the type code that represents the component type structure

Returns:

the ComponentTypeStructure represented by this typeCode.

collectTypePopulatorsFromTypeAndAncestorsInRegistry

protected void collectTypePopulatorsFromTypeAndAncestorsInRegistry(ComposedTypeModel composedType,
                                                                   java.util.List<Populator<ComposedTypeModel,ComponentTypeData>> populators)

Recursively collects type populators from the registry until it reaches the root type (CMSItem)

Parameters:

composedType - the type being used to look for populators

populators - the list of populators that has to be modified

collectExtraAttributesFromTypeAndAncestorsInRegistry

protected void collectExtraAttributesFromTypeAndAncestorsInRegistry(ComposedTypeModel composedType,
                                                                    java.util.Set<ComponentTypeAttributeStructure> attributes)

Recursively collects extra attributes that are not in the Data Model, but it is present on the the registry

Parameters:

composedType - the type being used to look for populators

attributes -

getInternalComponentTypeStructureMap

protected com.google.common.base.Supplier<java.util.Map<java.lang.String,ComponentTypeStructure>> getInternalComponentTypeStructureMap()

initializeInternalStructureMap

protected com.google.common.base.Supplier<java.util.Map<java.lang.String,ComponentTypeStructure>> initializeInternalStructureMap(java.lang.Long expirationTime)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getTypeBlacklistSet

protected java.util.Set<java.lang.String> getTypeBlacklistSet()

setTypeBlacklistSet

public void setTypeBlacklistSet(java.util.Set<java.lang.String> typeBlacklistSet)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getComposedTypeToStructureConverter

protected Converter<ComposedTypeModel,ComponentTypeStructure> getComposedTypeToStructureConverter()

setComposedTypeToStructureConverter

public void setComposedTypeToStructureConverter(Converter<ComposedTypeModel,ComponentTypeStructure> composedTypeToStructureConverter)

getComponentTypeStructureRegistry

protected ComponentTypeStructureRegistry getComponentTypeStructureRegistry()

setComponentTypeStructureRegistry

public void setComponentTypeStructureRegistry(ComponentTypeStructureRegistry componentTypeStructureRegistry)