com.endeca.infront.cartridge.model
Class GeoFilterBreadcrumb

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

All Implemented Interfaces:

Breadcrumb

public class GeoFilterBreadcrumb
extends Object
implements Breadcrumb

GeoFilterBreadcrumb is the model for a view of a geo range filter a.k.a., a breadcrumb. Use getLatitude(), getLongitude() and getRadiusMiles() or getRadiusKM() to generate a custom label.

Constructor Summary

GeoFilterBreadcrumb()

Method Summary

String	getLabel()
double	getLatitude()
String	getLocation() The cached result of a reverse geocode lookup, for instance '101 Main Street, Cambridge MA'.
double	getLongitude()
String	getName()
String	getPropertyName()
double	getRadiusKM()
double	getRadiusMiles()
NavigationAction	getRemoveAction() Returns a navigation action with the necessary information to remove this breadcrumb.
void	setLabel(String label) Sets the label that describes this breadcrumb.
void	setLatitude(double latitude) Sets the latitude coordinate of this GeoFilterBreadcrumb.
void	setLocation(String location) Sets the result of a reverse geocode lookup.
void	setLongitude(double longitude) Sets the longitude coordinate of this GeoFilterBreadcrumb.
void	setName(String name) Sets the localized string for the property.
void	setPropertyName(String propertyName) Sets the property name for this breadcrumb.
void	setRadiusKM(double radiusKM) Sets the geo filter radius.
void	setRadiusMiles(double radiusMiles) Sets the geo filter radius.
void	setRemoveAction(NavigationAction removeAction) Sets the remove action of this GeoFilterBreadcrumb.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoFilterBreadcrumb

public GeoFilterBreadcrumb()

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 GeoFilterBreadcrumb.

Parameters:

removeAction - the action that will remove this GeoFilterBreadcrumb

getLatitude

public double getLatitude()

Returns:

The latitude coordinate in decimal degree notation.

setLatitude

public void setLatitude(double latitude)

Sets the latitude coordinate of this GeoFilterBreadcrumb.

Parameters:

latitude - the latitude coordinate in decimal degree notation

getLongitude

public double getLongitude()

Returns:

The longitude coordinate in decimal degree notation.

setLongitude

public void setLongitude(double longitude)

Sets the longitude coordinate of this GeoFilterBreadcrumb.

Parameters:

longitude - the longitude coordinate in decimal degree notation

getRadiusMiles

public double getRadiusMiles()

Returns:

The geo filter radius in miles.

setRadiusMiles

public void setRadiusMiles(double radiusMiles)

Sets the geo filter radius.

Parameters:

radiusMiles - sets the geo filter radius in miles

getRadiusKM

public double getRadiusKM()

Returns:

The geo filter radius in kilometers.

setRadiusKM

public void setRadiusKM(double radiusKM)

Sets the geo filter radius.

Parameters:

radiusKM - sets the geo filter radius in kilometers

getLocation

public String getLocation()

The cached result of a reverse geocode lookup, for instance '101 Main Street, Cambridge MA'.
Null if unspecified.

Returns:

The location of the coordinates.

setLocation

public void setLocation(String location)

Sets the result of a reverse geocode lookup.

Parameters:

location - the location of the coordinates

getPropertyName

public String getPropertyName()

Returns:

The property name this breadcrumb describes. For instance 'store.geocode'.

setPropertyName

public void setPropertyName(String propertyName)

Sets the property name for this breadcrumb.

Parameters:

propertyName - the property name

getLabel

public String getLabel()

Returns:

A user friendly label. Ex: "within 50 miles of 42.3620,-71.0817". Null by default.

setLabel

public void setLabel(String label)

Sets the label that describes this breadcrumb.

Parameters:

label - a user friendly label

getName

public String getName()

Returns:

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

setName

public void setName(String name)

Sets the localized string for the property.

Parameters:

name - a localized string