Package de.hybris.platform.cmsfacades.synchronization.itemvisitors

Class AbstractCMSComponentModelVisitor<CMSCOMPONENTTYPE extends AbstractCMSComponentModel>

java.lang.Object

de.hybris.platform.cmsfacades.synchronization.itemvisitors.AbstractCMSComponentModelVisitor<CMSCOMPONENTTYPE>

Type Parameters:

CMSCOMPONENTTYPE - the component type that extends AbstractCMSComponentModel

All Implemented Interfaces:

ItemVisitor<CMSCOMPONENTTYPE>

Direct Known Subclasses:

AbstractCMSComponentContainerModelVisitor, AbstractMediaContainerComponentModelVisitor, CMSLinkComponentModelVisitor, DefaultAbstractCMSComponentModelVisitor, NavigationBarCollectionComponentModelVisitor, NavigationBarComponentModelVisitor, NavigationComponentModelVisitor

public abstract class AbstractCMSComponentModelVisitor<CMSCOMPONENTTYPE extends AbstractCMSComponentModel>
extends java.lang.Object
implements ItemVisitor<CMSCOMPONENTTYPE>

Abstract class for visiting AbstractCMSComponentModel models for the cms synchronization service to work properly. In this implementation, it will collect all component's child (collection or not) extending or being CMSItemModel

Constructor Summary

Constructors

Constructor	Description
AbstractCMSComponentModelVisitor()

Method Summary

Modifier and Type	Method	Description
protected void	collectChildItems(CMSCOMPONENTTYPE source, java.util.List<ItemModel> toVisit, AttributeDescriptorModel attributeDescriptorModel)	Collects all child items of type CMSItemModel for the provided source component.
protected AttributeDescriptorModelHelperService	getAttributeDescriptorModelHelperService()
protected java.lang.Object	getAttributeValue(CMSCOMPONENTTYPE source, AttributeDescriptorModel attributeDescriptorModel)	Gets the value by calling the getter for the attribute defined by the provided attribute descriptor.
protected ModelService	getModelService()
protected TypeService	getTypeService()
protected boolean	isClassAssignableFrom(java.lang.Class clazz, AttributeDescriptorModel attributeDescriptor)
void	setAttributeDescriptorModelHelperService(AttributeDescriptorModelHelperService attributeDescriptorModelHelperService)
void	setModelService(ModelService modelService)
void	setTypeService(TypeService typeService)
java.util.List<ItemModel>	visit(CMSCOMPONENTTYPE source, java.util.List<ItemModel> arg1, java.util.Map<java.lang.String,java.lang.Object> arg2)	Returns visited items for a given theSource item within given contest ctx

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCMSComponentModelVisitor

public AbstractCMSComponentModelVisitor()

Method Detail

visit

public java.util.List<ItemModel> visit(CMSCOMPONENTTYPE source,
                                       java.util.List<ItemModel> arg1,
                                       java.util.Map<java.lang.String,java.lang.Object> arg2)

Description copied from interface: ItemVisitor

Returns visited items for a given theSource item within given contest ctx

Specified by:

visit in interface ItemVisitor<CMSCOMPONENTTYPE extends AbstractCMSComponentModel>

Parameters:

source - given item

arg1 - path to given item

arg2 - visitor context

Returns:

relevant items for a given theSource item

collectChildItems

protected void collectChildItems(CMSCOMPONENTTYPE source,
                                 java.util.List<ItemModel> toVisit,
                                 AttributeDescriptorModel attributeDescriptorModel)

Collects all child items of type CMSItemModel for the provided source component.

Parameters:

source - - the component which attributes is inspected to collect child items

toVisit - - the list of items collected which will be used by the synchronization service

attributeDescriptorModel - - the attribute descriptor object containing the information about the attribute of interest

getAttributeValue

protected java.lang.Object getAttributeValue(CMSCOMPONENTTYPE source,
                                             AttributeDescriptorModel attributeDescriptorModel)

Gets the value by calling the getter for the attribute defined by the provided attribute descriptor.

When the attribute is not readable (due to configurations in *items.xml), the ModelService will return an AttributeNotSupportedException and the attribute will not be added to the list of items to visit by the synchronization service.

Parameters:

source - - the source object which the getter method will be called

attributeDescriptorModel - - the attribute descriptor object containing the information about the attribute of interest

Returns:

the result of the getter; can be NULL

isClassAssignableFrom

protected boolean isClassAssignableFrom(java.lang.Class clazz,
                                        AttributeDescriptorModel attributeDescriptor)

getTypeService

protected TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getAttributeDescriptorModelHelperService

protected AttributeDescriptorModelHelperService getAttributeDescriptorModelHelperService()

setAttributeDescriptorModelHelperService

public void setAttributeDescriptorModelHelperService(AttributeDescriptorModelHelperService attributeDescriptorModelHelperService)