Package de.hybris.platform.cmsfacades.types.converter

Class ComponentTypeStructureConverter

java.lang.Object

de.hybris.platform.cmsfacades.types.converter.ComponentTypeStructureConverter

All Implemented Interfaces:

Converter<ComponentTypeStructure,ComponentTypeData>, org.springframework.core.convert.converter.Converter<ComponentTypeStructure,ComponentTypeData>

public class ComponentTypeStructureConverter
extends java.lang.Object
implements Converter<ComponentTypeStructure,ComponentTypeData>

Converter use to convert a ComponentTypeStructure to a ComponentTypeData.

Constructor Summary

Constructors

Constructor	Description
ComponentTypeStructureConverter()

Method Summary

Modifier and Type	Method	Description
protected AttributeDescriptorModel	buildAttributeDescriptorModel(ComposedTypeModel composedTypeModel, ComponentTypeAttributeStructure attribute)	Creates a new AttributeDescriptor with basic data copied from the provided attribute.
ComponentTypeData	convert(ComponentTypeStructure source)	Converts the source object, creating a new instance of the destination type
ComponentTypeData	convert(ComponentTypeStructure source, ComponentTypeData target)	Convert the source object by filling the prototype
protected ComponentTypeAttributeData	convertAttribute(ComponentTypeAttributeStructure attribute, AttributeDescriptorModel attributeDescriptor)	Convert the attribute descriptor to a POJO using the structure attribute's populators.
protected ComponentTypeAttributeData	convertAttributeAndEvaluatePermissions(ComposedTypeModel composedType, ComponentTypeAttributeStructure attributeStructure)	This method converts the attribute attribute descriptor to a POJO using the structure attribute's populators and evaluates its permissions.
protected boolean	enclosingTypeHasAttribute(ComposedTypeModel enclosingType, java.lang.String qualifier)	Checks whether the component type contains the attribute identified by the qualifier provided.
protected AttributeDescriptorModel	getAttributeDescriptor(ComposedTypeModel type, ComponentTypeAttributeStructure originalAttribute)	Get AttributeDescriptor matching with the qualifier of the attribute for the type provided.
protected CMSAdminSiteService	getCmsAdminSiteService()
protected CMSPermissionChecker	getCmsPermissionChecker()
protected org.springframework.beans.factory.ObjectFactory<ComponentTypeAttributeData>	getComponentTypeAttributeDataFactory()
protected PermissionCRUDService	getPermissionCRUDService()
protected StringDecapitalizer	getStringDecapitalizer()
protected TypeService	getTypeService()
protected boolean	hasReadPermissionOnAttribute(AttributeDescriptorModel attributeDescriptorModel)	Checks whether the current principal has read permission on the attribute provided.
protected boolean	isReadOnlyMode()	Checks whether the structure api should return fields in read only mode (editable = false)
void	setCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService)
void	setCmsPermissionChecker(CMSPermissionChecker cmsPermissionChecker)
void	setComponentTypeAttributeDataFactory(org.springframework.beans.factory.ObjectFactory<ComponentTypeAttributeData> componentTypeAttributeDataFactory)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
void	setStringDecapitalizer(StringDecapitalizer stringDecapitalizer)
void	setTypeService(TypeService typeService)
protected void	throwTypePermissionException(java.lang.String permissionName, java.lang.String typeCode)	Throws TypePermissionException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.servicelayer.dto.converter.Converter

convertAll, convertAllIgnoreExceptions, getLogger

Constructor Detail

ComponentTypeStructureConverter

public ComponentTypeStructureConverter()

Method Detail

convert

public ComponentTypeData convert(ComponentTypeStructure source)
                          throws ConversionException

Description copied from interface: Converter

Converts the source object, creating a new instance of the destination type

Specified by:

convert in interface Converter<ComponentTypeStructure,ComponentTypeData>

Specified by:

convert in interface org.springframework.core.convert.converter.Converter<ComponentTypeStructure,ComponentTypeData>

Parameters:

source - the source object

Returns:

the converted object

Throws:

ConversionException - if an error occurs

convert

public ComponentTypeData convert(ComponentTypeStructure source,
                                 ComponentTypeData target)
                          throws ConversionException

Description copied from interface: Converter

Convert the source object by filling the prototype

Specified by:

convert in interface Converter<ComponentTypeStructure,ComponentTypeData>

Parameters:

source - the source object

target - the prototype to fill

Returns:

the converted object, identical to the prototype

Throws:

ConversionException - if an error occurs

throwTypePermissionException

protected void throwTypePermissionException(java.lang.String permissionName,
                                            java.lang.String typeCode)

Throws TypePermissionException.

Parameters:

permissionName - permission name

typeCode - type code

buildAttributeDescriptorModel

protected AttributeDescriptorModel buildAttributeDescriptorModel(ComposedTypeModel composedTypeModel,
                                                                 ComponentTypeAttributeStructure attribute)

Creates a new AttributeDescriptor with basic data copied from the provided attribute.

Parameters:

composedTypeModel - - the composed type model containing the provided attribute

attribute - - the attribute from where to copy the new descriptor data

Returns:

the newly created attribute descriptor

getAttributeDescriptor

protected AttributeDescriptorModel getAttributeDescriptor(ComposedTypeModel type,
                                                          ComponentTypeAttributeStructure originalAttribute)

Get AttributeDescriptor matching with the qualifier of the attribute for the type provided.

Parameters:

type - - the composed type model in which to search for the descriptor

originalAttribute - - the attribute whose descriptor to search for.

Returns:

the attribute descriptor matching the given criteria

convertAttribute

protected ComponentTypeAttributeData convertAttribute(ComponentTypeAttributeStructure attribute,
                                                      AttributeDescriptorModel attributeDescriptor)

Convert the attribute descriptor to a POJO using the structure attribute's populators.

Parameters:

attribute - - the structure type attribute

attributeDescriptor - - the attribute descriptor

Returns:

the component type attribute POJO

convertAttributeAndEvaluatePermissions

protected ComponentTypeAttributeData convertAttributeAndEvaluatePermissions(ComposedTypeModel composedType,
                                                                            ComponentTypeAttributeStructure attributeStructure)

This method converts the attribute attribute descriptor to a POJO using the structure attribute's populators and evaluates its permissions.

Parameters:

composedType - - the composed type model containing the attribute to convert.

attributeStructure - - the attribute to convert

Returns:

the component type attribute POJO. Will be null if user has no read-permissions.

isReadOnlyMode

protected boolean isReadOnlyMode()

Checks whether the structure api should return fields in read only mode (editable = false)

Returns:

TRUE if the read only mode is used, FALSE otherwise.

hasReadPermissionOnAttribute

protected boolean hasReadPermissionOnAttribute(AttributeDescriptorModel attributeDescriptorModel)

Checks whether the current principal has read permission on the attribute provided.

Parameters:

attributeDescriptorModel - - The descriptor that specifies the attribute whose read permission to check.

Returns:

true if the current principal has been granted read permission on the attribute; false otherwise.

Throws:

AttributePermissionException - - When principal does not have read permission for a required attribute.

enclosingTypeHasAttribute

protected boolean enclosingTypeHasAttribute(ComposedTypeModel enclosingType,
                                            java.lang.String qualifier)

Checks whether the component type contains the attribute identified by the qualifier provided.

Parameters:

enclosingType - - The item where to look for the expected attribute

qualifier - - The qualifier of the attribute to find

Returns:

true if the attribute is found; false otherwise.

getStringDecapitalizer

protected StringDecapitalizer getStringDecapitalizer()

setStringDecapitalizer

public void setStringDecapitalizer(StringDecapitalizer stringDecapitalizer)

getComponentTypeAttributeDataFactory

protected org.springframework.beans.factory.ObjectFactory<ComponentTypeAttributeData> getComponentTypeAttributeDataFactory()

setComponentTypeAttributeDataFactory

public void setComponentTypeAttributeDataFactory(org.springframework.beans.factory.ObjectFactory<ComponentTypeAttributeData> componentTypeAttributeDataFactory)

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getPermissionCRUDService

protected PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)

getCmsPermissionChecker

protected CMSPermissionChecker getCmsPermissionChecker()

setCmsPermissionChecker

public void setCmsPermissionChecker(CMSPermissionChecker cmsPermissionChecker)

getCmsAdminSiteService

protected CMSAdminSiteService getCmsAdminSiteService()

setCmsAdminSiteService

public void setCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService)