com.endeca.infront.cartridge

Class SearchAdjustmentsHandler

java.lang.Object

com.endeca.infront.cartridge.NavigationCartridgeHandler<SearchAdjustmentsConfig,SearchAdjustments>

com.endeca.infront.cartridge.SearchAdjustmentsHandler

public class SearchAdjustmentsHandler
extends NavigationCartridgeHandler<SearchAdjustmentsConfig,SearchAdjustments>

Cartridge handler that creates SearchAdjustments model objects.

Constructor Summary

Constructors

Constructor and Description
SearchAdjustmentsHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	preprocess(SearchAdjustmentsConfig cartridgeConfig) Creates an MDEX query with spell and phrase Did You Mean enabled.
SearchAdjustments	process(SearchAdjustmentsConfig cartridgeConfig) Always returns a SearchAdjustments object, even if no search adjustments have been suggested.
protected SearchAdjustmentsConfig	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

SearchAdjustmentsHandler

public SearchAdjustmentsHandler()

Method Detail

wrapConfig

protected SearchAdjustmentsConfig 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<SearchAdjustmentsConfig,SearchAdjustments>

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

Creates an MDEX query with spell and phrase Did You Mean enabled. If the autophrase URL parameter exists, (e.g. autophrase=0), a "1" value will turn on autophrasing, and any other value will turn it off.

Overrides:

preprocess in class NavigationCartridgeHandler<SearchAdjustmentsConfig,SearchAdjustments>

Throws:

CartridgeHandlerException

process

public SearchAdjustments process(SearchAdjustmentsConfig cartridgeConfig)
                          throws CartridgeHandlerException

Always returns a SearchAdjustments object, even if no search adjustments have been suggested.

Overrides:

process in class NavigationCartridgeHandler<SearchAdjustmentsConfig,SearchAdjustments>

Throws:

CartridgeHandlerException