org.broadleafcommerce.core.web.breadcrumbs

Class SimpleSearchBreadcrumbServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.core.web.breadcrumbs.AbstractBreadcrumbServiceExtensionHandler

org.broadleafcommerce.core.web.breadcrumbs.SimpleSearchBreadcrumbServiceExtensionHandler

All Implemented Interfaces:

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

@Service(value="blSearchBreadcrumbServiceExtensionHandler")
public class SimpleSearchBreadcrumbServiceExtensionHandler
extends AbstractBreadcrumbServiceExtensionHandler

Provides a simple breadcrumb or search, based solely on whether the "q" parameter is present. Relies on the

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.breadcrumbs.service.BreadcrumbServiceExtensionManager	extensionManager
protected boolean	removeAllParamsExceptCategoryId

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
SimpleSearchBreadcrumbServiceExtensionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,String[]>	getBreadcrumbParams(Map<String,String[]> params, org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)
protected String	getBreadcrumbUrl(String url, org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)
int	getDefaultPriority() Implementations must provide a priority for this extension handler as the order determines the breadcrumb order.
protected String	getKeywordParam()
String	getSearchKeyword(String url, Map<String,String[]> params)
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)
protected void	updateContextMap(Map<String,String[]> params, org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder) This handler only manages keyword.

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

removeAllParamsExceptCategoryId

@Value(value="${breadcrumb.removeAllParamsExceptCategoryId:true}")
protected boolean removeAllParamsExceptCategoryId

extensionManager

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

Constructor Detail

SimpleSearchBreadcrumbServiceExtensionHandler

public SimpleSearchBreadcrumbServiceExtensionHandler()

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

getBreadcrumbUrl

protected String getBreadcrumbUrl(String url,
                      org.broadleafcommerce.common.extension.ExtensionResultHolder<List<org.broadleafcommerce.common.breadcrumbs.dto.BreadcrumbDTO>> holder)

getBreadcrumbParams

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

updateContextMap

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

This handler only manages keyword. In a typical usage, we also want to get rid of any facet parameters that may be on the URL.

Parameters:

params -

holder -

getSearchKeyword

public String getSearchKeyword(String url,
                      Map<String,String[]> params)

getKeywordParam

protected String getKeywordParam()

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: