com.endeca.infront.cartridge.model
Class RefinementBreadcrumb

java.lang.Object
  com.endeca.infront.cartridge.model.RefinementBreadcrumb

All Implemented Interfaces:

Breadcrumb

public class RefinementBreadcrumb
extends Object
implements Breadcrumb

RefinementBreadcrumb is the model for a view of a selected refinement.

Constructor Summary

RefinementBreadcrumb()

Method Summary

List<Ancestor>	getAncestors()
Integer	getCount()
String	getDimensionName()
String	getDisplayName()
String	getLabel()
Map<String,String>	getProperties()
NavigationAction	getRemoveAction() Returns a navigation action with the necessary information to remove this breadcrumb.
boolean	isMultiSelect()
void	setAncestors(List<Ancestor> ancestors) Sets the ancestors for this refinement, if any.
void	setCount(Integer count) Sets the number of records that will be returned if this refinement is applied.
void	setDimensionName(String dimensionName) Sets the dimension name for this refinement bread crumb.
void	setDisplayName(String displayName) Sets the display name for this refinement bread crumb.
void	setLabel(String label) Sets the user friendly text of this refinement.
void	setMultiSelect(boolean multiSelect) Sets the multi select flag.
void	setProperties(Map<String,String> properties) Sets the properties of this refinement.
void	setRemoveAction(NavigationAction removeAction) Sets the remove action of this RefinementBreadcrumb.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefinementBreadcrumb

public RefinementBreadcrumb()

Method Detail

getRemoveAction

public NavigationAction getRemoveAction()

Returns a navigation action with the necessary information to remove this breadcrumb.

Specified by:

getRemoveAction in interface Breadcrumb

Returns:

A NavigationAction that will remove this Breadcrumb.

setRemoveAction

public void setRemoveAction(NavigationAction removeAction)

Sets the remove action of this RefinementBreadcrumb.

Parameters:

removeAction - the action that will remove this RefinementBreadcrumb

getDimensionName

public String getDimensionName()

Returns:

The dimension name for this refinement bread crumb.

setDimensionName

public void setDimensionName(String dimensionName)

Sets the dimension name for this refinement bread crumb.

Parameters:

dimensionName - the dimension name of this breadcrumb

getDisplayName

public String getDisplayName()

Returns:

The display name for this refinement bread crumb.

setDisplayName

public void setDisplayName(String displayName)

Sets the display name for this refinement bread crumb.

Parameters:

displayName - the display name of this breadcrumb

getAncestors

public List<Ancestor> getAncestors()

Returns:

The ancestors of this dimension search.

setAncestors

public void setAncestors(List<Ancestor> ancestors)

Sets the ancestors for this refinement, if any.

Parameters:

ancestors - a list containing the ancestors of this refinement

getProperties

public Map<String,String> getProperties()

Returns:

The additional information about this refinement a.k.a., dimension filter.

setProperties

public void setProperties(Map<String,String> properties)

Sets the properties of this refinement.

Parameters:

properties - a map containing properties for this refinement

isMultiSelect

public boolean isMultiSelect()

Returns:

True if this refinement is multi selectable.

setMultiSelect

public void setMultiSelect(boolean multiSelect)

Sets the multi select flag.

Parameters:

multiSelect - true if this refinement is multi selectable

getLabel

public String getLabel()

Returns:

The label of this RefinementBreadcrumb

setLabel

public void setLabel(String label)

Sets the user friendly text of this refinement.

Parameters:

label - the label

getCount

public Integer getCount()

Returns:

The number of results that will be returned if the refinement is applied.

setCount

public void setCount(Integer count)

Sets the number of records that will be returned if this refinement is applied.

Parameters:

count - the refinement count