com.endeca.infront.cartridge
Class NavigationContainer

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          com.endeca.infront.assembler.BasicContentItem
              com.endeca.infront.cartridge.NavigationContainer

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class NavigationContainer
extends BasicContentItem

NavigationContainerHandler output model.

A NavigationContainer contains a list of RefinementMenu objects that can be used to make queries to further refine search or navigation results.

Depending on URL parameter and Experience Manager configuration, the list of Refinements contained in a RefinementMenu may be incomplete because each menu may contain too many refinements to be returned in an initial request. The NavigationContainerHandler generates a "showMoreLink" Action that can be used to retrieve the complete list of available Refinements unless:

• The refinement menu is already expanded
• The number of of available refinements is less than the Experience Manager configured limit
• A "Show More Link" label is not configured in Experience Manager

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

NavigationContainer(NavigationContainerConfig pConfig)
Creates the NavigationContainer output model, using the type and data present in the input NavigationContainerConfig.

Method Summary

List<RefinementMenu>	getNavigation() Returns a list of RefinementMenu items in this NavigationContainer.
void	setNavigation(List<RefinementMenu> navigation) Replaces the list of RefinementMenu items in this NavigationContainer with the specified list.

Methods inherited from class com.endeca.infront.assembler.BasicContentItem

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

NavigationContainer

public NavigationContainer(NavigationContainerConfig pConfig)

Creates the NavigationContainer output model, using the type and data present in the input NavigationContainerConfig.

Method Detail

getNavigation

public List<RefinementMenu> getNavigation()

Returns a list of RefinementMenu items in this NavigationContainer.

setNavigation

public void setNavigation(List<RefinementMenu> navigation)

Replaces the list of RefinementMenu items in this NavigationContainer with the specified list.