com.endeca.infront.cartridge
Class NavigationContainerHandler

java.lang.Object
  com.endeca.infront.cartridge.NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>
      com.endeca.infront.cartridge.NavigationContainerHandler

All Implemented Interfaces:

CartridgeHandler<NavigationContainerConfig>

public class NavigationContainerHandler
extends NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Class that shows all available navigation refinements.

Constructor Summary

NavigationContainerHandler()

Method Summary

String	getRefinementMenuType() Returns the RefinementMenu type.
void	preprocess(NavigationContainerConfig pContentItem) Initializes the showAll fields and sets mMdexRequest.
NavigationContainer	process(NavigationContainerConfig pContentItem) Builds the RefinementMenus and creates the output NavigationContainer model.
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, getActionPathProvider, getContentItemInitializer, getMdexRequestBroker, getNavigationState, initialize, populateNavigationPathDefaults, setActionPathProvider, setContentItemInitializer, setMdexRequestBroker, setNavigationState

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

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

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

Initializes the showAll fields and sets mMdexRequest. 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))

Specified by:

preprocess in interface CartridgeHandler<NavigationContainerConfig>

Overrides:

preprocess in class NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Parameters:

pContentItem - the cartridge configuration returned by CartridgeHandler.initialize(ContentItem). This cartridge configuration may be modified by this handler. Note that this cartridge configuration is also passed to CartridgeHandler.process(ContentItem).

Throws:

CartridgeHandlerException - if an error occurs that is scoped to an individual cartridge instance. This exception will not halt the entire assembly process, which occurs across multiple cartridges; instead, this exception will be packaged in the overall response model. If an unchecked exception is thrown, then the entire assembly process will be halted.

process

public NavigationContainer process(NavigationContainerConfig pContentItem)
                            throws CartridgeHandlerException

Builds the RefinementMenus and creates 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.

Specified by:

process in interface CartridgeHandler<NavigationContainerConfig>

Overrides:

process in class NavigationCartridgeHandler<NavigationContainerConfig,NavigationContainer>

Parameters:

pContentItem - the cartridge configuration returned by CartridgeHandler.initialize(ContentItem). Note that this instance may have been modified by the CartridgeHandler.preprocess(ContentItem) method.

Returns:

NavigationContainer model class containing RefinementMenus.

Throws:

CartridgeHandlerException - if an error occurs that is scoped to an individual cartridge instance. This exception will not halt the entire assembly process, which occurs across multiple cartridges; instead, this exception will be packaged in the overall response model. If an unchecked exception is thrown, then the entire assembly process will be halted.