com.endeca.infront.cartridge

Class RefinementMenuHandler

java.lang.Object

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

com.endeca.infront.cartridge.RefinementMenuHandler

public class RefinementMenuHandler
extends NavigationCartridgeHandler<RefinementMenuConfig,RefinementMenu>

Cartridge handler that creates RefinementMenu model objects.

Constructor Summary

Constructors

Constructor and Description
RefinementMenuHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	preprocess(RefinementMenuConfig cartridgeConfig) Creates a query to the MDEX for the refinements of the Dimension specified by RefinementMenuConfig.getDimensionId().
RefinementMenu	process(RefinementMenuConfig cartridgeConfig) Returns null if no dimension id is specified in the config, or if the MDEX doesn't return any refinements.
protected RefinementMenuConfig	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, getContentItemInitializer, getMdexRequestBroker, getNavigationState, getSiteState, initialize, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState, setSiteState

Methods inherited from class java.lang.Object

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

Constructor Detail

RefinementMenuHandler

public RefinementMenuHandler()

Method Detail

wrapConfig

protected RefinementMenuConfig 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<RefinementMenuConfig,RefinementMenu>

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(RefinementMenuConfig cartridgeConfig)
                throws CartridgeHandlerException

Creates a query to the MDEX for the refinements of the Dimension specified by RefinementMenuConfig.getDimensionId(). If the dimension id is not specified, this CartridgeHandler will return null for its ContentItem.

Overrides:

preprocess in class NavigationCartridgeHandler<RefinementMenuConfig,RefinementMenu>

Throws:

CartridgeHandlerException

process

public RefinementMenu process(RefinementMenuConfig cartridgeConfig)
                       throws CartridgeHandlerException

Returns null if no dimension id is specified in the config, or if the MDEX doesn't return any refinements.

Overrides:

process in class NavigationCartridgeHandler<RefinementMenuConfig,RefinementMenu>

Throws:

CartridgeHandlerException