org.broadleafcommerce.core.web.breadcrumbs

Class CategoryBreadcrumbServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.core.web.breadcrumbs.AbstractBreadcrumbServiceExtensionHandler

org.broadleafcommerce.core.web.breadcrumbs.CategoryBreadcrumbServiceExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.breadcrumbs.service.BreadcrumbServiceExtensionHandler, org.broadleafcommerce.common.extension.ExtensionHandler

@Service(value="blCategoryBreadcrumbServiceExtensionHandler")
public class CategoryBreadcrumbServiceExtensionHandler
extends AbstractBreadcrumbServiceExtensionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected CatalogService	catalogService
protected org.broadleafcommerce.common.breadcrumbs.service.BreadcrumbServiceExtensionManager	extensionManager

Fields inherited from class org.broadleafcommerce.core.web.breadcrumbs.AbstractBreadcrumbServiceExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
CategoryBreadcrumbServiceExtensionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addParentCrumbs(List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO> parentCrumbs, Category category, String url, Map<String,String[]> params) Add the parent crumb for the passed in category.
protected org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO	buildCategorySearchCrumb(Category category, String url, Map<String,String[]> params) Hook for overrides, some implementations may want to build a crumb related to category filtering.
protected org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO	buildCrumbForCategory(Category category, String url, Map<String,String[]> params)
protected Category	determineFirstCategory(String testUrl, Map<String,String[]> params, org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)
protected Category	getCategoryFromCategoryAttribute(org.broadleafcommerce.common.web.BroadleafRequestContext brc, String testUrl, Map<String,String[]> params) This indicates that we are on a category page
protected Category	getCategoryFromUrl(org.broadleafcommerce.common.web.BroadleafRequestContext brc, String requestUrl, Map<String,String[]> params)
int	getDefaultPriority() Implementations must provide a priority for this extension handler as the order determines the breadcrumb order.
protected Category	getMatchingCategoryFromProduct(org.broadleafcommerce.common.web.BroadleafRequestContext brc, String testUrl, Map<String,String[]> params) This is an efficient test that checks to see if the requestURI matches the product URI.
protected String	getNameForCategoryLink(Category category)
void	init()
org.broadleafcommerce.common.extension.ExtensionResultStatusType	modifyBreadcrumbList(String url, Map<String,String[]> params, org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)

Methods inherited from class org.broadleafcommerce.core.web.breadcrumbs.AbstractBreadcrumbServiceExtensionHandler

buildLink, getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Field Detail

catalogService

protected CatalogService catalogService

extensionManager

protected org.broadleafcommerce.common.breadcrumbs.service.BreadcrumbServiceExtensionManager extensionManager

Constructor Detail

CategoryBreadcrumbServiceExtensionHandler

public CategoryBreadcrumbServiceExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

modifyBreadcrumbList

public org.broadleafcommerce.common.extension.ExtensionResultStatusType modifyBreadcrumbList(String url,
                                                                                    Map<String,String[]> params,
                                                                                    org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)

Specified by:

modifyBreadcrumbList in interface org.broadleafcommerce.common.breadcrumbs.service.BreadcrumbServiceExtensionHandler

Overrides:

modifyBreadcrumbList in class AbstractBreadcrumbServiceExtensionHandler

buildCrumbForCategory

protected org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO buildCrumbForCategory(Category category,
                                                                               String url,
                                                                               Map<String,String[]> params)

addParentCrumbs

protected void addParentCrumbs(List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO> parentCrumbs,
                   Category category,
                   String url,
                   Map<String,String[]> params)

Add the parent crumb for the passed in category. Recursively call to find all parents.

Parameters:

parentCrumbs -

category -

url -

params -

buildCategorySearchCrumb

protected org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO buildCategorySearchCrumb(Category category,
                                                                                  String url,
                                                                                  Map<String,String[]> params)

Hook for overrides, some implementations may want to build a crumb related to category filtering. Out of box does nothing here.

Parameters:

category -

url -

params -

Returns:

getNameForCategoryLink

protected String getNameForCategoryLink(Category category)

determineFirstCategory

protected Category determineFirstCategory(String testUrl,
                              Map<String,String[]> params,
                              org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)

getMatchingCategoryFromProduct

protected Category getMatchingCategoryFromProduct(org.broadleafcommerce.common.web.BroadleafRequestContext brc,
                                      String testUrl,
                                      Map<String,String[]> params)

This is an efficient test that checks to see if the requestURI matches the product URI. This works well for sites whose category urls prefix their product urls.

Parameters:

brc -

testUrl -

params -

Returns:

getCategoryFromCategoryAttribute

protected Category getCategoryFromCategoryAttribute(org.broadleafcommerce.common.web.BroadleafRequestContext brc,
                                        String testUrl,
                                        Map<String,String[]> params)

This indicates that we are on a category page

Parameters:

brc -

testUrl -

params -

Returns:

getCategoryFromUrl

protected Category getCategoryFromUrl(org.broadleafcommerce.common.web.BroadleafRequestContext brc,
                          String requestUrl,
                          Map<String,String[]> params)

getDefaultPriority

public int getDefaultPriority()

Description copied from class: AbstractBreadcrumbServiceExtensionHandler

Implementations must provide a priority for this extension handler as the order determines the breadcrumb order.

Specified by:

getDefaultPriority in class AbstractBreadcrumbServiceExtensionHandler

Returns: