atg.commerce.endeca.assembler.cartridge.handler

Class CategoryMenuHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.cartridge.RefinementMenuConfig,com.endeca.infront.cartridge.RefinementMenu>

com.endeca.infront.cartridge.RefinementMenuHandler

atg.commerce.endeca.assembler.cartridge.handler.DisplayNameRefinementMenuHandler

atg.commerce.endeca.assembler.cartridge.handler.CategoryMenuHandler

All Implemented Interfaces:

com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.cartridge.RefinementMenuConfig>

public class CategoryMenuHandler
extends atg.commerce.endeca.assembler.cartridge.handler.DisplayNameRefinementMenuHandler

Cartridge handler for the product category dimension The purpose of this class is to filter the category dimension and sieve out those without sites or catalogs relevant to the search request

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.commerce.endeca.assembler.cartridge.handler.DisplayNameRefinementMenuHandler

sLogger

Constructor Summary

Constructors

Constructor and Description
CategoryMenuHandler()

Method Summary

Modifier and Type	Method and Description
com.endeca.infront.cartridge.RefinementMenu	filterFacets(com.endeca.infront.cartridge.RefinementMenu pMenu, java.lang.String[] pSites, java.lang.String[] pCatalogs) Filters category facets for a given set of catalogs and/or sites
CatalogFilterBuilder	getCatalogFilterBuilder() Returns property catalogFilterBuilder
java.lang.String	getCatalogsPropertyName() Returns mCatalogsPropertyName
java.lang.String	getCategoryDimensionName() Returns mCategoryDimensionName
char	getSeparator() Returns property mSeparator.
SiteFilterBuilder	getSiteFilterBuilder() Returns property siteFilterBuilder
java.lang.String	getSitesPropertyName() Returns mSitesPropertyName
boolean	isRelevant(com.endeca.infront.cartridge.model.Refinement pRefinement, java.lang.String[] pSites, java.lang.String[] pCatalogs) Whether a given category relates to the given set of sites and/or catalogs
com.endeca.infront.cartridge.RefinementMenu	process(com.endeca.infront.cartridge.RefinementMenuConfig pCartridgeConfig) Creates a new RefinementMenu with filtered category facets
void	setCatalogFilterBuilder(CatalogFilterBuilder pCatalogFilterBuilder) Sets property catalogFilterBuilder
void	setCatalogsPropertyName(java.lang.String pCatalogsPropertyName) Sets mCatalogsPropertyName
void	setCategoryDimensionName(java.lang.String pCategoryDimensionName) Sets mCategoryDimensionName
void	setSeparator(char pSeparator) Sets property mSeparator.
void	setSiteFilterBuilder(SiteFilterBuilder pSiteFilterBuilder) Sets property siteFilterBuilder
void	setSitesPropertyName(java.lang.String pSitesPropertyName) Sets mSitesPropertyName

Methods inherited from class atg.commerce.endeca.assembler.cartridge.handler.DisplayNameRefinementMenuHandler

getDisplayNameFetcher, setDisplayNameFetcher

Methods inherited from class com.endeca.infront.cartridge.RefinementMenuHandler

preprocess, wrapConfig

Methods inherited from class com.endeca.infront.cartridge.NavigationCartridgeHandler

createMdexRequest, dispatchNavigationEventInformation, executeMdexRequest, executeMdexRequest, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, getUserState, initialize, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState, setSiteState, setUserState

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

CategoryMenuHandler

public CategoryMenuHandler()

Method Detail

getSitesPropertyName

public java.lang.String getSitesPropertyName()

Returns mSitesPropertyName

setSitesPropertyName

public void setSitesPropertyName(java.lang.String pSitesPropertyName)

Sets mSitesPropertyName

getCatalogsPropertyName

public java.lang.String getCatalogsPropertyName()

Returns mCatalogsPropertyName

setCatalogsPropertyName

public void setCatalogsPropertyName(java.lang.String pCatalogsPropertyName)

Sets mCatalogsPropertyName

getCategoryDimensionName

public java.lang.String getCategoryDimensionName()

Returns mCategoryDimensionName

setCategoryDimensionName

public void setCategoryDimensionName(java.lang.String pCategoryDimensionName)

Sets mCategoryDimensionName

setSeparator

public void setSeparator(char pSeparator)

Sets property mSeparator.

getSeparator

public char getSeparator()

Returns property mSeparator.

getSiteFilterBuilder

public SiteFilterBuilder getSiteFilterBuilder()

Returns property siteFilterBuilder

setSiteFilterBuilder

public void setSiteFilterBuilder(SiteFilterBuilder pSiteFilterBuilder)

Sets property siteFilterBuilder

getCatalogFilterBuilder

public CatalogFilterBuilder getCatalogFilterBuilder()

Returns property catalogFilterBuilder

setCatalogFilterBuilder

public void setCatalogFilterBuilder(CatalogFilterBuilder pCatalogFilterBuilder)

Sets property catalogFilterBuilder

process

public com.endeca.infront.cartridge.RefinementMenu process(com.endeca.infront.cartridge.RefinementMenuConfig pCartridgeConfig)
                                                    throws com.endeca.infront.assembler.CartridgeHandlerException

Creates a new RefinementMenu with filtered category facets

Specified by:

process in interface com.endeca.infront.assembler.CartridgeHandler<com.endeca.infront.cartridge.RefinementMenuConfig>

Overrides:

process in class atg.commerce.endeca.assembler.cartridge.handler.DisplayNameRefinementMenuHandler

Throws:

com.endeca.infront.assembler.CartridgeHandlerException

filterFacets

public com.endeca.infront.cartridge.RefinementMenu filterFacets(com.endeca.infront.cartridge.RefinementMenu pMenu,
                                                                java.lang.String[] pSites,
                                                                java.lang.String[] pCatalogs)
                                                         throws com.endeca.infront.assembler.CartridgeHandlerException

Filters category facets for a given set of catalogs and/or sites

Parameters:

pMenu -

pSites - - sites from http request

pCatalogs - - catalogs from http request

Returns:

filtered refinement menu

Throws:

com.endeca.infront.assembler.CartridgeHandlerException

isRelevant

public boolean isRelevant(com.endeca.infront.cartridge.model.Refinement pRefinement,
                          java.lang.String[] pSites,
                          java.lang.String[] pCatalogs)
                   throws com.endeca.infront.assembler.CartridgeHandlerException

Whether a given category relates to the given set of sites and/or catalogs

Parameters:

pRefinement -

pSites - - sites from http request

pCatalogs - - catalogs from http request

Returns:

whether the category should be included

Throws:

com.endeca.infront.assembler.CartridgeHandlerException