Package com.broadleafcommerce.search.api.domain

Class FacetValue

java.lang.Object

com.broadleafcommerce.search.api.domain.FacetValue

All Implemented Interfaces:

Serializable

public class FacetValue
extends Object
implements Serializable

Class representing the actual facet results returned from the search engine.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
FacetValue()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getDisplayOrder()	The display order for this facet value.
String	getMaxValue()	If ranged, the upper bound of values matching this facet value
String	getMinValue()	If ranged, the lower bound of values matching this facet value
int	getQuantity()	The quantity of results matching this facet value
String	getValue()	The value label for this facet value.
int	hashCode()
boolean	isActive()	Whether or not this facet value was active on the search
boolean	isRanged()	Whether or not this value is a range.
void	setActive(boolean active)	Whether or not this facet value was active on the search
void	setDisplayOrder(Integer displayOrder)	The display order for this facet value.
void	setMaxValue(String maxValue)	If ranged, the upper bound of values matching this facet value
void	setMinValue(String minValue)	If ranged, the lower bound of values matching this facet value
void	setQuantity(int quantity)	The quantity of results matching this facet value
void	setRanged(boolean ranged)	Whether or not this value is a range.
void	setValue(String value)	The value label for this facet value.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

FacetValue

public FacetValue()

Method Detail

getValue

public String getValue()

The value label for this facet value.

Returns:

value label for this facet value

isRanged

public boolean isRanged()

Whether or not this value is a range.

Returns:

whether or not this value is a range

getMinValue

public String getMinValue()

If ranged, the lower bound of values matching this facet value

Returns:

lower bound of values matching this facet value

getMaxValue

public String getMaxValue()

If ranged, the upper bound of values matching this facet value

Returns:

upper bound of values matching this facet value

getQuantity

public int getQuantity()

The quantity of results matching this facet value

Returns:

quantity of results matching this facet value

isActive

public boolean isActive()

Whether or not this facet value was active on the search

Returns:

whether or not this facet value was active on the search

getDisplayOrder

public Integer getDisplayOrder()

The display order for this facet value. Used only for sorting, not returned in JSON object.

Returns:

order in which to display this value

setValue

public void setValue(String value)

The value label for this facet value.

Parameters:

value - value label for this facet value

setRanged

public void setRanged(boolean ranged)

Whether or not this value is a range.

Parameters:

ranged - whether or not this value is a range

setMinValue

public void setMinValue(String minValue)

If ranged, the lower bound of values matching this facet value

Parameters:

minValue - lower bound of values matching this facet value

setMaxValue

public void setMaxValue(String maxValue)

If ranged, the upper bound of values matching this facet value

Parameters:

maxValue - upper bound of values matching this facet value

setQuantity

public void setQuantity(int quantity)

The quantity of results matching this facet value

Parameters:

quantity - quantity of results matching this facet value

setActive

public void setActive(boolean active)

Whether or not this facet value was active on the search

Parameters:

active - whether or not this facet value was active on the search

setDisplayOrder

public void setDisplayOrder(Integer displayOrder)

The display order for this facet value. Used only for sorting, not returned in JSON object.

Parameters:

quantity - order in which to display this value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object