com.endeca.infront.cartridge

Class NavigationContainerHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

com.endeca.infront.cartridge.NavigationContainerHandler

public class NavigationContainerHandler
extends NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Handles slot invocations to create a list of refinements based on the user specified order. If the refinements slot is not configured, or if the resolved rule's navigation is empty, the handler returns all available navigation refinements.

Constructor Summary

Constructors

Constructor and Description
NavigationContainerHandler()

Method Summary

Modifier and Type	Method and Description
String	getRefinementMenuType() Returns the RefinementMenu type.
void	preprocess(NavigationContainerConfig pContentItem) If the refinements slot is configured and the first resolved rule has a non empty list of refinements (provided by "navigation" key), then we use this non-empty list.
NavigationContainer	process(NavigationContainerConfig pContentItem) If the refinements slot is configured and resolved, use the explicit refinements order to create the output NavigationContainer model.
void	setAttributeConfigurationManager(AttributeConfigurationManager manager)
void	setAttributeDisplayConfigManager(AttributeDisplayConfigManager manager) Deprecated.
void	setContentBroker(ContentBroker pContentBroker)
void	setContentSource(ContentSource pContentSource)
void	setDimensionCacheManager(com.endeca.infront.navigation.cache.DimensionCacheManager manager)
void	setRefinementMenuType(String refinementMenuType) Sets the type for RefinementMenus created by this class.
protected NavigationContainerConfig	wrapConfig(ContentItem pContentItem) Wraps the input ContentItem as a typed config object.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationContainerHandler

public NavigationContainerHandler()

Method Detail

setAttributeDisplayConfigManager

public void setAttributeDisplayConfigManager(AttributeDisplayConfigManager manager)

Deprecated.

Use setAttributeConfigurationManager(AttributeConfigurationManager) instead.

setAttributeConfigurationManager

public void setAttributeConfigurationManager(AttributeConfigurationManager manager)

setDimensionCacheManager

public void setDimensionCacheManager(com.endeca.infront.navigation.cache.DimensionCacheManager manager)

getRefinementMenuType

public String getRefinementMenuType()

Returns the RefinementMenu type.

Returns:

RefinementMenu type for this cartridge handler

See Also:

setRefinementMenuType(String)

setRefinementMenuType

public void setRefinementMenuType(String refinementMenuType)

Sets the type for RefinementMenus created by this class. If not specified, a default value of "RefinementMenu" will be used.

Parameters:

refinementMenuType - the RefinementMenu type for this cartridge handler

setContentSource

public void setContentSource(ContentSource pContentSource)

setContentBroker

public void setContentBroker(ContentBroker pContentBroker)

wrapConfig

protected NavigationContainerConfig wrapConfig(ContentItem pContentItem)

Description copied from class: NavigationCartridgeHandler

Wraps the input ContentItem as a typed config object. It is not expected that subclasses will mutate the input ContentItem, beyond passing it into their typed configuration class as a constructor argument.

Specified by:

wrapConfig in class NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Parameters:

pContentItem - the configuration for this cartridge handler. This will either be the fully initialized configuration object, if a ContentItemInitializer has been set, or it will simply be the instance configuration.

Returns:

an instance of ConfigType which wraps the input ContentItem.

See Also:

NavigationCartridgeHandler.initialize(ContentItem), NavigationCartridgeHandler.setContentItemInitializer(ContentItemInitializer)

preprocess

public void preprocess(NavigationContainerConfig pContentItem)
                throws CartridgeHandlerException

If the refinements slot is configured and the first resolved rule has a non empty list of refinements (provided by "navigation" key), then we use this non-empty list. NOTE: We do not support multiple rules. The first matched rule will be considered. If the slot is not configured a mMdexRequest is created to pull all available refinements. If you are overriding this method you MUST set mMdexRequest as it is being used by the process(NavigationContainerConfig) method (unless you are also overriding process(NavigationContainerConfig))

Overrides:

preprocess in class NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Throws:

CartridgeHandlerException

process

public NavigationContainer process(NavigationContainerConfig pContentItem)
                            throws CartridgeHandlerException

If the refinements slot is configured and resolved, use the explicit refinements order to create the output NavigationContainer model. If the refinements slot is not configured or if it is not resolved, we build all the available RefinementMenus to create the output NavigationContainer model. This method makes use of the mMdexRequest variable to make its Mdex Request(s). If you are overriding this method you may assume mMdexRequest is set properly properly.

Overrides:

process in class NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Returns:

NavigationContainer model class containing RefinementMenus.

Throws:

CartridgeHandlerException