com.endeca.infront.cartridge
Class SearchAdjustmentsRequestParamMarshaller

java.lang.Object
  com.endeca.infront.cartridge.RequestParamMarshaller
      com.endeca.infront.cartridge.SearchAdjustmentsRequestParamMarshaller

public class SearchAdjustmentsRequestParamMarshaller
extends RequestParamMarshaller

Creates SearchSuggestionsHandler configuration from the parameters present in a request URL. The following mapping is used:

• DYM_ENABLED_PARAMETER ("Nty") -> SearchAdjustmentsConfig.setSpellSuggestionEnabled(boolean)
• DYM_ENABLED_PARAMETER ("Nty") -> SearchAdjustmentsConfig.setPhraseSuggestionEnabled(boolean)

The anticipated most common use case is to turn both phrase and spell suggestion on and off at the same time, so this class uses a single URL parameter to control both.

Field Summary

static String

DYM_ENABLED_PARAMETER Name of request parameter, "Nty", that enables/disables search suggestions.

Fields inherited from class com.endeca.infront.cartridge.RequestParamMarshaller

mRequest, mRequestMap

Constructor Summary

SearchAdjustmentsRequestParamMarshaller()
Creates the marshaller for reading request parameters related to SearchAdjustmentsConfig.

Method Summary

ContentItem

marshall() Creates a new ContentItem and populates it with information from the HttpServletRequest.

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

convertToBoolean, convertToInt, convertToList, convertToLong, override, setHttpServletRequest, setRequestMap

Methods inherited from class java.lang.Object

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

Field Detail

DYM_ENABLED_PARAMETER

public static final String DYM_ENABLED_PARAMETER

Name of request parameter, "Nty", that enables/disables search suggestions. Set to 1 to turn it on, set to 0 to turn it off.

See Also:

SearchAdjustmentsConfig.setSpellSuggestionEnabled(boolean), SearchAdjustmentsConfig.setPhraseSuggestionEnabled(boolean), Constant Field Values

Constructor Detail

SearchAdjustmentsRequestParamMarshaller

public SearchAdjustmentsRequestParamMarshaller()

Creates the marshaller for reading request parameters related to SearchAdjustmentsConfig.

Method Detail

marshall

public ContentItem marshall()

Description copied from class: RequestParamMarshaller

Creates a new ContentItem and populates it with information from the HttpServletRequest. More specifically, this method iterates through the keys in the request map; for each key (URL parameter), if a corresponding value exists in the HttpServletRequest, then this method stores the value in the new ContentItem using the ContentItem key obtained from the request map.

Overrides:

marshall in class RequestParamMarshaller