org.broadleafcommerce.openadmin.dto

Class FilterAndSortCriteria

java.lang.Object

org.broadleafcommerce.openadmin.dto.FilterAndSortCriteria

public class FilterAndSortCriteria
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	filterValues
static String	IS_NOT_NULL_FILTER_VALUE
static String	IS_NULL_FILTER_VALUE
static String	MAX_INDEX_PARAMETER
protected boolean	nullsLast
protected Integer	order for "order", a null value is relevant, meaning that this field moves to the end of any sort order consideration (this is the opposite of what we would achieve, by having an uninitialized int variable set to 0)
protected String	propertyId
protected RestrictionType	restrictionType
static String	SORT_DIRECTION_PARAMETER
static String	SORT_PROPERTY_PARAMETER
protected SortDirection	sortDirection
static String	START_INDEX_PARAMETER

Constructor Summary

Constructors

Constructor and Description
FilterAndSortCriteria(String propertyId)
FilterAndSortCriteria(String propertyId, int order)
FilterAndSortCriteria(String propertyId, List<String> filterValues)
FilterAndSortCriteria(String propertyId, List<String> filterValues, int order)
FilterAndSortCriteria(String propertyId, List<String> filterValues, SortDirection sortDirection)
FilterAndSortCriteria(String propertyId, List<String> filterValues, SortDirection sortDirection, int order)
FilterAndSortCriteria(String propertyId, String filterValue)
FilterAndSortCriteria(String propertyId, String[] filterValues)
FilterAndSortCriteria(String propertyId, String[] filterValues, int order)
FilterAndSortCriteria(String propertyId, String filterValue, int order)

Method Summary

Modifier and Type	Method and Description
void	addFilterValue(String value)
void	clearFilterValues()
List<String>	getFilterValues()
Integer	getOrder()
protected TypedPredicate<String>	getPredicateForSpecialValues(boolean inclusive)
String	getPropertyId()
RestrictionType	getRestrictionType()
Boolean	getSortAscending()
SortDirection	getSortDirection()
List<String>	getSpecialFilterValues()
boolean	hasSpecialFilterValue()
boolean	isNullsLast()
void	setFilterValue(String value)
void	setFilterValues(List<String> filterValues)
void	setNullsLast(boolean nullsLast)
void	setOrder(Integer order)
void	setPropertyId(String propertyId)
void	setRestrictionType(RestrictionType restrictionType) Useful when you want to explicitly define the type of pre-built Restriction instance to be used.
void	setSortAscending(Boolean sortAscending)
void	setSortDirection(SortDirection sortDirection)

Methods inherited from class java.lang.Object

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

Field Detail

SORT_PROPERTY_PARAMETER

public static final String SORT_PROPERTY_PARAMETER

See Also:

Constant Field Values

SORT_DIRECTION_PARAMETER

public static final String SORT_DIRECTION_PARAMETER

See Also:

Constant Field Values

START_INDEX_PARAMETER

public static final String START_INDEX_PARAMETER

See Also:

Constant Field Values

MAX_INDEX_PARAMETER

public static final String MAX_INDEX_PARAMETER

See Also:

Constant Field Values

IS_NULL_FILTER_VALUE

public static final String IS_NULL_FILTER_VALUE

IS_NOT_NULL_FILTER_VALUE

public static final String IS_NOT_NULL_FILTER_VALUE

propertyId

protected String propertyId

filterValues

protected List<String> filterValues

restrictionType

protected RestrictionType restrictionType

order

protected Integer order

for "order", a null value is relevant, meaning that this field moves to the end of any sort order consideration (this is the opposite of what we would achieve, by having an uninitialized int variable set to 0)

sortDirection

protected SortDirection sortDirection

nullsLast

protected boolean nullsLast

Constructor Detail

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             int order)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             String filterValue)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             String filterValue,
                             int order)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             List<String> filterValues,
                             int order)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             List<String> filterValues)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             List<String> filterValues,
                             SortDirection sortDirection,
                             int order)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             List<String> filterValues,
                             SortDirection sortDirection)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             String[] filterValues,
                             int order)

FilterAndSortCriteria

public FilterAndSortCriteria(String propertyId,
                             String[] filterValues)

Method Detail

getPropertyId

public String getPropertyId()

setPropertyId

public void setPropertyId(String propertyId)

clearFilterValues

public void clearFilterValues()

setFilterValue

public void setFilterValue(String value)

addFilterValue

public void addFilterValue(String value)

getFilterValues

public List<String> getFilterValues()

getSpecialFilterValues

public List<String> getSpecialFilterValues()

setFilterValues

public void setFilterValues(List<String> filterValues)

getSortAscending

public Boolean getSortAscending()

setSortAscending

public void setSortAscending(Boolean sortAscending)

getSortDirection

public SortDirection getSortDirection()

setSortDirection

public void setSortDirection(SortDirection sortDirection)

hasSpecialFilterValue

public boolean hasSpecialFilterValue()

getRestrictionType

public RestrictionType getRestrictionType()

setRestrictionType

public void setRestrictionType(RestrictionType restrictionType)

Useful when you want to explicitly define the type of pre-built Restriction instance to be used. The available, pre-built restrictions are defined in the Spring configured map "blRestrictionFactoryMap".

Parameters:

restrictionType -

getPredicateForSpecialValues

protected TypedPredicate<String> getPredicateForSpecialValues(boolean inclusive)

getOrder

public Integer getOrder()

setOrder

public void setOrder(Integer order)

isNullsLast

public boolean isNullsLast()

setNullsLast

public void setNullsLast(boolean nullsLast)