Class Filter
- java.lang.Object
-
- com.broadleafcommerce.search.api.domain.Filter
-
public class Filter extends Object
-
-
Constructor Summary
Constructors Constructor Description Filter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
String
getName()
The name of the property to filter on, e.g.List<FilterRangeValue>
getRanges()
The ranged values of this filter.List<String>
getValues()
The values of the filter.int
hashCode()
boolean
isRangedFilter()
Determines whether or not this is a ranged query.void
setName(String name)
The name of the property to filter on, e.g.void
setRanges(List<FilterRangeValue> ranges)
The ranged values of this filter.void
setValues(List<String> values)
The values of the filter.String
toString()
-
-
-
Method Detail
-
isRangedFilter
public boolean isRangedFilter()
Determines whether or not this is a ranged query.- Returns:
- true if a ranged filter, else false.
-
getName
public String getName()
The name of the property to filter on, e.g. "color","price", etc.- Returns:
- name of the property to filter on
-
getValues
public List<String> getValues()
The values of the filter. For example, if name is "color", this could be "red","black","blue"- Returns:
- values of the filter
-
getRanges
public List<FilterRangeValue> getRanges()
The ranged values of this filter. This will contain pairs of minimum and maximum values to create ranges to filter on. Cannot be used in combination with filter values.- Returns:
- ranges of the filter
-
setName
public void setName(String name)
The name of the property to filter on, e.g. "color","price", etc.- Parameters:
name
- name of the property to filter on
-
setValues
public void setValues(List<String> values)
The values of the filter. For example, if name is "color", this could be "red","black","blue"- Parameters:
values
- values of the filter
-
setRanges
public void setRanges(List<FilterRangeValue> ranges)
The ranged values of this filter. This will contain pairs of minimum and maximum values to create ranges to filter on. Cannot be used in combination with filter values.- Parameters:
ranges
- ranges of the filter
-
canEqual
protected boolean canEqual(Object other)
-
-