com.endeca.infront.cartridge
Class Breadcrumbs

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

All Implemented Interfaces:

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

public class Breadcrumbs
extends BasicContentItem

BreadcrumbsHandler output model. Breadcrumbs model represents the active navigation state which could include

• A list of SearchBreadcrumb
• A list of RefinementBreadcrumb
• A list of RangeFilterBreadcrumb
• A single GeoFilterBreadcrumb

Breadcrumbs also provides an action to clear the active navigation state.

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

Breadcrumbs(BreadcrumbsConfig pConfig)
Creates the BreadcrumbsHandler output model, using the type and data present in the input BreadcrumbsConfig.

Method Summary

GeoFilterBreadcrumb	getGeoFilterCrumb() The active geo filter.
List<RangeFilterBreadcrumb>	getRangeFilterCrumbs() The list of active range filters.
List<RefinementBreadcrumb>	getRefinementCrumbs() The list of active dimensional refinements.
NavigationAction	getRemoveAllAction() Gets the action that will clear/remove all breadcrumbs.
List<SearchBreadcrumb>	getSearchCrumbs() The list of active search terms.
void	setGeoFilterCrumb(GeoFilterBreadcrumb geoFilterCrumb) Sets the active geo filter.
void	setRangeFilterCrumbs(List<RangeFilterBreadcrumb> rangeFilterCrumbs) Sets the list of active range filters.
void	setRefinementCrumbs(List<RefinementBreadcrumb> refinementCrumbs) Sets the list of active dimensional refinements.
void	setRemoveAllAction(NavigationAction removeAllAction) Sets the action that will clear/remove all breadcrumbs.
void	setSearchCrumbs(List<SearchBreadcrumb> searchCrumbs) Sets the list of active search terms.

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

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType

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

Breadcrumbs

public Breadcrumbs(BreadcrumbsConfig pConfig)

Creates the BreadcrumbsHandler output model, using the type and data present in the input BreadcrumbsConfig.

Method Detail

getRemoveAllAction

public NavigationAction getRemoveAllAction()

Gets the action that will clear/remove all breadcrumbs.

getRefinementCrumbs

public List<RefinementBreadcrumb> getRefinementCrumbs()

The list of active dimensional refinements.

getSearchCrumbs

public List<SearchBreadcrumb> getSearchCrumbs()

The list of active search terms.

getRangeFilterCrumbs

public List<RangeFilterBreadcrumb> getRangeFilterCrumbs()

The list of active range filters.

getGeoFilterCrumb

public GeoFilterBreadcrumb getGeoFilterCrumb()

The active geo filter.

setRemoveAllAction

public void setRemoveAllAction(NavigationAction removeAllAction)

Sets the action that will clear/remove all breadcrumbs.

setSearchCrumbs

public void setSearchCrumbs(List<SearchBreadcrumb> searchCrumbs)

Sets the list of active search terms.

setRefinementCrumbs

public void setRefinementCrumbs(List<RefinementBreadcrumb> refinementCrumbs)

Sets the list of active dimensional refinements.

setRangeFilterCrumbs

public void setRangeFilterCrumbs(List<RangeFilterBreadcrumb> rangeFilterCrumbs)

Sets the list of active range filters.

setGeoFilterCrumb

public void setGeoFilterCrumb(GeoFilterBreadcrumb geoFilterCrumb)

Sets the active geo filter.