Package org.craftercms.engine.navigation.impl

Class NavBreadcrumbBuilderImpl

java.lang.Object

org.craftercms.engine.navigation.impl.NavBreadcrumbBuilderImpl

All Implemented Interfaces:

NavBreadcrumbBuilder

public class NavBreadcrumbBuilderImpl
extends Object
implements NavBreadcrumbBuilder

Default implementation of NavBreadcrumbBuilderImpl.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BREADCRUMB_CONST_KEY_ELEM
protected org.craftercms.commons.converters.Converter<SiteItem,NavItem>	defaultItemConverter
protected org.craftercms.core.processors.ItemProcessor	processor
protected SiteItemService	siteItemService

Constructor Summary

Constructors

Constructor	Description
NavBreadcrumbBuilderImpl()

Method Summary

Modifier and Type	Method	Description
protected String	extractBreadcrumbUrl(String url, String root)
List<NavItem>	getBreadcrumb(String url, String root)	Returns the navigation items that form the breadcrumb for the specified store URL.
List<NavItem>	getBreadcrumb(String url, String root, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)	Returns the navigation items that form the breadcrumb for the specified store URL.
void	setDefaultItemConverter(org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter)
void	setProcessor(org.craftercms.core.processors.ItemProcessor processor)
void	setProcessors(List<org.craftercms.core.processors.ItemProcessor> processors)
void	setSiteItemService(SiteItemService siteItemService)

Methods inherited from class java.lang.Object

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

Field Details

BREADCRUMB_CONST_KEY_ELEM

public static final String BREADCRUMB_CONST_KEY_ELEM

See Also:

• Constant Field Values

siteItemService

protected SiteItemService siteItemService

processor

protected org.craftercms.core.processors.ItemProcessor processor

defaultItemConverter

protected org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter

Constructor Details

NavBreadcrumbBuilderImpl

public NavBreadcrumbBuilderImpl()

Method Details

setSiteItemService

public void setSiteItemService(SiteItemService siteItemService)

setProcessor

public void setProcessor(org.craftercms.core.processors.ItemProcessor processor)

setProcessors

public void setProcessors(List<org.craftercms.core.processors.ItemProcessor> processors)

setDefaultItemConverter

public void setDefaultItemConverter(org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter)

getBreadcrumb

public List<NavItem> getBreadcrumb(String url,
 String root)

Description copied from interface: NavBreadcrumbBuilder

Returns the navigation items that form the breadcrumb for the specified store URL.

Specified by:

getBreadcrumb in interface NavBreadcrumbBuilder

Parameters:

url - the current URL used to build the breadcrumb

root - the root URL, basically the starting point of the breadcrumb

Returns:

the list of NavItems that represent the breadcrumb

getBreadcrumb

public List<NavItem> getBreadcrumb(String url,
 String root,
 org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)

Description copied from interface: NavBreadcrumbBuilder

Returns the navigation items that form the breadcrumb for the specified store URL.

Specified by:

getBreadcrumb in interface NavBreadcrumbBuilder

Parameters:

url - the current URL used to build the breadcrumb

root - the root URL, basically the starting point of the breadcrumb

itemConverter - the converter that should be used to convert from SiteItems to the actual NavItems

Returns:

the list of NavItems that represent the breadcrumb

extractBreadcrumbUrl

protected String extractBreadcrumbUrl(String url,
 String root)