atg.commerce.endeca.assembler.cartridge.handler

Class DimensionValueCacheRefreshHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<com.endeca.infront.cartridge.DimensionSearchResultsConfig,com.endeca.infront.cartridge.DimensionSearchResults>

com.endeca.infront.cartridge.DimensionSearchResultsHandler

atg.commerce.endeca.assembler.cartridge.handler.DimensionValueCacheRefreshHandler

All Implemented Interfaces:

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

public class DimensionValueCacheRefreshHandler
extends com.endeca.infront.cartridge.DimensionSearchResultsHandler

A cartridge handler used to query for every dimension value stored in the MDEX for a particular dimension. The results are then used to build a cache of ATG repository ids to dimension values (and other optional information).

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DimensionValueCacheRefreshHandler()

Method Summary

Modifier and Type	Method and Description
protected com.endeca.infront.cartridge.model.DimensionSearchGroup	getDimension(com.endeca.infront.cartridge.DimensionSearchResults pDimensionSearchResults) Loops through all dimensions for the dimension specified by the dimensionName.
java.lang.String	getDimensionName()
protected com.endeca.infront.navigation.model.SearchFilter	getDimensionSearchFilter(com.endeca.infront.navigation.NavigationState navigationState) Gets the SearchFilter used for the dimension search.
DimensionValueCacheTools	getDimensionValueCacheTools()
com.endeca.infront.navigation.NavigationStateBuilder	getNavigationStateBuilder()
java.lang.String	getRepositoryIdProperty()
protected java.lang.String	parseDimvalId(java.lang.String pNavState) Dimension values returned don't contain their dimval id so we need to parse it from the navigation state.
com.endeca.infront.cartridge.DimensionSearchResults	process(com.endeca.infront.cartridge.DimensionSearchResultsConfig pConfig) An override of the DimensionSearchResultsHandlers process method.
void	setDimensionName(java.lang.String pDimensionName)
void	setDimensionValueCacheTools(DimensionValueCacheTools pDimensionValueCacheTools)
void	setNavigationStateBuilder(com.endeca.infront.navigation.NavigationStateBuilder pNavigationStateBuilder)
void	setRepositoryIdProperty(java.lang.String pRepositoryIdProperty)

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

createDimensionSearchNavigationState, 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

DimensionValueCacheRefreshHandler

public DimensionValueCacheRefreshHandler()

Method Detail

getDimensionName

public java.lang.String getDimensionName()

Returns:

the dimensionName which is the name of the dimension to retrieve values from. Defaults to product.category.

setDimensionName

public void setDimensionName(java.lang.String pDimensionName)

Parameters:

mDimensionName - the mDimensionName to set

getRepositoryIdProperty

public java.lang.String getRepositoryIdProperty()

Returns:

the mRepositoryIdProperty which is the name of the property within the dimension that indicates this particular items repository id. Defaults to category.repositoryId.

setRepositoryIdProperty

public void setRepositoryIdProperty(java.lang.String pRepositoryIdProperty)

Parameters:

mRepositoryIdProperty - the mRepositoryIdProperty to set.

getDimensionValueCacheTools

public DimensionValueCacheTools getDimensionValueCacheTools()

Returns:

the mDimensionValueCacheTools. A tools class that contains useful and common methods.

setDimensionValueCacheTools

public void setDimensionValueCacheTools(DimensionValueCacheTools pDimensionValueCacheTools)

Parameters:

mDimensionValueCacheTools - the mDimensionValueCacheTools to set.

getNavigationStateBuilder

public com.endeca.infront.navigation.NavigationStateBuilder getNavigationStateBuilder()

Returns:

The NavigationStateBuilder used to create this handlers NavigationState.

setNavigationStateBuilder

public void setNavigationStateBuilder(com.endeca.infront.navigation.NavigationStateBuilder pNavigationStateBuilder)

Parameters:

pNavigationStateBuilder - Set the navigationStateBuilder

process

public com.endeca.infront.cartridge.DimensionSearchResults process(com.endeca.infront.cartridge.DimensionSearchResultsConfig pConfig)
                                                            throws com.endeca.infront.assembler.CartridgeHandlerException

An override of the DimensionSearchResultsHandlers process method. Makes a request to the MDEX for all the dimension values within the dimensionName property. The repositoryId, dimension value id and optionally the url for this item and ancestor repository ids are extracted and stored within the cache.

Specified by:

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

Overrides:

process in class com.endeca.infront.cartridge.DimensionSearchResultsHandler

Throws:

com.endeca.infront.assembler.CartridgeHandlerException

parseDimvalId

protected java.lang.String parseDimvalId(java.lang.String pNavState)

Dimension values returned don't contain their dimval id so we need to parse it from the navigation state. This method retrieves the dimval ID from standard and SEO formatted URLs

Parameters:

pNavState - The navigation state string to be parsed.

Returns:

The dimension value ID parsed from the navigation state.

getDimensionSearchFilter

protected com.endeca.infront.navigation.model.SearchFilter getDimensionSearchFilter(com.endeca.infront.navigation.NavigationState navigationState)

Gets the SearchFilter used for the dimension search. Specifies a wildcard, which allows all results to be returned.

Overrides:

getDimensionSearchFilter in class com.endeca.infront.cartridge.DimensionSearchResultsHandler

Parameters:

navigationState - the global NavigationState object

getDimension

protected com.endeca.infront.cartridge.model.DimensionSearchGroup getDimension(com.endeca.infront.cartridge.DimensionSearchResults pDimensionSearchResults)

Loops through all dimensions for the dimension specified by the dimensionName.

Parameters:

pDimensionSearchResults -

Returns: