de.hybris.platform.acceleratorcms.component.slot.impl

Class DefaultCMSPageSlotComponentService

java.lang.Object

de.hybris.platform.acceleratorcms.component.slot.impl.DefaultCMSPageSlotComponentService

All Implemented Interfaces:

CMSComponentRenderer<AbstractCMSComponentModel>, CMSPageSlotComponentService

public class DefaultCMSPageSlotComponentService
extends java.lang.Object
implements CMSPageSlotComponentService

Default implementation of CMSPageSlotComponentService

Constructor Summary

Constructors

Constructor and Description
DefaultCMSPageSlotComponentService()

Method Summary

Modifier and Type	Method and Description
protected void	addVisibleComponents(CmsPageRequestContextData cmsPageRequestContextData, boolean evaluateRestrictions, int limit, java.util.List<AbstractCMSComponentModel> ret, java.util.List<AbstractCMSComponentModel> replacementComponents)
protected boolean	doesComponentHaveRestrictions(AbstractCMSComponentModel component)
protected java.util.List<AbstractCMSComponentModel>	flattenComponentContainerHierarchy(CmsPageRequestContextData cmsPageRequestContextData, AbstractCMSComponentContainerModel container, boolean evaluateRestrictions, int limit)
protected java.util.List<AbstractCMSComponentModel>	flattenComponentHierarchy(CmsPageRequestContextData cmsPageRequestContextData, AbstractCMSComponentModel component, boolean evaluateRestrictions, int limit)
protected CMSComponentContainerRegistry	getCmsComponentContainerRegistry()
protected CMSComponentRenderer	getCmsComponentRenderer()
protected CMSComponentService	getCmsComponentService()
java.util.List<AbstractCMSComponentModel>	getCMSComponentsForComponent(CmsPageRequestContextData cmsPageRequestContextData, AbstractCMSComponentModel component, boolean evaluateRestrictions, int limit) Get the CMS components for a CMS component.
java.util.List<AbstractCMSComponentModel>	getCMSComponentsForContentSlot(CmsPageRequestContextData cmsPageRequestContextData, ContentSlotModel contentSlot, boolean evaluateRestrictions, int limit) Get the CMS components in a Content Slot.
protected CMSContentSlotService	getCmsContentSlotService()
protected CMSRestrictionService	getCmsRestrictionService()
AbstractCMSComponentModel	getComponentForId(java.lang.String id) Lookup a Component given its ID.
protected java.util.List<AbstractCMSComponentModel>	getComponentsForContainer(AbstractCMSComponentContainerModel container)
ContentSlotModel	getContentSlotForId(java.lang.String id) Lookup a Content Slot given its ID.
ContentSlotData	getContentSlotForPosition(CmsPageRequestContextData cmsPageRequestContextData, java.lang.String position) Lookup the Content Slot data on the current page in the specified position.
boolean	isComponentVisible(CmsPageRequestContextData cmsPageRequestContextData, AbstractCMSComponentModel component, boolean evaluateRestrictions) Checks whether component should be displayed. Note: Computation takes into account: Checks whether component is visible If component is restricted checks whether we should display it
void	renderComponent(PageContext pageContext, AbstractCMSComponentModel component) Render a CMS Component into the page at the current location.
void	setCmsComponentContainerRegistry(CMSComponentContainerRegistry cmsComponentContainerRegistry)
void	setCmsComponentRenderer(CMSComponentRenderer cmsComponentRenderer)
void	setCmsComponentService(CMSComponentService cmsComponentService)
void	setCmsContentSlotService(CMSContentSlotService cmsContentSlotService)
void	setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCMSPageSlotComponentService

public DefaultCMSPageSlotComponentService()

Method Detail

getCmsRestrictionService

protected CMSRestrictionService getCmsRestrictionService()

setCmsRestrictionService

public void setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)

getCmsContentSlotService

protected CMSContentSlotService getCmsContentSlotService()

setCmsContentSlotService

public void setCmsContentSlotService(CMSContentSlotService cmsContentSlotService)

getCmsComponentService

protected CMSComponentService getCmsComponentService()

setCmsComponentService

public void setCmsComponentService(CMSComponentService cmsComponentService)

getCmsComponentRenderer

protected CMSComponentRenderer getCmsComponentRenderer()

setCmsComponentRenderer

public void setCmsComponentRenderer(CMSComponentRenderer cmsComponentRenderer)

getCmsComponentContainerRegistry

protected CMSComponentContainerRegistry getCmsComponentContainerRegistry()

setCmsComponentContainerRegistry

public void setCmsComponentContainerRegistry(CMSComponentContainerRegistry cmsComponentContainerRegistry)

getContentSlotForId

public ContentSlotModel getContentSlotForId(java.lang.String id)

Description copied from interface: CMSPageSlotComponentService

Lookup a Content Slot given its ID.

Specified by:

getContentSlotForId in interface CMSPageSlotComponentService

Parameters:

id - the ID of the content slot

Returns:

the content slot

getContentSlotForPosition

public ContentSlotData getContentSlotForPosition(CmsPageRequestContextData cmsPageRequestContextData,
                                                 java.lang.String position)

Description copied from interface: CMSPageSlotComponentService

Lookup the Content Slot data on the current page in the specified position. The current page is looked up in the CmsPageRequestContextData.

Specified by:

getContentSlotForPosition in interface CMSPageSlotComponentService

Parameters:

cmsPageRequestContextData - The CMS context data for the current request

position - The position in the page

Returns:

the content slot data

getCMSComponentsForContentSlot

public java.util.List<AbstractCMSComponentModel> getCMSComponentsForContentSlot(CmsPageRequestContextData cmsPageRequestContextData,
                                                                                ContentSlotModel contentSlot,
                                                                                boolean evaluateRestrictions,
                                                                                int limit)

Description copied from interface: CMSPageSlotComponentService

Get the CMS components in a Content Slot.

Specified by:

getCMSComponentsForContentSlot in interface CMSPageSlotComponentService

Parameters:

cmsPageRequestContextData - The CMS context data for the current request

contentSlot - The Content Slot

evaluateRestrictions - Flag set to true to indicate that restrictions should be evaluated on the components

limit - A limit on the number of components to return, set to -1 for unlimited

Returns:

the list of components in the slot

flattenComponentHierarchy

protected java.util.List<AbstractCMSComponentModel> flattenComponentHierarchy(CmsPageRequestContextData cmsPageRequestContextData,
                                                                              AbstractCMSComponentModel component,
                                                                              boolean evaluateRestrictions,
                                                                              int limit)

flattenComponentContainerHierarchy

protected java.util.List<AbstractCMSComponentModel> flattenComponentContainerHierarchy(CmsPageRequestContextData cmsPageRequestContextData,
                                                                                       AbstractCMSComponentContainerModel container,
                                                                                       boolean evaluateRestrictions,
                                                                                       int limit)

addVisibleComponents

protected void addVisibleComponents(CmsPageRequestContextData cmsPageRequestContextData,
                                    boolean evaluateRestrictions,
                                    int limit,
                                    java.util.List<AbstractCMSComponentModel> ret,
                                    java.util.List<AbstractCMSComponentModel> replacementComponents)

getComponentsForContainer

protected java.util.List<AbstractCMSComponentModel> getComponentsForContainer(AbstractCMSComponentContainerModel container)

getCMSComponentsForComponent

public java.util.List<AbstractCMSComponentModel> getCMSComponentsForComponent(CmsPageRequestContextData cmsPageRequestContextData,
                                                                              AbstractCMSComponentModel component,
                                                                              boolean evaluateRestrictions,
                                                                              int limit)

Description copied from interface: CMSPageSlotComponentService

Get the CMS components for a CMS component. Some CMS components are actually containers of other components. Depending on the specific component the container may be replaced with some of the child components.

Specified by:

getCMSComponentsForComponent in interface CMSPageSlotComponentService

Parameters:

cmsPageRequestContextData - The CMS context data for the current request

component - The component

evaluateRestrictions - Flag set to true to indicate that restrictions should be evaluated on the components

limit - A limit on the number of components to return, set to -1 for unlimited

Returns:

the list of components

getComponentForId

public AbstractCMSComponentModel getComponentForId(java.lang.String id)

Description copied from interface: CMSPageSlotComponentService

Lookup a Component given its ID.

Specified by:

getComponentForId in interface CMSPageSlotComponentService

Parameters:

id - the ID of the component

Returns:

the component

isComponentVisible

public boolean isComponentVisible(CmsPageRequestContextData cmsPageRequestContextData,
                                  AbstractCMSComponentModel component,
                                  boolean evaluateRestrictions)

Checks whether component should be displayed.

Note: Computation takes into account:

• Checks whether component is visible
• If component is restricted checks whether we should display it

Specified by:

isComponentVisible in interface CMSPageSlotComponentService

Parameters:

cmsPageRequestContextData - The CMS context data for the current request

component - The component

evaluateRestrictions - Flag set to true to indicate that restrictions should be evaluated on the component

Returns:

true if the Component should be shown for this request

doesComponentHaveRestrictions

protected boolean doesComponentHaveRestrictions(AbstractCMSComponentModel component)

renderComponent

public void renderComponent(PageContext pageContext,
                            AbstractCMSComponentModel component)
                     throws ServletException,
                            java.io.IOException

Description copied from interface: CMSComponentRenderer

Render a CMS Component into the page at the current location.

Specified by:

renderComponent in interface CMSComponentRenderer<AbstractCMSComponentModel>

Parameters:

pageContext - The page context to render into

component - The component to render

Throws:

ServletException

java.io.IOException