com.endeca.infront.cartridge.model
Class RangeFilterBreadcrumb

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

All Implemented Interfaces:

Breadcrumb

public class RangeFilterBreadcrumb
extends Object
implements Breadcrumb

RangeFilterBreadcrumb is the model for a view of a selected range filter a.k.a., a breadcrumb. Use getUpperBound(), getLowerBound() and getOperation() to generate a custom label.

Constructor Summary

RangeFilterBreadcrumb()

Method Summary

String	getLabel()
String	getLowerBound()
String	getName()
String	getOperation()
String	getPropertyName()
NavigationAction	getRemoveAction() Returns a navigation action with the necessary information to remove this breadcrumb.
String	getUpperBound()
void	setLabel(String label) Sets the user friendly label.
void	setLowerBound(String lowerBound) Sets the operations lower bound.
void	setName(String name) The localized string for the property.
void	setOperation(String operation) Sets the operation to be used to create the range filter.
void	setPropertyName(String propertyName) Sets the property name for this RangeFilterBreadcrumb.
void	setRemoveAction(NavigationAction removeAction) Sets the NavigationAction to remove this RangeFilterBreadcrumb.
void	setUpperBound(String upperBound) Sets the upper bound.

Methods inherited from class java.lang.Object

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

Constructor Detail

RangeFilterBreadcrumb

public RangeFilterBreadcrumb()

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 NavigationAction to remove this RangeFilterBreadcrumb.

Parameters:

removeAction - the action to remove this RangeFilterBreadcrumb

getOperation

public String getOperation()

Returns:

One of the String values in RangeFilter.Operation

setOperation

public void setOperation(String operation)

Sets the operation to be used to create the range filter. The operations are defined in RangeFilter.Operation and can be less than, greater than, less or equal to, greater or equal to and between.

Parameters:

operation - the operation of this range filter

See Also:

RangeFilter.Operation

getUpperBound

public String getUpperBound()

Returns:

The upper bound of this RangeFilterBreadcrumb.

setUpperBound

public void setUpperBound(String upperBound)

Sets the upper bound.

Parameters:

upperBound - the upper bound

See Also:

setOperation(String)

getLowerBound

public String getLowerBound()

Returns:

The lower bound of this RangeFilterBreadcrumb.

setLowerBound

public void setLowerBound(String lowerBound)

Sets the operations lower bound.

Parameters:

lowerBound - the lower bound

See Also:

setOperation(String)

getName

public String getName()

Returns:

The localized string for the property if any, null otherwise.

setName

public void setName(String name)

The localized string for the property.

Parameters:

name - the localized name

getPropertyName

public String getPropertyName()

Returns:

The property name this RangeFilterBreadcrumb describes.

setPropertyName

public void setPropertyName(String propertyName)

Sets the property name for this RangeFilterBreadcrumb.

Parameters:

propertyName - the name for the property

getLabel

public String getLabel()

Returns:

A user friendly label. Ex: "Price less than 50", "Price between 50 and 100", "within 50 miles".

setLabel

public void setLabel(String label)

Sets the user friendly label.

Parameters:

label - a user friendly label